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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.101     rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.104     rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106     rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       118: <dd><dl>
1.103     wiz       119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.122   ! reed      120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !           121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       122: </dl></dd>
1.103     wiz       123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.75      rillig    133: <dd><dl>
1.106     rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    148: <dd><dl>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    151: </dl></dd>
1.106     rillig    152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    154: </dl></dd>
                    155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    156: <dd><dl>
1.122   ! reed      157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
        !           158: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    159: </dl></dd>
                    160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    161: <dd><dl>
                    162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.122   ! reed      169: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig    170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.122   ! reed      171: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
        !           172: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
        !           173: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
1.106     rillig    174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.122   ! reed      177: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106     rillig    178: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.122   ! reed      179: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    180: </dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    183: <dd><dl>
1.106     rillig    184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    185: <dd><dl>
1.106     rillig    186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    187: <dd><dl>
1.106     rillig    188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil      190: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    191: </dl></dd>
1.106     rillig    192: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    193: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    194: </dl></dd>
                    195: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    196: <dd><dl>
1.122   ! reed      197: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
        !           198: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig    199: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    200: <dd><dl>
                    201: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    205: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    206: </dl></dd>
                    207: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    208: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    209: <dd><dl>
                    210: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    212: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    213: </dl></dd>
1.122   ! reed      214: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
        !           215: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    216: </dl></dd>
1.122   ! reed      217: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    218: <dd><dl>
                    219: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.122   ! reed      220: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    221: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    222: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    223: <dd><dl>
                    224: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    226: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    227: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    228: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    229: </dl></dd>
                    230: </dl></dd>
                    231: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    232: <dd><dl>
                    233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.122   ! reed      234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
        !           235: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig    236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.122   ! reed      238: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig    239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    241: </dl></dd>
                    242: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    243: <dd><dl>
                    244: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.122   ! reed      245: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    246: <dd><dl>
                    247: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.122   ! reed      248: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    249: </dl></dd>
1.122   ! reed      250: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    251: <dd><dl>
1.122   ! reed      252: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig    253: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    254: </dl></dd>
                    255: </dl></dd>
                    256: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    257: <dd><dl>
                    258: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    259: <dd><dl>
                    260: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    261: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    262: </dl></dd>
                    263: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    264: <dd><dl>
1.122   ! reed      265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig    266: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    267: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    268: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    269: </dl></dd>
                    270: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    271: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    272: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    273: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    274: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    275: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    276: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    277: </dl></dd>
                    278: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.122   ! reed      281: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig    282: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    283: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    284: </dl></dd>
                    285: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    286: <dd><dl>
                    287: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.122   ! reed      291: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    292: <dd><dl>
                    293: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    294: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    295: </dl></dd>
1.122   ! reed      296: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
        !           297: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
        !           298: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
        !           299: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
        !           300: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
        !           301: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
        !           302: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
        !           303: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
        !           304: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
        !           305: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig    306: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    312: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    313: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    314: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    315: </dl></dd>
                    316: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    317: <dd><dl>
                    318: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    319: <dd><dl>
                    320: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.122   ! reed      321: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig    322: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    323: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    324: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    325: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    326: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    327: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    328: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    329: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    330: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    331: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    332: </dl></dd>
1.122   ! reed      333: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    334: <dd><dl>
                    335: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    336: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    337: </dl></dd>
1.122   ! reed      338: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    341: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    342: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    343: </dl></dd>
                    344: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    345: <dd><dl>
                    346: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    347: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    348: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                    349: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    350: </dl></dd>
1.122   ! reed      351: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig    352: <dd><dl>
                    353: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    354: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.122   ! reed      355: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
1.106     rillig    356: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    357: </dl></dd>
1.122   ! reed      358: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig    359: <dd><dl>
                    360: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    361: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    362: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    364: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    365: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    366: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    367: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    368: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    369: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    370: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    371: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    372: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    373: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    374: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    375: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    376: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    377: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       378:     emulation</a></span></dt>
1.106     rillig    379: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    380: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    381: </dl></dd>
1.106     rillig    382: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    383: </dl></dd>
1.106     rillig    384: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    385: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    386: <dd><dl>
1.106     rillig    387: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    388: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    389: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    391: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122   ! reed      392: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
        !           393: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    394: </dl></dd>
                    395: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    396: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    397: <dd><dl>
                    398: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    399: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    400: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    401: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      402: </dl></dd>
1.75      rillig    403: </dl></dd>
                    404: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    405: <dd><dl>
1.106     rillig    406: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    407: <dd><dl>
1.106     rillig    408: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    410: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    411: <dd><dl>
1.106     rillig    412: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    413: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    414: </dl></dd>
1.106     rillig    415: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    416: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    417: <dd><dl>
1.106     rillig    418: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    419: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    420: </dl></dd>
1.106     rillig    421: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    422: <dd><dl>
1.122   ! reed      423: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
        !           424: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    425: </dl></dd>
                    426: </dl></dd>
1.106     rillig    427: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    428: <dd><dl>
1.106     rillig    429: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    430: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    431: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    432: <dd><dl>
1.106     rillig    433: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    434: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    435: </dl></dd>
                    436: </dl></dd>
1.106     rillig    437: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    438: <dd><dl>
1.106     rillig    439: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    440: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    441: </dl></dd>
                    442: </dl></dd>
                    443: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    444: <dd><dl>
                    445: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    448: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    449: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.122   ! reed      450: <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.75      rillig    451: </dl></dd>
                    452: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    453: </dl></dd>
                    454: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    455: <dd><dl>
                    456: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    457: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    458: </dl></dd>
1.76      rillig    459: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    460: <dd><dl>
1.122   ! reed      461: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
        !           462: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
        !           463: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
        !           464: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
        !           465: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
        !           466: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
        !           467: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
        !           468: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    469: source packages</a></span></dt>
                    470: </dl></dd>
1.75      rillig    471: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    472: <dd><dl>
1.79      rillig    473: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    474: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    475: </dl></dd>
                    476: </dl>
                    477: </div>
1.82      rillig    478: <div class="list-of-tables">
                    479: <p><b>List of Tables</b></p>
                    480: <dl>
                    481: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    482: </dt>
1.106     rillig    483: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      484: </dt>
1.106     rillig    485: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      486: </dt>
1.82      rillig    487: </dl>
                    488: </div>
1.75      rillig    489: <div class="chapter" lang="en">
                    490: <div class="titlepage"><div><div><h2 class="title">
                    491: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    492: <div class="toc">
                    493: <p><b>Table of Contents</b></p>
                    494: <dl>
                    495: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    496: <dd><dl>
                    497: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    498: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    499: </dl></dd>
1.75      rillig    500: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    501: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       502: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    503: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    504: </dl>
                    505: </div>
                    506: <div class="sect1" lang="en">
                    507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    508: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    509: <p>There is a lot of software freely available for Unix-based
                    510: systems, which is usually available in form of the source code. Before
                    511: such software can be used, it needs to be configured to the local
                    512: system, compiled and installed, and this is exactly what The NetBSD
                    513: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    514: to handle binary packages, so that not every user has to build the
                    515: packages for himself, which is a time-costly task.</p>
1.75      rillig    516: <p>pkgsrc currently contains several thousand packages,
                    517:       including:</p>
                    518: <div class="itemizedlist"><ul type="disc">
1.91      rillig    519: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75      rillig    520:          web server</p></li>
1.91      rillig    521: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    522:          web browser</p></li>
1.91      rillig    523: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    524:          Desktop Environment</p></li>
1.91      rillig    525: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75      rillig    526:          Desktop Environment</p></li>
                    527: </ul></div>
                    528: <p>...just to name a few.</p>
                    529: <p>pkgsrc has built-in support for handling varying dependencies,
                    530:       such as pthreads and X11, and extended features such as IPv6 support on
                    531:       a range of platforms.</p>
1.82      rillig    532: <div class="sect2" lang="en">
                    533: <div class="titlepage"><div><div><h3 class="title">
                    534: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    535: <p>
                    536: pkgsrc provides the following key features:
                    537: </p>
                    538: <div class="itemizedlist"><ul type="disc">
                    539: <li><p>Easy building of software from source as well as the creation
                    540:   and installation of binary packages. The source and latest
                    541:   patches are retrieved from a master or mirror download site, checksum
                    542:   verified, then built on your system. Support for binary-only
                    543:   distributions is available for both native platforms and NetBSD
                    544:   emulated platforms.</p></li>
                    545: <li><p>All packages are installed in a consistent directory tree,
                    546:   including binaries, libraries, man pages and other
                    547:   documentation.</p></li>
                    548: <li><p>Package dependencies, including when performing package updates,
                    549:   are handled automatically. The configuration files of various
                    550:   packages are handled automatically during updates, so local changes
                    551:   are preserved.</p></li>
                    552: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    553:   consists of highly portable code. This allows the greatest speed of
                    554:   development when porting to new a platform. This portability also
                    555:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    556:   platforms</em></span>.</p></li>
                    557: <li><p>The installation prefix, acceptable software licenses,
                    558:   international encryption requirements and build-time options for a
                    559:   large number of packages are all set in a simple, central
                    560:   configuration file.</p></li>
                    561: <li><p>The entire source (not including the distribution files) is
                    562:   freely available under a BSD license, so you may extend and adapt
                    563:   pkgsrc to your needs. Support for local packages and patches is
                    564:   available right out of the box, so you can configure it specifically
                    565:   for your environment.</p></li>
                    566: </ul></div>
1.91      rillig    567: <p>The following principles are basic to pkgsrc:</p>
                    568: <div class="itemizedlist"><ul type="disc">
                    569: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.114     jmcneill  570: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    571: them and to complain about them rather than to just install the package
                    572: and hope that it works. There are numerous checks in pkgsrc that try to
                    573: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
                    574: of shell scripts), and post-installation checks (installed files,
                    575: references to shared libraries, script interpreters).</p></li>
                    576: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.114     jmcneill  577: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    578: pkgsrc has been ported to many operating systems. Care is taken that
                    579: packages behave the same on all platforms.</p></li>
                    580: </ul></div>
1.82      rillig    581: </div>
                    582: <div class="sect2" lang="en">
                    583: <div class="titlepage"><div><div><h3 class="title">
                    584: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    585: <p>pkgsrc consists of both a source distribution and a binary
                    586: distribution for these operating systems. After retrieving the required
                    587: source or binaries, you can be up and running with pkgsrc in just
                    588: minutes!</p>
1.75      rillig    589: <p>pkgsrc was derived from FreeBSD's ports system, and
                    590:       initially developed for NetBSD only. Since then, pkgsrc has
                    591:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    592: <div class="table">
                    593: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    594: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    595: <colgroup>
                    596: <col>
                    597: <col>
                    598: </colgroup>
                    599: <thead><tr>
                    600: <th>Platform</th>
                    601: <th>Date Support Added</th>
                    602: </tr></thead>
                    603: <tbody>
                    604: <tr>
1.110     hubertf   605: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    606: <td align="center">Aug 1997</td>
                    607: </tr>
                    608: <tr>
1.110     hubertf   609: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    610: <td align="center">Mar 1999</td>
                    611: </tr>
                    612: <tr>
1.110     hubertf   613: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    614: <td align="center">Jun 1999</td>
                    615: </tr>
                    616: <tr>
                    617: <td>
1.110     hubertf   618:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    619:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    620:         </td>
                    621: <td align="center">Oct 2001</td>
                    622: </tr>
                    623: <tr>
1.110     hubertf   624: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    625: <td align="center">Nov 2002</td>
                    626: </tr>
                    627: <tr>
1.110     hubertf   628: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    629: <td align="center">Nov 2002</td>
                    630: </tr>
                    631: <tr>
1.110     hubertf   632: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    633: <td align="center">Dec 2002</td>
                    634: </tr>
                    635: <tr>
                    636: <td>BSD/OS</td>
                    637: <td align="center">Dec 2003</td>
                    638: </tr>
                    639: <tr>
1.110     hubertf   640: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    641: <td align="center">Dec 2003</td>
                    642: </tr>
                    643: <tr>
                    644: <td>
1.110     hubertf   645:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    646:           (Microsoft Windows Services for Unix)
                    647:         </td>
                    648: <td align="center">Mar 2004</td>
                    649: </tr>
                    650: <tr>
1.110     hubertf   651: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    652: <td align="center">Oct 2004</td>
                    653: </tr>
                    654: <tr>
1.110     hubertf   655: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    656: <td align="center">Nov 2004</td>
                    657: </tr>
1.98      wiz       658: <tr>
1.110     hubertf   659: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       660: <td align="center">Apr 2007</td>
                    661: </tr>
1.82      rillig    662: </tbody>
1.91      rillig    663: </table></div>
1.82      rillig    664: </div>
1.91      rillig    665: <br class="table-break">
1.82      rillig    666: </div>
1.75      rillig    667: </div>
                    668: <div class="sect1" lang="en">
                    669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    670: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    671: <p>This document is divided into three parts. The first,
1.110     hubertf   672:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    673:        describes how one can use one of the packages in the Package
                    674:        Collection, either by installing a precompiled binary package,
1.93      rillig    675:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   676:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    677:        package so it can be easily built by other NetBSD users without
                    678:        knowing about the package's building details. The third part,
1.110     hubertf   679:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    680:        is intended for those who want to understand how pkgsrc is
                    681:        implemented.</p>
                    682: <p>This document is available in various formats:
1.110     hubertf   683:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    684: </div>
                    685: <div class="sect1" lang="en">
                    686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    687: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    688: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    689:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    690:       terminology used within this document.</p>
                    691: <div class="variablelist"><dl>
                    692: <dt><span class="term">Package</span></dt>
                    693: <dd><p>A set of files and building instructions
                    694:            that describe what's necessary
                    695:            to build a certain piece of software using
                    696:             pkgsrc. Packages are traditionally stored under
1.76      rillig    697:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    698: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       699: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    700:          is part of the NetBSD operating system and can be bootstrapped
                    701:          to run on non-NetBSD operating systems as well.  It handles
                    702:          building (compiling), installing, and removing of
                    703:          packages.</p></dd>
1.75      rillig    704: <dt><span class="term">Distfile</span></dt>
                    705: <dd><p>This term describes the file or files that are
                    706:            provided by the author of the piece of software to
                    707:            distribute his work. All the changes necessary to build on
                    708:            NetBSD are reflected in the corresponding package. Usually
                    709:            the distfile is in the form of a compressed tar-archive,
                    710:            but other types are possible, too. Distfiles are usually
                    711:            stored below
1.76      rillig    712:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    713: <dt><span class="term">Port</span></dt>
                    714: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    715:            for what we call a package.
                    716:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    717:            architecture.</p></dd>
                    718: <dt><span class="term">Precompiled/binary package</span></dt>
                    719: <dd>
                    720: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    721:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    722:            file so it can be installed on machines of the same
                    723:            machine architecture without the need to
                    724:            recompile. Packages are usually generated in
1.76      rillig    725:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110     hubertf   726:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75      rillig    727: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    728:            especially in the context of precompiled packages.</p>
                    729: </dd>
                    730: <dt><span class="term">Program</span></dt>
1.88      wiz       731: <dd><p>The piece of software to be installed which will be
                    732:          constructed from all the files in the distfile by the
                    733:          actions defined in the corresponding package.</p></dd>
1.75      rillig    734: </dl></div>
                    735: <div class="sect2" lang="en">
                    736: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       737: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    738: <div class="variablelist"><dl>
                    739: <dt><span class="term">pkgsrc users</span></dt>
                    740: <dd>
                    741: <p>The
                    742:        pkgsrc users are people who use the packages provided by pkgsrc.
                    743:        Typically they are system administrators. The people using the
                    744:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    745:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    746: <p>There are two kinds of pkgsrc users: Some only want to
                    747:        install pre-built binary packages. Others build the pkgsrc
                    748:        packages from source, either for installing them directly or for
1.110     hubertf   749:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    750:        documentation.</p>
                    751: </dd>
                    752: <dt><span class="term">package maintainers</span></dt>
                    753: <dd><p>A
1.110     hubertf   754:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    755: <dt><span class="term">infrastructure developers</span></dt>
                    756: <dd><p>These people are involved in all those files
1.76      rillig    757:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   758:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    759:        too.</p></dd>
                    760: </dl></div>
                    761: </div>
                    762: </div>
                    763: <div class="sect1" lang="en">
                    764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    765: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    766: <p>When giving examples for commands, shell prompts are used to
                    767:       show if the command should/can be issued as root, or if
                    768:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    769:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    770:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    771: </div>
                    772: </div>
                    773: <div class="part" lang="en">
                    774: <div class="titlepage"><div><div><h1 class="title">
                    775: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    776: <div class="toc">
                    777: <p><b>Table of Contents</b></p>
                    778: <dl>
                    779: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    780: <dd><dl>
                    781: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    782: <dd><dl>
                    783: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    784: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    785: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    786: </dl></dd>
                    787: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    788: <dd><dl>
                    789: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    790: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    791: </dl></dd>
                    792: </dl></dd>
                    793: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    794: <dd><dl>
1.82      rillig    795: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    796: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    797: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    798: <dd><dl>
                    799: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    800: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    801: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    802: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    803: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    804: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    805: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    806: </dl></dd>
                    807: </dl></dd>
                    808: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    811: <dd><dl>
                    812: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    813: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    814: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    815: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    816: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    817: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    818: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    819: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    820: </dl></dd>
                    821: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    822: <dd><dl>
                    823: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    824: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    825: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    826: </dl></dd>
                    827: </dl></dd>
                    828: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    829: <dd><dl>
                    830: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    831: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    832: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       833: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       834: <dd><dl>
1.103     wiz       835: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.122   ! reed      836: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !           837: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       838: </dl></dd>
1.103     wiz       839: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    840: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    841: </dl></dd>
                    842: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    843: <dd><dl>
                    844: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    845: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    846: </dl></dd>
                    847: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    848: builds)</a></span></dt>
1.75      rillig    849: <dd><dl>
1.106     rillig    850: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    851: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    852: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    853: <dd><dl>
                    854: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    855: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    856: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    857: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    858: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    859: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    860: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    861: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    862: </dl></dd>
                    863: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    864: <dd><dl>
                    865: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    866: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    867: </dl></dd>
1.106     rillig    868: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    870: </dl></dd>
                    871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    872: <dd><dl>
1.122   ! reed      873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
        !           874: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    875: </dl></dd>
                    876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    877: <dd><dl>
                    878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    884: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.122   ! reed      885: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig    886: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.122   ! reed      887: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
        !           888: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
        !           889: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
1.106     rillig    890: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    891: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    892: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.122   ! reed      893: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106     rillig    894: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.122   ! reed      895: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    896: </dl></dd>
                    897: </dl>
                    898: </div>
                    899: <div class="chapter" lang="en">
                    900: <div class="titlepage"><div><div><h2 class="title">
                    901: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    902: <div class="toc">
                    903: <p><b>Table of Contents</b></p>
                    904: <dl>
                    905: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    906: <dd><dl>
                    907: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    908: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    910: </dl></dd>
                    911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    912: <dd><dl>
                    913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    915: </dl></dd>
                    916: </dl>
                    917: </div>
1.91      rillig    918: <p>Before you download and extract the files, you need to decide
                    919: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    921: free to install the sources and binary packages wherever you want in
                    922: your filesystem, provided that the pathname does not contain white-space
                    923: or other characters that are interpreted specially by the shell and some
                    924: other programs. A safe bet is to use only letters, digits, underscores
                    925: and dashes.</p>
1.75      rillig    926: <div class="sect1" lang="en">
                    927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    929: <p>Before you download any pkgsrc files, you should decide
                    930:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    931:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    932:        quarterly basis from the current branch and only gets modified
                    933:        for security updates. The names of the stable branches are built
                    934:        from the year and the quarter, for example
1.112     weinem    935:        <code class="literal">2007Q4</code>.</p>
1.75      rillig    936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    937:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    938:        or via CVS. All three ways are described here.</p>
                    939: <div class="sect2" lang="en">
                    940: <div class="titlepage"><div><div><h3 class="title">
                    941: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    942: <p>The primary download location for all pkgsrc files is
1.110     hubertf   943:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75      rillig    944:        number of subdirectories for different purposes, which are
1.110     hubertf   945:        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>
1.75      rillig    946: <p>The tar file for the current branch is in the directory
1.110     hubertf   947:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    948:        It is autogenerated daily.</p>
1.112     weinem    949: <p>The tar file for the stable branch 2007Q4 is in the
                    950:        directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
                    951: <p>To download a pkgsrc stable tarball, run:</p>
                    952: <pre class="screen">
                    953: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
                    954: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    955:        stable branch to be downloaded, for example, 
                    956:        &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;.</p>
                    957: <p>Then, extract it with:</p>
                    958: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
                    959: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    960:        in <code class="filename">/usr/</code> and all the package source will be 
                    961:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    962: <p>To download pkgsrc-current, run:</p>
                    963: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig    964: </div>
                    965: <div class="sect2" lang="en">
                    966: <div class="titlepage"><div><div><h3 class="title">
                    967: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    968: <p>As an alternative to the tar file, you can get pkgsrc via
                    969:        the Software Update Protocol, SUP. To do so, make sure your
                    970:        supfile has a line
1.1       grant     971: 
1.75      rillig    972: </p>
                    973: <pre class="programlisting">
1.100     rillig    974: release=pkgsrc
1.1       grant     975: </pre>
1.75      rillig    976: <p>
1.1       grant     977: 
1.75      rillig    978:        in it, see the examples in
1.76      rillig    979:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    980:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113     weinem    981:        run:</p>
                    982: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.75      rillig    983: </div>
                    984: <div class="sect2" lang="en">
                    985: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    986: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112     weinem    987: <p>To do an initial (full) checkout of pkgsrc, you first
1.75      rillig    988:        have to set some environment variables. For the C-Shell,
                    989:        type:</p>
1.113     weinem    990: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    991: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75      rillig    992: </pre>
                    993: <p>Or, the same for the bourne shell:</p>
1.113     weinem    994: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    995: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75      rillig    996: </pre>
1.113     weinem    997: <p>By default, CVS doesn't do things like most people would
1.112     weinem    998:        expect it to do. But there is a
1.113     weinem    999:        way to convince CVS, by creating a file called
1.101     rillig   1000:        <code class="filename">.cvsrc</code> in your home directory and saving
                   1001:        the following lines to it. This file will save you lots of
                   1002:        headache and some bug reports, so we strongly recommend it. You
                   1003:        can find an explanation of this file in the CVS
                   1004:        documentation.</p>
                   1005: <pre class="programlisting">
                   1006: # recommended CVS configuration file from the pkgsrc guide
                   1007: checkout -P
1.103     wiz      1008: update -dP
1.101     rillig   1009: release -d
1.103     wiz      1010: diff -upN
1.101     rillig   1011: cvs -q -z3
                   1012: rdiff -u
                   1013: </pre>
1.112     weinem   1014: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1015: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1016: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.112     weinem   1017: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
                   1018:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;</p>
                   1019: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1020:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1021:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1022: <p>To fetch the pkgsrc current branch, run:</p>
                   1023: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1024: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75      rillig   1025: </div>
                   1026: </div>
                   1027: <div class="sect1" lang="en">
                   1028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1029: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1030: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1031:        (which also works if you have first installed it via a tar
                   1032:        file). It saves bandwidth and hard disk activity, compared to
                   1033:        downloading the tar file again.</p>
                   1034: <div class="sect2" lang="en">
                   1035: <div class="titlepage"><div><div><h3 class="title">
                   1036: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1037: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1038: <h3 class="title">Warning</h3>
1.77      rillig   1039: <p>When updating from a tar file, you first need to
                   1040:        completely remove the old pkgsrc directory. Otherwise those
                   1041:        files that have been removed from pkgsrc in the mean time will
                   1042:        not be removed on your local disk, resulting in inconsistencies.
                   1043:        When removing the old files, any changes that you have done to
                   1044:        the pkgsrc files will be lost after updating. Therefore updating
                   1045:        via CVS is strongly recommended.</p>
1.75      rillig   1046: </div>
1.82      rillig   1047: <p>Note that by default the distfiles and the binary packages
                   1048:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1049:        before updating. You can also configure pkgsrc to use other than
                   1050:        the default directories by setting the
                   1051:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1052:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1053: <p>To update pkgsrc from a tar file, download the tar file as
                   1054:        explained above. Then, make sure that you have not made any
                   1055:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1056:        directory and extract the new tar file. Done.</p>
                   1057: </div>
                   1058: <div class="sect2" lang="en">
                   1059: <div class="titlepage"><div><div><h3 class="title">
                   1060: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1061: <p>To update pkgsrc via CVS, make sure the environment
                   1062:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113     weinem   1063:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   1065: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75      rillig   1066: <div class="sect3" lang="en">
                   1067: <div class="titlepage"><div><div><h4 class="title">
                   1068: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1069: <p>When updating pkgsrc, the CVS program keeps track of the
                   1070:        branch you selected. But if you, for whatever reason, want to
                   1071:        switch from the stable branch to the current one, you can do it
                   1072:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1073:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1074:        back to the stable branch, add the
1.113     weinem   1075:        &#8220;<span class="quote">-rpkgsrc-2007Q4</span>&#8221; option.</p>
1.75      rillig   1076: </div>
                   1077: <div class="sect3" lang="en">
                   1078: <div class="titlepage"><div><div><h4 class="title">
                   1079: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1080: <p>When you update pkgsrc, the CVS program will only touch
                   1081:        those files that are registered in the CVS repository. That
                   1082:        means that any packages that you created on your own will stay
                   1083:        unmodified. If you change files that are managed by CVS, later
                   1084:        updates will try to merge your changes with those that have been
                   1085:        done by others. See the CVS manual, chapter
                   1086:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1087: </div>
                   1088: </div>
                   1089: </div>
                   1090: </div>
                   1091: <div class="chapter" lang="en">
                   1092: <div class="titlepage"><div><div><h2 class="title">
                   1093: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1094: <div class="toc">
                   1095: <p><b>Table of Contents</b></p>
                   1096: <dl>
1.82      rillig   1097: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1098: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1099: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1100: <dd><dl>
                   1101: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1106: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1107: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1108: </dl></dd>
                   1109: </dl>
                   1110: </div>
                   1111: <div class="sect1" lang="en">
                   1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1113: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1114: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1115: </div>
                   1116: <div class="sect1" lang="en">
                   1117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1118: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1119: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1120: <pre class="screen">
                   1121: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1122: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1123: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1124:     </pre>
1.110     hubertf  1125: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87      wiz      1126:     pkgsrc before bootstrapping. The given
1.110     hubertf  1127:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87      wiz      1128:     <code class="filename">/usr/pkg</code> for the
                   1129:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1130:     and <code class="filename">/var/db/pkg</code> for the package database
                   1131:     directory where pkgsrc will do its internal bookkeeping.
                   1132:     However, these can also be set using command-line
                   1133:     arguments.</p>
1.75      rillig   1134: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1135: <h3 class="title">Note</h3>
1.110     hubertf  1136: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1137:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1138:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87      wiz      1139:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1140: </div>
                   1141: </div>
                   1142: <div class="sect1" lang="en">
                   1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1144: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1145: <p>Here are some platform-specific notes you should be aware of.</p>
                   1146: <div class="sect2" lang="en">
                   1147: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1148: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1149: <p>Darwin 5.x and up are supported. There are two methods of using
1.110     hubertf  1150:        pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1151:          image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1152:          partition</a>.</p>
                   1153: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110     hubertf  1154:       Tools from Apple's Developer Connection.  See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87      wiz      1155:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110     hubertf  1156:       from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87      wiz      1157:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1158: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1159:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1160:       the disk image. It'll be somewhat faster and will mount automatically
                   1161:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1162: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1163: <h3 class="title">Note</h3>
1.85      jmmv     1164: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1165:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75      rillig   1166: </div>
                   1167: <div class="sect3" lang="en">
                   1168: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1169: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1170: <p>Create the disk image:</p>
                   1171: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1172: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1173: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1174: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1176: <h3 class="title">Note</h3>
1.109     rillig   1177: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journaling.</p>
1.85      jmmv     1178: </div>
1.89      rillig   1179: <p>Allow suid:</p>
                   1180: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105     weinem   1181: <p>Changing the build directory:</p>
                   1182: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
                   1183: <pre class="programlisting">
                   1184:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1185:        </pre>
1.75      rillig   1186: </div>
                   1187: <div class="sect3" lang="en">
                   1188: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1189: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1190: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1191:        system, normally HFS+. It is possible to use the default
                   1192:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1193:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1194:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1195:        place the package database directory outside the
                   1196:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1197: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1198: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1199:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1200:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1201:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1202:        to ensure that the partition map correctly reflects
1.89      rillig   1203:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
1.75      rillig   1204: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1205:        disk that is booted from. You can unmount the partition, but even if
                   1206:        you newfs it, the partition type will be incorrect and the
                   1207:        automounter won't mount it. It can be mounted manually, but it won't
                   1208:        appear in Finder.</p>
1.75      rillig   1209: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1210:        the Installation program starts, go up to the menu and select Disk
                   1211:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1212:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1213:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1214:        will appear in Finder.</p>
1.75      rillig   1215: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1216:        by root only.</p>
1.75      rillig   1217: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1218:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1219: </div>
                   1220: </div>
                   1221: <div class="sect2" lang="en">
                   1222: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1223: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1224: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1225:       other versions may work.</p>
1.75      rillig   1226: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1227:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1228: <div class="orderedlist"><ol type="1">
                   1229: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1230:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1231:          recommended that you choose a different location (e.g.
                   1232:          <code class="filename">/usr/pkgdb</code>) by
                   1233:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1234: <li>
                   1235: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1236:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1237: <pre class="screen">
                   1238: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1241: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1242: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1243:          </pre>
1.75      rillig   1244: </li>
1.110     hubertf  1245: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1246:          <code class="filename">/etc/mk.conf.example</code> file
                   1247:          when you use the bootstrap script.</p></li>
1.75      rillig   1248: </ol></div>
                   1249: </div>
                   1250: <div class="sect2" lang="en">
                   1251: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1252: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1253: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1254:       providing a Unix-like environment with a tighter kernel integration than
                   1255:       available with Cygwin.  It is part of the Windows Services for Unix
                   1256:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1257:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1258: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1259:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1260:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1261: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1262:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1263:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1264: <div class="sect3" lang="en">
                   1265: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1266: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1267: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1268:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1269: <div class="itemizedlist"><ul type="disc">
                   1270: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1271: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1272: <li><p>Remote Connectivity</p></li>
                   1273: <li><p>Interix SDK</p></li>
                   1274: </ul></div>
                   1275: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1276:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1277:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1278:        pkgsrc (or from a binary package).</p>
1.75      rillig   1279: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1280:        not need to be installed, but Remote Connectivity itself should be
                   1281:        installed in order to have a working inetd.</p>
1.75      rillig   1282: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1283:        behavior for Interix programs, and whether to make pathnames default to
                   1284:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1285:        enabled.  (Without case-sensitivity, a large number of packages including
                   1286:        perl will not build.)</p>
1.75      rillig   1287: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1288:        works (via the Data Execution Prevention feature).  In order to use
                   1289:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1290:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1291:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1292:        support contract; however, Debian Interix Port has made most Interix
                   1293:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93      rillig   1294: <p>In addition to the hotfix noted above, it may be necessary to
                   1295:        disable Data Execution Prevention entirely to make Interix functional.
                   1296:        This may happen only with certain types of CPUs; the cause is not fully
                   1297:        understood at this time.  If gcc or other applications still segfault
                   1298:        repeatedly after installing one of the hotfixes note above, the
                   1299:        following option can be added to the appropriate "boot.ini" line on the
                   1300:        Windows boot drive:  /NoExecute=AlwaysOff
                   1301:        (WARNING, this will disable DEP completely, which may be a security
                   1302:        risk if applications are often run as a user in the Administrators
                   1303:        group!)</p>
1.75      rillig   1304: </div>
                   1305: <div class="sect3" lang="en">
                   1306: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1307: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1308: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1309:        with pkgsrc, note the following things.</p>
1.75      rillig   1310: <div class="itemizedlist"><ul type="disc">
                   1311: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1312:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1313:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1314: <li>
                   1315: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1316:            change the following registry key:</p>
1.75      rillig   1317: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1318: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1319: </li>
                   1320: <li>
                   1321: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1322:            following registry key:</p>
1.75      rillig   1323: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1324: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1325: </li>
                   1326: </ul></div>
                   1327: </div>
                   1328: <div class="sect3" lang="en">
                   1329: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1330: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1331: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1332:        running "pkg_add") must be a member of the local Administrators
                   1333:        group.  Such a user must also be used to run the bootstrap.  This is
                   1334:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1335: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1336:        automatically complain if this is not the case.  This ensures that
                   1337:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1338: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1339:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1340:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1341:        the same time as the pkgsrc packages, ensure that you use the proper
                   1342:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1343: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1344:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1345:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1346:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1347: <pre class="programlisting">
1.100     rillig   1348: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1349:        </pre>
1.75      rillig   1350: </div>
                   1351: <div class="sect3" lang="en">
                   1352: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1353: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1354: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1355:        for a full Unix-like platform, it has some drawbacks that should
                   1356:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1357: <div class="itemizedlist"><ul type="disc">
                   1358: <li>
                   1359: <p><span class="strong"><strong>X11:</strong></span></p>
                   1360: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1361:          and can run X11 based applications, but it does
                   1362:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1363:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1364:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1365:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1366:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1367:          and the free X11 server included with
1.110     hubertf  1368:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1369: </li>
                   1370: <li>
                   1371: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1372: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1373:          Win32 applications, it does not currently support various X11
                   1374:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1375:          Most interactive applications to a local X server will run
                   1376:          reasonably fast, but full motion video and other graphics
                   1377:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1378: </li>
                   1379: <li>
                   1380: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1381: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1382:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1383:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1384:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110     hubertf  1385:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1386:          server component.  To output audio via an Interix host, the
1.91      rillig   1387:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1388:          must also be installed.</p>
1.75      rillig   1389: </li>
                   1390: <li>
                   1391: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1392: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1393:          is not currently possible to access CD/DVD drives, USB devices,
                   1394:          or SCSI devices through non-filesystem means.  Among other things,
                   1395:          this makes it impossible to use Interix directly for CD/DVD
                   1396:          burning.</p>
1.75      rillig   1397: </li>
                   1398: <li>
                   1399: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1400: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1401:          drives are also not directly accessible in Interix.  However,
                   1402:          support is in work to make tape drive access possible by using
                   1403:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1404:          esound server).</p>
1.75      rillig   1405: </li>
                   1406: </ul></div>
                   1407: </div>
                   1408: <div class="sect3" lang="en">
                   1409: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1410: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1411: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1412:        Windows system; any member of the local Administrators group will
                   1413:        suffice.  However, some packages currently assume that the user
                   1414:        named "root" is the privileged user.  To accommodate these, you
                   1415:        may create such a user; make sure it is in the local group
                   1416:        Administrators (or your language equivalent).</p>
1.110     hubertf  1417: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1418:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1419:        time being, install packages as the local Administrator (or
                   1420:        your language equivalent), or run the following command after
                   1421:        installing a package to work around the issue:</p>
1.75      rillig   1422: <pre class="screen">
1.87      wiz      1423: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1424:        </pre>
1.75      rillig   1425: </div>
                   1426: </div>
                   1427: <div class="sect2" lang="en">
                   1428: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1429: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1430: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1431:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1432:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1433:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1434: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110     hubertf  1435:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1436:       etc.</p>
1.86      schwarz  1437: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1438:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1439:        you start out using "abi=n32", that's what all your packages will be built
                   1440:        with.</p>
                   1441: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1442:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1443:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1444:       try to link n32 object files with lib64 or vice versa.  Check your
                   1445:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1446: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1447:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1448:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1449:       link over a network-mounted file system.</p>
1.75      rillig   1450: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1451:       as imake(1), but you may want to set some options depending on your local
                   1452:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1453:       course, your compiler's man pages for details.</p>
1.75      rillig   1454: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1455: 
1.87      wiz      1456:       </p>
1.75      rillig   1457: <pre class="programlisting">
1.100     rillig   1458: PKGSRC_COMPILER=        mipspro
1.87      wiz      1459:       </pre>
1.75      rillig   1460: <p>
1.1       grant    1461: 
1.110     hubertf  1462:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1463:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1464:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1465:       default.</p>
1.75      rillig   1466: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1467:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1468:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1469:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1470:       '--preserve-path' flag.</p>
1.75      rillig   1471: </div>
                   1472: <div class="sect2" lang="en">
                   1473: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1474: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1475: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1476:       either libtermcap or libcurses (libncurses).  Installing the
                   1477:       distributions libncurses-dev package (or equivalent) should fix
                   1478:       the problem.</p>
                   1479: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1480:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1481:       i386 have been tested.</p>
1.75      rillig   1482: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1483:       directory:</p>
1.75      rillig   1484: <pre class="programlisting">
1.100     rillig   1485: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1486: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1487:       </pre>
1.75      rillig   1488: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1489: <h3 class="title">Note</h3>
                   1490: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1491: </div>
                   1492: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1493:       function, which icc does not support. #undef'ing __attribute__ has the
                   1494:       unfortunate side-effect of breaking many of the Linux header files, which
                   1495:       cannot be compiled properly without __attribute__. The test must be
                   1496:       overridden so that __attribute__ is assumed supported by the
                   1497:       compiler.</p>
1.75      rillig   1498: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110     hubertf  1499:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1500: <pre class="programlisting">
1.100     rillig   1501: PKGSRC_COMPILER=        icc
1.87      wiz      1502:       </pre>
1.75      rillig   1503: <p>The default installation directory for icc is
1.87      wiz      1504:       <code class="filename">/opt/intel_cc_80</code>, which
                   1505:       is also the pkgsrc default. If you have installed it into a different
                   1506:       directory, set <code class="varname">ICCBASE</code> in
1.110     hubertf  1507:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1508: <pre class="programlisting">
1.100     rillig   1509: ICCBASE=                /opt/icc
1.87      wiz      1510:       </pre>
1.75      rillig   1511: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1512:       provided by icc, so binaries can be run on other systems which do not
                   1513:       have the shared libraries installed.</p>
                   1514: <p>Libtool, however, extracts a list of libraries from the
1.110     hubertf  1515:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1516:       records it, throwing away the -Bstatic and -Bdynamic options
                   1517:       interspersed between the libraries.  This means that
                   1518:       libtool-linked C++ shared libraries will have a runtime
                   1519:       dependency on the icc libraries until this is fixed in
                   1520:       libtool.</p>
1.75      rillig   1521: </div>
                   1522: <div class="sect2" lang="en">
                   1523: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1524: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1525: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1526: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1527:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1528: <div class="orderedlist"><ol type="1">
                   1529: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1530:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1531:          recommended that you choose a different location (e.g.
                   1532:          <code class="filename">/usr/pkgdb</code>) by
                   1533:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1534: <li>
                   1535: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1536:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1537: <pre class="screen">
                   1538: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1541: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1542: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1543:          </pre>
1.75      rillig   1544: </li>
                   1545: <li>
1.110     hubertf  1546: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1547:          <code class="filename">/etc/mk.conf.example</code> file
                   1548:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1549:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1550:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1551:          of the file with:</p>
                   1552: <pre class="programlisting">
1.100     rillig   1553: .ifdef BSD_PKG_MK
                   1554: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1555: .else
                   1556: # OpenBSD stuff
                   1557: .endif
1.87      wiz      1558:          </pre>
1.75      rillig   1559: </li>
                   1560: </ol></div>
                   1561: </div>
                   1562: <div class="sect2" lang="en">
                   1563: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1564: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1565: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1566:       You will need a working C compiler. Both gcc 2.95.3 and
                   1567:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1568: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1569:       process and to build packages.</p>
1.75      rillig   1570: <div class="itemizedlist"><ul type="disc">
                   1571: <li><p>SUNWsprot</p></li>
                   1572: <li><p>SUNWarc</p></li>
                   1573: <li><p>SUNWbtool</p></li>
                   1574: <li><p>SUNWtoo</p></li>
                   1575: <li><p>SUNWlibm</p></li>
                   1576: </ul></div>
1.78      rillig   1577: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1578:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1579: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1580:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1581:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1582:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1583: <div class="sect3" lang="en">
                   1584: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1585: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1586: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1587:        for building all packages.</p>
1.75      rillig   1588: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1589:        then either build gcc from
1.91      rillig   1590:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87      wiz      1591:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1592: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1593: </div>
                   1594: <div class="sect3" lang="en">
                   1595: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1596: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1597: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1598:        5.0)</p>
1.75      rillig   1599: <div class="itemizedlist"><ul type="disc">
                   1600: <li><p>SPROcc
1.87      wiz      1601:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1602: <li><p>SPROcpl
1.87      wiz      1603:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1604: <li><p>SPROild
1.87      wiz      1605:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1606: <li><p>SPROlang
1.87      wiz      1607:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1608: </ul></div>
1.96      rillig   1609: <p>You should set the following variables in your
1.110     hubertf  1610:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1611: <pre class="programlisting">
1.100     rillig   1612: CC=     cc
                   1613: CXX=    CC
                   1614: CPP=    cc -E
                   1615: CXXCPP= CC -E
1.96      rillig   1616: </pre>
                   1617: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1618: <h3 class="title">Note</h3>
                   1619: <p>The <code class="varname">CPP</code> setting might break some
                   1620:        packages that use the C preprocessor for processing things other
                   1621:        than C source code.</p>
                   1622: </div>
1.75      rillig   1623: </div>
                   1624: <div class="sect3" lang="en">
                   1625: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1626: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1627: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1628:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1629: <pre class="programlisting">
1.100     rillig   1630: PKGSRC_COMPILER=        sunpro
                   1631: ABI=                    64
1.96      rillig   1632: </pre>
                   1633: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1634: <h3 class="title">Note</h3>
                   1635: <p>This setting has been tested for the SPARC
                   1636:        architecture. Intel and AMD machines need some more
                   1637:        work.</p>
                   1638: </div>
1.75      rillig   1639: </div>
                   1640: <div class="sect3" lang="en">
                   1641: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1642: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110     hubertf  1643: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1644:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1645:       The workaround is to use another shell for the configure
1.91      rillig   1646:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110     hubertf  1647:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1648: <pre class="programlisting">
1.100     rillig   1649: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1650: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1651:       </pre>
1.91      rillig   1652: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1653: </div>
                   1654: </div>
                   1655: </div>
                   1656: </div>
                   1657: <div class="chapter" lang="en">
                   1658: <div class="titlepage"><div><div><h2 class="title">
                   1659: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1660: <div class="toc">
                   1661: <p><b>Table of Contents</b></p>
                   1662: <dl>
                   1663: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1664: <dd><dl>
                   1665: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1666: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1667: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1668: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1669: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1670: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1671: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1672: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1673: </dl></dd>
                   1674: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1675: <dd><dl>
                   1676: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1677: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1678: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1679: </dl></dd>
                   1680: </dl>
                   1681: </div>
                   1682: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1683: is to only install the package tools and to use binary packages
                   1684: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1685: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1686: of pkgsrc, too. Then you are able to build your own packages,
                   1687: and you can still use binary packages from someone else.</p>
1.75      rillig   1688: <div class="sect1" lang="en">
                   1689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1690: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1691: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1692:   server and its mirrors, there are collections of binary packages,
                   1693:   ready to be installed. These binary packages have been built using the
                   1694:   default settings for the directories, that is:</p>
                   1695: <div class="itemizedlist"><ul type="disc">
                   1696: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1697: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1698: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
                   1699: </ul></div>
                   1700: <p>If you cannot use these directories for whatever reasons (maybe
                   1701:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1702:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.75      rillig   1703: <div class="sect2" lang="en">
                   1704: <div class="titlepage"><div><div><h3 class="title">
                   1705: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1706: <p>To install binary packages, you first need to know from where
                   1707:     to get them. The first place where you should look is on the main
1.110     hubertf  1708:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1709: <p>This directory contains binary packages for multiple
                   1710:     platforms. First, select your operating system. (Ignore the
                   1711:     directories with version numbers attached to it, they just exist for
                   1712:     legacy reasons.) Then, select your hardware architecture, and in the
1.109     rillig   1713:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1714: <p>In this directory, you often find a file called
                   1715:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1716:     management tools. If the file is missing, it is likely that your
                   1717:     operating system already provides those tools. Download the file and
                   1718:     extract it in the <code class="filename">/</code> directory. It will create
                   1719:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1720:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1721:     (the database of installed packages).</p>
1.75      rillig   1722: </div>
                   1723: <div class="sect2" lang="en">
                   1724: <div class="titlepage"><div><div><h3 class="title">
                   1725: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1726: <p>In the directory from the last section, there is a
                   1727:     subdirectory called <code class="filename">All</code>, which contains all the
                   1728:     binary packages that are available for the platform, excluding those
                   1729:     that may not be distributed via FTP or CDROM (depending on which
                   1730:     medium you are using), and the ones that have vulnerabilities and
                   1731:     therefore are considered insecure to install without thinking
                   1732:     before.</p>
                   1733: <p>To install packages directly from an FTP or HTTP server, run
                   1734:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1735:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1736: <pre class="screen">
                   1737: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1738: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.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>
                   1739: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1740: </pre>
                   1741: <p>Instead of URLs, you can also use local paths, for example if
                   1742:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1743:     repository. If you want to install packages from multiple sources,
                   1744:     you can separate them by a semicolon in
                   1745:     <code class="varname">PKG_PATH</code>.</p>
                   1746: <p>After these preparations, installing a package is very
                   1747:     easy:</p>
                   1748: <pre class="screen">
                   1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1750: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1751: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1752: </pre>
1.75      rillig   1753: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1754:     package in question will be installed, too, assuming they are
                   1755:     present where you install from.</p>
1.109     rillig   1756: <p>As mentioned above, packages for which vulnerabilities get
                   1757:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1758:     They don't get deleted since that could be very frustrating if many
                   1759:     other packages depend on it. Instead, they are moved to the
                   1760:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1761:     this directory to the <code class="varname">PKG_PATH</code> variable. 
1.114     jmcneill 1762:     However, you should run <span class="command"><strong>audit-packages</strong></span>
                   1763:     regularly, especially after installing new packages, and verify
                   1764:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1765: <p>After you've installed packages, be sure to have
1.88      wiz      1766:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1767:     <code class="varname">PATH</code> so you can actually start the just
                   1768:     installed program.</p>
1.75      rillig   1769: </div>
                   1770: <div class="sect2" lang="en">
                   1771: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1772: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1773: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1774:     installed from source code or from a binary package. The
1.110     hubertf  1775:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1776:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1777:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1778:     name can be given with or without version number. Wildcards can
                   1779:     also be used to deinstall a set of packages, for example
                   1780:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1781:     so that the shell does not expand them before
                   1782:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1783: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1784:     removes all the packages that require the package in question
                   1785:     and then removes the package itself. For example:
1.82      rillig   1786: 
1.88      wiz      1787:     </p>
1.82      rillig   1788: <pre class="screen">
1.88      wiz      1789: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1790:     </pre>
1.82      rillig   1791: <p>
                   1792: 
1.88      wiz      1793:     will remove jpeg and all the packages that used it; this allows
                   1794:     upgrading the jpeg package.</p>
1.82      rillig   1795: </div>
                   1796: <div class="sect2" lang="en">
                   1797: <div class="titlepage"><div><div><h3 class="title">
                   1798: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1799: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1800:     installed packages or binary package files.</p>
1.82      rillig   1801: </div>
                   1802: <div class="sect2" lang="en">
                   1803: <div class="titlepage"><div><div><h3 class="title">
                   1804: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1805: <p>
1.88      wiz      1806:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1807:       known security vulnerabilities to packages which are (or have been)
                   1808:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1809:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1810:     </p>
1.82      rillig   1811: <p>
1.93      rillig   1812:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88      wiz      1813:       this list can be downloaded
                   1814:       automatically, and a security audit of all packages installed on a system
                   1815:       can take place.
                   1816:     </p>
1.82      rillig   1817: <p>
1.93      rillig   1818:       There are two components to
1.91      rillig   1819:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
1.88      wiz      1820:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1821:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1822:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1823:       installed packages are vulnerable.  If a package is vulnerable, you
                   1824:       will see output similar to the following:
                   1825:     </p>
1.82      rillig   1826: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1827:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1828: <p>
1.91      rillig   1829:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.110     hubertf  1830:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88      wiz      1831:       file daily, and include a package audit in the daily security script.
1.110     hubertf  1832:       Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91      rillig   1833:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88      wiz      1834:     </p>
1.82      rillig   1835: </div>
                   1836: <div class="sect2" lang="en">
                   1837: <div class="titlepage"><div><div><h3 class="title">
                   1838: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1839: <p>
1.112     weinem   1840:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.110     hubertf  1841:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.88      wiz      1842:       argument to check if your packages are up-to-date, e.g.
                   1843:     </p>
                   1844: <pre class="screen">
                   1845: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1846: ...
1.88      wiz      1847: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1848:     </pre>
1.110     hubertf  1849: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1850:     package on your system and rebuild any dependencies.
                   1851:     </p>
1.82      rillig   1852: </div>
                   1853: <div class="sect2" lang="en">
                   1854: <div class="titlepage"><div><div><h3 class="title">
                   1855: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1856: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1857:     administrative functions on the package system.</p>
1.82      rillig   1858: </div>
                   1859: <div class="sect2" lang="en">
                   1860: <div class="titlepage"><div><div><h3 class="title">
                   1861: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1862: <p>Please pay very careful attention to the warnings
1.110     hubertf  1863:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1864:     inherent dangers of installing binary packages which you did
                   1865:     not create yourself, and the security holes that can be
                   1866:     introduced onto your system by indiscriminate adding of such
                   1867:     files.</p>
1.75      rillig   1868: <p>The same warning of course applies to every package you
1.88      wiz      1869:     install from source when you haven't completely read and
                   1870:     understood the source code of the package, the compiler that
                   1871:     is used to build the package and all the other tools that are
                   1872:     involved.</p>
1.75      rillig   1873: </div>
                   1874: </div>
                   1875: <div class="sect1" lang="en">
                   1876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1877: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1878: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1879:   directory now contains a set of packages, organized into
                   1880:   categories. You can browse the online index of packages, or run
1.110     hubertf  1881:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1882:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1883:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1884: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1885:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1886:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1887:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1888:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1889:   system (inside a chroot is an exception). </p>
                   1890: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1891:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1892:   instructions how to create your own packages.</p>
1.75      rillig   1893: <div class="sect2" lang="en">
                   1894: <div class="titlepage"><div><div><h3 class="title">
                   1895: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1896: <p>To build packages from source, you need a working C
1.88      wiz      1897:     compiler. On NetBSD, you need to install the
                   1898:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1899:     sets. If you want to build X11-related packages, the
                   1900:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1901:     sets are required, too.</p>
1.75      rillig   1902: </div>
                   1903: <div class="sect2" lang="en">
                   1904: <div class="titlepage"><div><div><h3 class="title">
                   1905: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1906: <p>The first step for building a package is downloading the
1.88      wiz      1907:     distfiles (i.e. the unmodified source). If they have not yet been
                   1908:     downloaded, pkgsrc will fetch them automatically.</p>
                   1909: <p>If you have all files that you need in the
                   1910:     <code class="filename">distfiles</code> directory,
                   1911:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1912:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1913:     </p>
1.82      rillig   1914: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1915: <p>
1.110     hubertf  1916:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1917: <p>By default a list of distribution sites will be randomly
                   1918:     intermixed to prevent huge load on servers which holding popular
                   1919:     packages (for example, SourceForge.net mirrors). Thus, every
                   1920:     time when you need to fetch yet another distfile all the mirrors
                   1921:     will be tried in new (random) order. You can turn this feature
                   1922:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1923:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1924: <p>You can overwrite some of the major distribution sites to
                   1925:     fit to sites that are close to your own.  By setting one or two
                   1926:     variables you can modify the order in which the master sites are
                   1927:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1928:     delimited list of domain suffixes.
                   1929:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1930:     contains a whitespace delimited list of regular expressions.  It
                   1931:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1932:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1933:     some examples.  This may save some of your bandwidth and
                   1934:     time.</p>
1.75      rillig   1935: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1936:     if you want to keep the settings, by editing the
1.110     hubertf  1937:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1938:     and adding the definitions there.</p>
1.82      rillig   1939: <p>
1.88      wiz      1940:       If a package depends on many other packages (such as
1.93      rillig   1941:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1942:       alternate between periods of
                   1943:       downloading source, and compiling. To ensure you have all the source
                   1944:       downloaded initially you can run the command:
                   1945:       </p>
1.82      rillig   1946: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1947: <p>
1.88      wiz      1948:       which will output and run a set of shell commands to fetch the
                   1949:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1950:       also choose to download the files manually.
                   1951:     </p>
1.75      rillig   1952: </div>
                   1953: <div class="sect2" lang="en">
                   1954: <div class="titlepage"><div><div><h3 class="title">
                   1955: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1956: <p>
1.88      wiz      1957:       Once the software has downloaded, any patches will be applied, then it
                   1958:       will be compiled for you. This may take some time depending on your
                   1959:       computer, and how many other packages the software depends on and their
                   1960:       compile time.
                   1961:     </p>
1.75      rillig   1962: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1963: <h3 class="title">Note</h3>
                   1964: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1965:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88      wiz      1966:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   1967: </div>
1.87      wiz      1968: <p>For example, type</p>
1.88      wiz      1969: <pre class="screen">
                   1970: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1971: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1972:     </pre>
1.75      rillig   1973: <p>at the shell prompt to build the various components of the
1.88      wiz      1974:     package.</p>
1.82      rillig   1975: <p>The next stage is to actually install the newly compiled
1.88      wiz      1976:     program onto your system. Do this by entering:
1.82      rillig   1977: 
1.88      wiz      1978:     </p>
1.82      rillig   1979: <pre class="screen">
1.88      wiz      1980: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1981:     </pre>
1.82      rillig   1982: <p>
                   1983: 
1.88      wiz      1984:     while you are still in the directory for whatever package you
                   1985:     are installing.</p>
1.82      rillig   1986: <p>Installing the package on your system may require you to
1.88      wiz      1987:     be root.  However, pkgsrc has a
                   1988:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1989:     to only become root for the actual installation step.</p>
1.82      rillig   1990: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1991:     You can now enter:
1.82      rillig   1992: 
1.88      wiz      1993:     </p>
1.82      rillig   1994: <pre class="screen">
1.88      wiz      1995: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1996:     </pre>
1.82      rillig   1997: <p>
                   1998: 
1.88      wiz      1999:     to remove the compiled files in the work directory, as you shouldn't need
                   2000:     them any more. If other packages were also added to your system
                   2001:     (dependencies) to allow your program to compile, you can tidy these up
                   2002:     also with the command:</p>
1.82      rillig   2003: <pre class="screen">
1.88      wiz      2004: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2005:     </pre>
1.75      rillig   2006: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2007:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      2008: <p>The program is installed under the default root of the
                   2009:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2010:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2011:     variable in your environment, and it will use that value as the
                   2012:     root of your packages tree. So, to use
                   2013:     <code class="filename">/usr/local</code>, set
                   2014:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2015:     Please note that you should use a directory which is dedicated to
                   2016:     packages and not shared with other programs (i.e., do not try and
                   2017:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2018:     to add any of your own files or directories (such as
                   2019:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2020:     <code class="filename">pkgsrc/</code>) below the
                   2021:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2022:     conflicts between programs and other files installed by the
                   2023:     package system and whatever else may have been installed
                   2024:     there.</p>
1.110     hubertf  2025: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2026:     alter some configuration options at build time.  Have a look at
                   2027:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2028:     of what will be set there by default.  Environment variables such
                   2029:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2030:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2031:     set them each time you want to use pkgsrc.</p>
                   2032: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2033:     covers</span>&#8221; to see what is going on when a package is building
                   2034:     or being installed. This may be for debugging purposes, or out of
                   2035:     simple curiosity. A number of utility values have been added to
                   2036:     help with this.</p>
1.75      rillig   2037: <div class="orderedlist"><ol type="1">
                   2038: <li>
1.110     hubertf  2039: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2040:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2041:        information will be displayed. For example,</p>
1.75      rillig   2042: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2043: <p>will show all the commands that are invoked, up to and
                   2044:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2045: </li>
                   2046: <li>
1.110     hubertf  2047: <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+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2048:        definition, then the <code class="varname">VARNAME</code> definition
                   2049:        should be used, in conjunction with the show-var
1.110     hubertf  2050:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2051:        variable <code class="varname">LOCALBASE</code>:</p>
                   2052: <pre class="screen">
                   2053: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2054: /usr/pkg
                   2055: <code class="prompt">%</code>
1.88      wiz      2056:        </pre>
1.75      rillig   2057: </li>
                   2058: </ol></div>
                   2059: <p>If you want to install a binary package that you've either
1.88      wiz      2060:     created yourself (see next section), that you put into
                   2061:     pkgsrc/packages manually or that is located on a remote FTP
                   2062:     server, you can use the "bin-install" target. This target will
1.110     hubertf  2063:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2064:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2065:     sites searched is kept in the variable
                   2066:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.110     hubertf  2067:     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+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2068:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2069:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2070:     details.</p>
                   2071: <p>A final word of warning: If you set up a system that has a
                   2072:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2073:     set that before any packages are installed, as you cannot use
                   2074:     several directories for the same purpose. Doing so will result in
                   2075:     pkgsrc not being able to properly detect your installed packages,
                   2076:     and fail miserably. Note also that precompiled binary packages are
                   2077:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2078:     <code class="filename">/usr/pkg</code>, and that you should
                   2079:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2080:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2081: </div>
                   2082: </div>
                   2083: </div>
                   2084: <div class="chapter" lang="en">
                   2085: <div class="titlepage"><div><div><h2 class="title">
                   2086: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2087: <div class="toc">
                   2088: <p><b>Table of Contents</b></p>
                   2089: <dl>
                   2090: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2091: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2092: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2093: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2094: <dd><dl>
1.103     wiz      2095: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.122   ! reed     2096: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !          2097: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      2098: </dl></dd>
1.103     wiz      2099: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2100: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2101: </dl>
                   2102: </div>
1.104     rillig   2103: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2104: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2105: that file depends on the installation. On NetBSD, when you use
1.110     hubertf  2106: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2107: <code class="filename">/etc/</code>. In all other cases the default location is
                   2108: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2109: bootstrap program to install the binary packages.</p>
                   2110: <p>During the bootstrap, an example configuration file is created. To
                   2111: use that, you have to create the directory
                   2112: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2113: there.</p>
                   2114: <p>The format of the configuration file is that of the usual
                   2115: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2116: is done by setting variables in this file. Note that you can define all
                   2117: kinds of variables, and no special error checking (for example for
                   2118: spelling mistakes) takes place, so you have to try it out to see if it
                   2119: works.</p>
1.75      rillig   2120: <div class="sect1" lang="en">
                   2121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2122: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2123: <p>In this section, you can find some variables that apply to all
1.89      rillig   2124:     pkgsrc packages. A complete list of the variables that can be
                   2125:     configured by the user is available in
                   2126:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2127:     comments that describe each variable's intent.</p>
1.75      rillig   2128: <div class="itemizedlist"><ul type="disc">
                   2129: <li><p><code class="varname">LOCALBASE</code>: Where
                   2130:            packages will be installed. The default is
1.76      rillig   2131:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2132:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2133: <li><p><code class="varname">CROSSBASE</code>: Where
                   2134:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2135:            installed. The default is
1.76      rillig   2136:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2137: <li><p><code class="varname">X11BASE</code>: Where
                   2138:            X11 is installed on the system. The default is
1.76      rillig   2139:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2140: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2141:            downloaded copies of the original source distributions used
                   2142:            for building pkgsrc packages. The default is
1.76      rillig   2143:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2144: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2145:            database about installed packages is stored.  The default is
                   2146:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2147: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2148:            If set, override the packages'
                   2149:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2150: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2151:            Backup location(s) for distribution files and patch files
                   2152:            if not found locally or in
1.76      rillig   2153:            <code class="filename">${MASTER_SITES}</code> or
                   2154:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2155:            The defaults are
1.76      rillig   2156:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2157:            and
1.76      rillig   2158:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2159: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2160:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2161:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2162:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2163:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2164: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2165:            List of acceptable licenses. Whenever you try to build a package
                   2166:            whose license is not in this list, you will get an error message
                   2167:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2168: </ul></div>
                   2169: </div>
                   2170: <div class="sect1" lang="en">
                   2171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2172: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2173: <p>XXX
                   2174:       </p>
                   2175: <div class="itemizedlist"><ul type="disc">
                   2176: <li><p><code class="varname">PACKAGES</code>: The top level
                   2177:            directory for the binary packages. The default is
1.76      rillig   2178:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2179: <li><p><code class="varname">WRKOBJDIR</code>:
                   2180:            The top level directory where, if defined, the separate
                   2181:            working directories will get created, and symbolically
1.76      rillig   2182:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2183:            This is useful for building packages on several
1.76      rillig   2184:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2185:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2186:            is local to every architecture. (It should be noted that
                   2187:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.114     jmcneill 2188:            &mdash; it is an internal definition which refers to the
1.75      rillig   2189:            root of the pkgsrc tree. It is possible to have many
                   2190:            pkgsrc tree instances.)</p></li>
                   2191: <li><p><code class="varname">LOCALPATCHES</code>:
                   2192:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2193:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2194:            information.</p></li>
1.75      rillig   2195: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2196:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2197:            BSD-style Makefile. If this is not set,
                   2198:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2199:            <code class="filename">/dev/null</code> to avoid picking up
                   2200:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2201: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2202:            By default, dependencies are only installed, and no binary
                   2203:            package is created for them. You can set this variable to
                   2204:            <code class="literal">package</code> to automatically create binary
                   2205:            packages after installing dependencies.</p></li>
1.75      rillig   2206: </ul></div>
                   2207: </div>
                   2208: <div class="sect1" lang="en">
                   2209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2210: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103     wiz      2211: <p>A growing number of packages support installation into a
                   2212:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2213:     to be built, before the actual filesystem is touched. DESTDIR
                   2214:     support exists in two variations:</p>
                   2215: <div class="itemizedlist"><ul type="disc">
                   2216: <li><p>Basic DESTDIR support means that the package
                   2217:       installation and packaging is still run as
                   2218:       root.</p></li>
                   2219: <li><p>Full DESTDIR support can run the complete build,
                   2220:       installation and packaging as normal user. Root privileges are
                   2221:       only needed to add packages.</p></li>
                   2222: </ul></div>
                   2223: <p>To use the DESTDIR support, set either
                   2224:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2225:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2226:     get the full support with fallback to basic
                   2227:     support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
                   2228:     newer). It might become the default DESTDIR support later.</p>
                   2229: <p>DESTDIR support changes the behaviour of various targets
                   2230:     slightly. To install a package after building it, use
                   2231:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2232:     <code class="literal">install</code> don't do that any
                   2233:     longer. <code class="literal">package-install</code> can be used as
                   2234:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2235:     will ask for the root password to install the package and fail,
                   2236:     <code class="literal">package-install</code> will ask again.</p>
                   2237: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2238:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2239: <p>Considering the <code class="filename">foo/bar</code> package,
                   2240:     DESTDIR full support can be tested using the following commands
                   2241: 
                   2242: </p>
                   2243: <pre class="programlisting">
                   2244: <code class="prompt">$</code> id
                   2245: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2246: <code class="prompt">$</code> mkdir $HOME/packages
                   2247: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2248: </pre>
                   2249: <p>
                   2250: 
                   2251:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2252:     should be needed
                   2253: 
                   2254: </p>
                   2255: <pre class="programlisting">
                   2256: <code class="prompt">$</code> make USE_DESTDIR=full install
                   2257: </pre>
                   2258: <p>
                   2259: 
                   2260:     Create a package without root privileges
                   2261: 
                   2262: </p>
                   2263: <pre class="programlisting">
                   2264: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package
                   2265: </pre>
                   2266: <p>
                   2267: 
                   2268:     For the following command, you must be able to gain root
                   2269:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
                   2270: 
                   2271: </p>
                   2272: <pre class="programlisting">
                   2273: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package-install
                   2274: </pre>
                   2275: <p>
                   2276: 
                   2277:     Then, as a simple user
                   2278: 
                   2279: </p>
                   2280: <pre class="programlisting">
                   2281: <code class="prompt">$</code> make clean
                   2282: </pre>
                   2283: <p>
                   2284: 
                   2285:     </p>
1.103     wiz      2286: </div>
                   2287: <div class="sect1" lang="en">
                   2288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2289: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2290: <div class="sect2" lang="en">
                   2291: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2292: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2293: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2294:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2295: <div class="variablelist"><dl>
                   2296: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2297: <dd>
                   2298: <p>This is a list of values specifying the chain of
                   2299:          compilers to invoke when building packages.  Valid values
                   2300:          are:</p>
                   2301: <div class="itemizedlist"><ul type="disc">
                   2302: <li><p><code class="varname">distcc</code>:
                   2303:            distributed C/C++ (chainable)</p></li>
                   2304: <li><p><code class="varname">ccache</code>:
                   2305:            compiler cache (chainable)</p></li>
                   2306: <li><p><code class="varname">gcc</code>:
                   2307:            GNU C/C++ Compiler</p></li>
                   2308: <li><p><code class="varname">mipspro</code>:
                   2309:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2310: <li><p><code class="varname">mipspro</code>:
                   2311:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2312: <li><p><code class="varname">sunpro</code>:
                   2313:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2314: </ul></div>
                   2315: <p>The default is
                   2316:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2317:          <code class="varname">ccache</code> and/or
                   2318:          <code class="varname">distcc</code> with an appropriate
                   2319:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2320:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2321:          variable should always be terminated with a value for
                   2322:          a real compiler.  Note that only one real compiler
                   2323:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2324:          is not allowed).</p>
1.89      rillig   2325: </dd>
                   2326: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2327: <dd><p>This specifies the minimum version of GCC to use
                   2328:          when building packages.  If the system GCC doesn't
                   2329:          satisfy this requirement, then pkgsrc will build and
                   2330:          install one of the GCC packages to use instead.</p></dd>
                   2331: </dl></div>
                   2332: </div>
                   2333: <div class="sect2" lang="en">
                   2334: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2335: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2336: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2337:        please make sure to use the <code class="literal">+=</code> operator
                   2338:        instead of the <code class="literal">=</code> operator:</p>
                   2339: <pre class="programlisting">
1.100     rillig   2340: CFLAGS+=        -your -flags
1.78      rillig   2341: </pre>
                   2342: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117     jnemeth  2343:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that
                   2344:        need to add their own flags.  You may want to take a look
                   2345:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
                   2346:        package if you're interested in optimization for the current
                   2347:        CPU.  Setting <code class="varname">USE_CPUFLAGS</code> to yes in
                   2348:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78      rillig   2349: </div>
1.88      wiz      2350: <div class="sect2" lang="en">
                   2351: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2352: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2353: <p>If you want to pass flags to the linker, both in the configure
                   2354: step and the build step, you can do this in two ways.  Either set
                   2355: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2356: between the two is that <code class="varname">LIBS</code> will be appended to
                   2357: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2358: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2359: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2360: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2361: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2362: settings, use the <code class="literal">+=</code> operator:</p>
                   2363: <pre class="programlisting">
1.100     rillig   2364: LDFLAGS+=        -your -linkerflags
1.88      wiz      2365: </pre>
                   2366: </div>
1.78      rillig   2367: </div>
                   2368: <div class="sect1" lang="en">
                   2369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2370: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2371: <p>XXX
                   2372:       </p>
                   2373: <div class="itemizedlist"><ul type="disc">
                   2374: <li>
                   2375: <p><code class="varname">PKG_DEVELOPER</code>:
                   2376:            Run some sanity checks that package developers want:
                   2377:            </p>
                   2378: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2379: <li><p>make sure patches apply with zero
                   2380:              fuzz</p></li>
                   2381: <li><p>run check-shlibs to see that all
                   2382:              binaries will find their shared libs.</p></li>
1.75      rillig   2383: </ul></div>
                   2384: <p>
1.87      wiz      2385:        </p>
1.75      rillig   2386: </li>
1.88      wiz      2387: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2388:        of debugging output which is displayed whilst making and
                   2389:        installing the package.  The default value for this is 0,
                   2390:        which will not display the commands as they are executed
                   2391:        (normal, default, quiet operation); the value 1 will display
                   2392:        all shell commands before their invocation, and the value 2
                   2393:        will display both the shell commands before their invocation,
1.110     hubertf  2394:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2395:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2396: </ul></div>
                   2397: <p>
                   2398:     </p>
                   2399: </div>
                   2400: <div class="sect1" lang="en">
                   2401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2402: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2403: <p>Some packages have build time options, usually to select
                   2404:     between different dependencies, enable optional support for big
                   2405:     dependencies or enable experimental features.</p>
1.75      rillig   2406: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2407:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2408:     show-options</strong></span>, for example:</p>
1.75      rillig   2409: <pre class="programlisting">
                   2410:     The following options are supported by this package:
                   2411:         ssl      Enable SSL support.
                   2412:     Exactly one of the following gecko options is required:
                   2413:         firefox  Use firefox as gecko rendering engine.
                   2414:         mozilla  Use mozilla as gecko rendering engine.
                   2415:     At most one of the following database options may be selected:
                   2416:         mysql    Enable support for MySQL database.
                   2417:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2418: 
1.75      rillig   2419:     These options are enabled by default: firefox
                   2420:     These options are currently enabled: mozilla ssl
1.1       grant    2421: </pre>
1.75      rillig   2422: <p>The following variables can be defined in
1.110     hubertf  2423:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2424:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2425:     which can be used to select or disable options for all packages
                   2426:     that support them, and
                   2427:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2428:     which can be used to select or disable options specifically for
                   2429:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2430:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2431:     are disabled. A few examples:</p>
1.75      rillig   2432: <pre class="screen">
1.110     hubertf  2433: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2434: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2435: PKG_OPTIONS.kdebase=    debug -sasl
                   2436: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2437: <p>It is important to note that options that were specifically
1.120     snj      2438:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2439:     you do not wish to include the option.  If you are unsure you can view
                   2440:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2441: <p>The following settings are consulted in the order given, and
                   2442:     the last setting that selects or disables an option is
                   2443:     used:</p>
1.75      rillig   2444: <div class="orderedlist"><ol type="1">
                   2445: <li><p>the default options as suggested by the package
1.88      wiz      2446:       maintainer</p></li>
1.75      rillig   2447: <li><p>the options implied by the settings of legacy
1.88      wiz      2448:       variables (see below)</p></li>
1.75      rillig   2449: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2450: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2451: </ol></div>
                   2452: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2453:     selected is used, all others are automatically disabled.  If an
                   2454:     option of the group is explicitly disabled, the previously
                   2455:     selected option, if any, is used.  It is an error if no option
                   2456:     from a required group of options is selected, and building the
                   2457:     package will fail.</p>
                   2458: <p>Before the options framework was introduced, build options
                   2459:     were selected by setting a variable (often named
                   2460:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2461:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2462:     transition to the options framework for the user, these legacy
                   2463:     variables are converted to the appropriate options setting
                   2464:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2465:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2466:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2467:     directly.  Support for the legacy variables will be removed
                   2468:     eventually.</p>
1.75      rillig   2469: </div>
                   2470: </div>
                   2471: <div class="chapter" lang="en">
                   2472: <div class="titlepage"><div><div><h2 class="title">
                   2473: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2474: <div class="toc">
                   2475: <p><b>Table of Contents</b></p>
                   2476: <dl>
                   2477: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2478: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2479: </dl>
                   2480: </div>
                   2481: <div class="sect1" lang="en">
                   2482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2483: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2484: <p>Once you have built and installed a package, you can create
                   2485:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110     hubertf  2486:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2487:     the same package on a group of hosts and wasting CPU time. It also
                   2488:     provides a simple means for others to install your package, should
                   2489:     you distribute it.</p>
                   2490: <p>To create a binary package, change into the appropriate
1.110     hubertf  2491:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2492:     package</strong></span>:</p>
                   2493: <pre class="screen">
                   2494: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2495: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2496:     </pre>
                   2497: <p>This will build and install your package (if not already done),
                   2498:     and then build a binary package from what was installed. You can
1.110     hubertf  2499:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2500:     it. Binary packages are created by default in
                   2501:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2502:     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.91      rillig   2503:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2504: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2505:     such a binary package.</p>
1.75      rillig   2506: </div>
                   2507: <div class="sect1" lang="en">
                   2508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2509: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2510: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2511: </div>
                   2512: </div>
                   2513: <div class="chapter" lang="en">
                   2514: <div class="titlepage"><div><div><h2 class="title">
                   2515: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2516: builds)</h2></div></div></div>
                   2517: <div class="toc">
                   2518: <p><b>Table of Contents</b></p>
                   2519: <dl>
                   2520: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2521: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2522: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2523: <dd><dl>
                   2524: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2525: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2526: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2527: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2528: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2529: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2530: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2531: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2532: </dl></dd>
                   2533: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig   2534: <dd><dl>
                   2535: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2536: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2537: </dl></dd>
1.106     rillig   2538: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2539: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2540: </dl>
                   2541: </div>
                   2542: <p>When you have multiple machines that should run the same packages,
                   2543: it is wasted time if they all build their packages themselves from
                   2544: source. There are two ways of getting a set of binary packages: The old
                   2545: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2546: system. This chapter describes how to set them up so that the packages
                   2547: are most likely to be usable later.</p>
                   2548: <div class="sect1" lang="en">
                   2549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2550: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2551: <p>Since a bulk build takes several days or even weeks to finish, you
                   2552: should think about the setup before you start everything. Pay attention
                   2553: to at least the following points:</p>
                   2554: <div class="itemizedlist"><ul type="disc">
                   2555: <li>
                   2556: <p>If you want to upload the binary packages to
                   2557: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2558: packages:</p>
                   2559: <div class="itemizedlist"><ul type="circle">
                   2560: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2561: by a NetBSD developer on a trusted machine (that is, where you and only
                   2562: you have root access).</p></li>
                   2563: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2564: the stable branches (like 2007Q1), so that users browsing the available
                   2565: collections can see at a glance how old the packages
                   2566: are.</p></li>
                   2567: <li><p>The packages must be built as root, since some packages
                   2568: require set-uid binaries at runtime, and creating those packages as
                   2569: unprivileged user doesn't work well at the moment.</p></li>
                   2570: </ul></div>
                   2571: </li>
                   2572: <li><p>Make sure that the bulk build cannot break anything in
                   2573: your system. Most bulk builds run as root, so they should be run at least
                   2574: in a chroot environment or something even more restrictive, depending on
                   2575: what the operating system provides. There have been numerous cases where
                   2576: certain packages tried to install files outside the
                   2577: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2578: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2579: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2580: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2581: that you don't need any package during the build.</p></li>
                   2582: </ul></div>
                   2583: </div>
                   2584: <div class="sect1" lang="en">
                   2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2586: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2587: <p>A complete bulk build requires lots of disk space. Some of the
                   2588: disk space can be read-only, some other must be writable. Some can be on
                   2589: remote filesystems (such as NFS) and some should be local. Some can be
                   2590: temporary filesystems, others must survive a sudden reboot.</p>
                   2591: <div class="itemizedlist"><ul type="disc">
                   2592: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2593: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2594: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2595: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2596: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2597: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2598: </ul></div>
1.75      rillig   2599: </div>
                   2600: <div class="sect1" lang="en">
                   2601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2602: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116     rillig   2603: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2604: <h3 class="title">Note</h3>
                   2605: <p>There are two ways of doing a bulk build. The old-style
                   2606: one and the new-style &#8220;<span class="quote">pbulk</span>&#8221;. The latter is the recommended
                   2607: way.</p>
1.106     rillig   2608: </div>
1.75      rillig   2609: <div class="sect2" lang="en">
                   2610: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2611: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75      rillig   2612: <div class="sect3" lang="en">
                   2613: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2614: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2615: </h4></div></div></div>
1.76      rillig   2616: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2617:        configuration file for bulk builds. You can configure how your
                   2618:        copy of pkgsrc is kept up to date, how the distfiles are
                   2619:        downloaded, how the packages are built and how the report is
                   2620:        generated. You can find an annotated example file in
                   2621:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2622:        it, copy <code class="filename">build.conf-example</code> to
                   2623:        <code class="filename">build.conf</code> and edit it, following the
                   2624:        comments in that file.</p>
1.75      rillig   2625: </div>
                   2626: <div class="sect3" lang="en">
                   2627: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2628: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104     rillig   2629: </h4></div></div></div>
1.110     hubertf  2630: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2631:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2632:        details of the default settings. You will want to ensure that
                   2633:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2634:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104     rillig   2635:        completely bypasses the license check.</p>
1.87      wiz      2636: <pre class="programlisting">
1.100     rillig   2637: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2638: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2639: BSDSRCDIR=      /usr/src
                   2640: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2641: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2642: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2643: PKG_DEVELOPER?= yes
                   2644: _ACCEPTABLE=    yes
                   2645: </pre>
1.75      rillig   2646: <p>Some options that are especially useful for bulk builds
                   2647:        can be found at the top lines of the file
1.76      rillig   2648:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2649:        options of these are briefly described here.</p>
                   2650: <div class="itemizedlist"><ul type="disc">
                   2651: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2652:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2653:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2654: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2655:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2656:          to the directory where all log files are created. Otherwise the
                   2657:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2658: <li><p>Another important variable is
1.87      wiz      2659:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2660:          should be always available while building other
                   2661:          packages.</p></li>
1.75      rillig   2662: </ul></div>
                   2663: <p>Some other options are scattered in the pkgsrc
                   2664:        infrastructure:</p>
                   2665: <div class="itemizedlist"><ul type="disc">
                   2666: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2667:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2668:          builds is creating binary packages, no matter if they are
                   2669:          vulnerable or not. When uploading the packages to a public
                   2670:          server, the vulnerable packages will be put into a directory of
                   2671:          their own. Leaving this variable unset would prevent the bulk
                   2672:          build system from even trying to build them, so possible
                   2673:          building errors would not show up.</p></li>
1.75      rillig   2674: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2675:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2676:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2677:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2678: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2679:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2680:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2681:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2682:          interpreter.</p></li>
1.91      rillig   2683: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2684:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2685:          package's self-test before installing it. Note that some
                   2686:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2687:          numbers, so you need to assure that the machine on which you
                   2688:          are doing the bulk builds is not completely idle. Otherwise
                   2689:          some test programs will seem to hang, while they are just
                   2690:          waiting for new random data to be
                   2691:          available.</p></li>
1.75      rillig   2692: </ul></div>
                   2693: </div>
                   2694: <div class="sect3" lang="en">
                   2695: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2696: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2697: </h4></div></div></div>
1.75      rillig   2698: <p>It is possible to configure the bulk build to perform
1.87      wiz      2699:        certain site-specific tasks at the end of the pre-build
                   2700:        stage.  If the file
                   2701:        <code class="filename">pre-build.local</code> exists in
                   2702:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110     hubertf  2703:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87      wiz      2704:        stage.  An example use of
                   2705:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2706: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2707:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2708: <p>to prevent the system from trying to build a particular package
1.87      wiz      2709:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2710: </div>
                   2711: </div>
                   2712: <div class="sect2" lang="en">
                   2713: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2714: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2715: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2716:       deleted at the start of bulk builds, make sure your login
                   2717:       shell is placed somewhere else. Either drop it into
                   2718:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2719:       shell in the passwd file), or (re-)install it via
1.110     hubertf  2720:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87      wiz      2721:       you can login after a reboot (remember that your current
                   2722:       process won't die if the package is removed, you just can't
                   2723:       start any new instances of the shell any more).  Also, if you
                   2724:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2725:       version of ssh for some reason, be sure to install ssh before
                   2726:       starting it from <code class="filename">rc.local</code>:</p>
                   2727: <pre class="programlisting">
1.100     rillig   2728: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2729: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2730:   /usr/pkg/etc/rc.d/sshd
                   2731: fi
                   2732: </pre>
1.75      rillig   2733: <p>Not doing so will result in you being not able to log in
1.87      wiz      2734:       via ssh after the bulk build is finished or if the machine
                   2735:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2736: </div>
                   2737: <div class="sect2" lang="en">
                   2738: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2739: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2740: <p>Make sure you don't need any of the packages still
1.87      wiz      2741:       installed.</p>
1.75      rillig   2742: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2743: <h3 class="title">Warning</h3>
1.99      rillig   2744: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2745:        configuration files and some more files from
                   2746:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2747:        possibly other locations will be removed! So don't run a bulk
                   2748:        build with privileges that might harm your
                   2749:        system.</em></span></p>
1.75      rillig   2750: </div>
                   2751: <p>Be sure to remove all other things that might
1.87      wiz      2752:       interfere with builds, like some libs installed in
                   2753:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2754: <pre class="screen">
                   2755: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2756: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2757:       </pre>
1.75      rillig   2758: <p>If for some reason your last build didn't complete (power
1.87      wiz      2759:       failure, system panic, ...), you can continue it by
                   2760:       running:</p>
1.75      rillig   2761: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2762: <p>At the end of the bulk build, you will get a summary via mail,
                   2763:       and find build logs in the directory specified by
                   2764:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2765:       file.</p>
1.75      rillig   2766: </div>
                   2767: <div class="sect2" lang="en">
                   2768: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2769: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2770: <p>The bulk builds consist of three steps:</p>
                   2771: <div class="variablelist"><dl>
                   2772: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2773: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2774:            cleans out any broken distfiles, and removes all
                   2775:            packages installed.</p></dd>
1.75      rillig   2776: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2777: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2778:            an optimised order in which packages will be
                   2779:            built. Packages that don't require other packages will
                   2780:            be built first, and packages with many dependencies will
                   2781:            be built later.</p></dd>
1.75      rillig   2782: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2783: <dd><p>Generates a report that's placed in the directory
                   2784:            specified in the <code class="filename">build.conf</code> file
                   2785:            named <code class="filename">broken.html</code>, a short version
                   2786:            of that report will also be mailed to the build's
                   2787:            admin.</p></dd>
1.75      rillig   2788: </dl></div>
1.87      wiz      2789: <p>During the build, a list of broken packages will be compiled
                   2790:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2791:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2792:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2793:       of broken builds can be found in the package's
                   2794:       directory. These files are used by the bulk-targets to mark
                   2795:       broken builds to not waste time trying to rebuild them, and
                   2796:       they can be used to debug these broken package builds
                   2797:       later.</p>
1.75      rillig   2798: </div>
                   2799: <div class="sect2" lang="en">
                   2800: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2801: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2802: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2803:       NetBSD 2.0/i386:</p>
1.75      rillig   2804: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2805: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2806: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2807: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2808: </ul></div>
                   2809: <p>Note that all pkgs will be de-installed as soon as they are
                   2810:       turned into a binary package, and that sources are removed,
                   2811:       so there is no excessively huge demand to disk
                   2812:       space. Afterwards, if the package is needed again, it will
1.110     hubertf  2813:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87      wiz      2814:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2815: </div>
                   2816: <div class="sect2" lang="en">
                   2817: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2818: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2819: <p>If you don't want all the packages nuked from a machine
                   2820:       (rendering it useless for anything but pkg compiling), there
                   2821:       is the possibility of doing the package bulk build inside a
                   2822:       chroot environment.</p>
                   2823: <p>The first step is to set up a chroot sandbox,
                   2824:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2825:       using null mounts, or manually.</p>
                   2826: <p>There is a shell script called
                   2827:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2828:       up the sandbox environment using null mounts. It will also
                   2829:       create a script called <code class="filename">sandbox</code> in the
                   2830:       root of the sandbox environment, which will allow the null
1.110     hubertf  2831:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2832:       mount</strong></span> command and deactivated using the
1.110     hubertf  2833:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2834: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2835:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2836:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2837:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2838:       are present and properly configured:</p>
1.75      rillig   2839: <div class="procedure"><ol type="1">
                   2840: <li>
                   2841: <p>Kernel</p>
                   2842: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2843: </li>
                   2844: <li>
1.76      rillig   2845: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2846: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2847: </li>
                   2848: <li>
1.91      rillig   2849: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75      rillig   2850: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2851: </li>
                   2852: <li>
                   2853: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2854: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2855: </li>
                   2856: <li>
1.91      rillig   2857: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75      rillig   2858: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2859: </li>
                   2860: <li>
1.76      rillig   2861: <p><code class="filename">/usr/src</code> (system sources,
1.114     jmcneill 2862:          e.&nbsp;g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75      rillig   2863: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2864:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2865: </li>
                   2866: <li>
1.76      rillig   2867: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2869: </li>
                   2870: <li>
1.76      rillig   2871: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2872: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2873: </li>
                   2874: <li>
                   2875: <p>Checkout pkgsrc via cvs into
1.87      wiz      2876:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2877: <pre class="screen">
                   2878: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2879: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2880:          </pre>
1.75      rillig   2881: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2882:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2883: </li>
                   2884: <li><p>Make
1.87      wiz      2885:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2886:          <code class="filename">.../distfiles</code> point somewhere
                   2887:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.122   ! reed     2888: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
1.76      rillig   2889: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2890: </ol></div>
                   2891: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2892:       the build with the following steps:</p>
                   2893: <pre class="screen">
                   2894: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2895: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2896:       </pre>
                   2897: <p>This will just jump inside the sandbox and start building.  At
                   2898:        the end of the build, mail will be sent with the results of
                   2899:        the build. Created binary pkgs will be in
                   2900:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2901:       (wherever that points/mounts to/from).</p>
1.75      rillig   2902: </div>
                   2903: <div class="sect2" lang="en">
                   2904: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2905: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2906: <p>In addition to building a complete set of all packages in
                   2907:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2908:       may be used to build a subset of the packages contained in
                   2909:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2910:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75      rillig   2911: <div class="itemizedlist"><ul type="disc">
                   2912: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2913: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2914: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2915: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2916: </ul></div>
1.87      wiz      2917: <p>will define the set of packages which should be built.
                   2918:       The bulk build code will also include any packages which are
                   2919:       needed as dependencies for the explicitly listed packages.</p>
                   2920: <p>One use of this is to do a bulk build with
                   2921:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2922:       periodically to have a complete set of the binary packages
                   2923:       needed for your site available without the overhead of
                   2924:       building extra packages that are not needed.</p>
1.75      rillig   2925: </div>
                   2926: <div class="sect2" lang="en">
                   2927: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2928: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2929: <p>This section describes how pkgsrc developers can upload binary
                   2930:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2931: <p>If you would like to automatically create checksum files for the
                   2932:       binary packages you intend to upload, remember to set
                   2933:       <code class="varname">MKSUMS=yes</code> in your
                   2934:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2935: <p>If you would like to PGP sign the checksum files (highly
                   2936:       recommended!), remember to set
                   2937:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2938:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2939:       your GPG password to sign the files before uploading everything.</p>
                   2940: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2941:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2942:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2943: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2944: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2945:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2946:       is different from your local login, write your login directly
                   2947:       into the variable, e.g. my local account is "feyrer", but for my
                   2948:       login "hubertf", I use:</p>
1.93      rillig   2949: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2950: <p>A separate <code class="filename">upload</code> directory is used
                   2951:       here to allow "closing" the directory during upload. To do
                   2952:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2953: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87      wiz      2954: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2955:       only appropriate for packages for the NetBSD operating
                   2956:       system. Binary packages for other operating systems should go
                   2957:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2958: <p>Before uploading the binary pkgs, ssh authentication needs
                   2959:       to be set up. This example shows how to set up temporary keys
                   2960:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2961:       (assuming that no keys should be present there usually):</p>
                   2962: <pre class="screen">
                   2963: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2964: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2965: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2966: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2967:       </pre>
                   2968: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2969:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2970:       file on ftp.NetBSD.org. You can remove the key after the
                   2971:       upload is done!</p>
                   2972: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2973: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2974: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2975: <p>Now after all this works, you can exit the sandbox and start
                   2976:       the upload:</p>
                   2977: <pre class="screen">
                   2978: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   2979: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      2980: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2981:       </pre>
1.110     hubertf  2982: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2983:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87      wiz      2984:       upload. The upload script will take care of not uploading
                   2985:       restricted packages and putting vulnerable packages into the
                   2986:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2987: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   2988: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      2989:       Gdd:x! </pre>
                   2990: <p>Use whatever is needed to remove the key you've entered
                   2991:       before! Last, move the uploaded packages out of the
                   2992:       <code class="filename">upload</code> directory to have them accessible
                   2993:       to everyone:</p>
                   2994: <pre class="screen">
1.93      rillig   2995: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   2996: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2997: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      2998: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2999:       </pre>
1.75      rillig   3000: </div>
                   3001: </div>
                   3002: <div class="sect1" lang="en">
                   3003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3004: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   3005: <p>Running a pbulk-style bulk build works roughly as follows:</p>
                   3006: <div class="itemizedlist"><ul type="disc">
                   3007: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   3008: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
                   3009: </ul></div>
                   3010: <div class="sect2" lang="en">
                   3011: <div class="titlepage"><div><div><h3 class="title">
                   3012: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117     jnemeth  3013: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
1.116     rillig   3014: <pre class="screen">
                   3015: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3016: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   3017: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   3018: </pre>
                   3019: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
                   3020: <div class="itemizedlist"><ul type="disc">
                   3021: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3022: <li><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
                   3023: <li><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
                   3024: <li><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
                   3025: <li><p><code class="literal"><code class="varname">_ACCEPTABLE</code>=yes</code>, to accept all licenses, no matter how restrictive they are.</p></li>
                   3026: </ul></div>
                   3027: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3028: <pre class="screen">
                   3029: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3030: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3031: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3032: </pre>
                   3033: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
                   3034: </div>
1.106     rillig   3035: <div class="sect2" lang="en">
                   3036: <div class="titlepage"><div><div><h3 class="title">
1.116     rillig   3037: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114     jmcneill 3038: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116     rillig   3039: <p>TODO: continue writing</p>
1.106     rillig   3040: </div>
                   3041: </div>
                   3042: <div class="sect1" lang="en">
                   3043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3044: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3045: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3046:     create a CD-ROM set of the resulting binary packages to assist
                   3047:     in installing packages on other machines.  The
1.91      rillig   3048:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      3049:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  3050:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      3051:     way that keeps all the dependencies for a given package on the same
                   3052:     CD as that package.</p>
1.75      rillig   3053: <div class="sect2" lang="en">
                   3054: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3055: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3056: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3057:       man page. The following short example assumes that the binary
                   3058:       packages are left in
                   3059:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3060:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3061:       hold the ISO 9660 images.</p>
                   3062: <pre class="screen">
                   3063: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3064: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3065: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3066:       </pre>
                   3067: <p>If you wish to include a common set of files
                   3068:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3069:       etc.) on each CD in the collection, then you need to create a
                   3070:       directory which contains these files. e.g.</p>
                   3071: <pre class="screen">
                   3072: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3073: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3074: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3075: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3076: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3077: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3078: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3079:       </pre>
1.75      rillig   3080: <p>Now create the images:</p>
                   3081: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   3082: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3083:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3084:       in their root directories.</p>
1.75      rillig   3085: </div>
                   3086: </div>
                   3087: </div>
                   3088: <div class="chapter" lang="en">
                   3089: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3090: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3091: <div class="toc">
                   3092: <p><b>Table of Contents</b></p>
                   3093: <dl>
1.122   ! reed     3094: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
        !          3095: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   3096: </dl>
                   3097: </div>
                   3098: <p>The files that are installed by pkgsrc are organized in a way that
                   3099: is similar to what you find in the <code class="filename">/usr</code> directory
                   3100: of the base system. But some details are different. This is because
                   3101: pkgsrc initially came from FreeBSD and had adopted its file system
                   3102: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3103: which operating system you are using pkgsrc with, you can expect the
                   3104: same layout for pkgsrc.</p>
1.91      rillig   3105: <p>There are mainly four root directories for pkgsrc, which are all
                   3106: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3107: When pkgsrc has been installed as root, the default locations
                   3108: are:</p>
                   3109: <pre class="programlisting">
1.100     rillig   3110: LOCALBASE=              /usr/pkg
                   3111: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3112: VARBASE=                /var
                   3113: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3114: </pre>
                   3115: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3116: user), the default locations are:</p>
                   3117: <pre class="programlisting">
1.100     rillig   3118: LOCALBASE=              ${HOME}/pkg
                   3119: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3120: VARBASE=                ${HOME}/pkg/var
                   3121: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3122: </pre>
                   3123: <p>What these four directories are for, and what they look like is
                   3124: explained below.</p>
1.90      rillig   3125: <div class="itemizedlist"><ul type="disc">
                   3126: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3127: <code class="filename">/usr</code> directory in the base system. It is the
                   3128: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3129: the well-known subdirectories like <code class="filename">bin</code>,
                   3130: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3131: <code class="filename">share</code> and
                   3132: <code class="filename">sbin</code>.</p></li>
                   3133: <li><p><code class="varname">VARBASE</code> corresponds to
                   3134: <code class="filename">/var</code> in the base system. Some programs (especially
                   3135: games, network daemons) need write access to it during normal
                   3136: operation.</p></li>
                   3137: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3138: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3139: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   3140: itself.</p></li>
                   3141: </ul></div>
                   3142: <div class="sect1" lang="en">
                   3143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3144: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3145: </h2></div></div></div>
1.90      rillig   3146: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3147: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3148: <div class="variablelist"><dl>
                   3149: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3150: <dd><p>Contains executable programs that are intended to be
                   3151: directly used by the end user.</p></dd>
                   3152: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3153: <dd><p>Contains files for the emulation layers of various other
                   3154: operating systems, especially for
                   3155: NetBSD.</p></dd>
                   3156: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3157: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3158: <dd><p>Contains
                   3159: the configuration files.</p></dd>
                   3160: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3161: <dd><p>Contains headers for the C and C++ programming
                   3162: languages.</p></dd>
                   3163: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3164: <dd><p>Contains GNU info files of various
                   3165: packages.</p></dd>
                   3166: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3167: <dd><p>Contains shared and static
                   3168: libraries.</p></dd>
                   3169: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3170: <dd><p>Contains data files that don't change after
                   3171: installation. Other data files belong into
                   3172: <code class="filename">${VARBASE}</code>.</p></dd>
                   3173: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3174: <dd><p>Contains programs that are not intended to be used by
                   3175: end users, such as helper programs or network
                   3176: daemons.</p></dd>
                   3177: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3178: <dd><p>Contains programs that are intended to be executed as
                   3179: CGI scripts by a web server.</p></dd>
                   3180: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3181: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3182: <dd><p>Contains brief
                   3183: documentation in form of manual pages.</p></dd>
                   3184: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3185: <dd><p>Contains programs that are intended to be used only by
                   3186: the super-user.</p></dd>
                   3187: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3188: <dd><p>Contains platform-independent data files that don't
                   3189: change after installation.</p></dd>
                   3190: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3191: <dd><p>Contains documentation files provided by the
                   3192: packages.</p></dd>
                   3193: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3194: <dd><p>Contains example files provided by the packages. Among
                   3195: others, the original configuration files are saved here and copied to
                   3196: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3197: installation.</p></dd>
                   3198: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3199: <dd><p>Contains the original files for rc.d
                   3200: scripts.</p></dd>
                   3201: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3202: <code class="filename">${VARBASE}</code>)</span></dt>
                   3203: <dd><p>Contains files
                   3204: that may be modified after
                   3205: installation.</p></dd>
                   3206: </dl></div>
                   3207: </div>
                   3208: <div class="sect1" lang="en">
                   3209: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3210: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3211: </h2></div></div></div>
1.90      rillig   3212: <div class="variablelist"><dl>
                   3213: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3214: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3215: <dd><p>Contains
                   3216: information about the currently installed
                   3217: packages.</p></dd>
                   3218: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3219: <dd><p>Contains highscore
                   3220: files.</p></dd>
                   3221: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3222: <dd><p>Contains log files.</p></dd>
                   3223: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3224: <dd><p>Contains informational files about daemons that are
                   3225: currently running.</p></dd>
                   3226: </dl></div>
                   3227: </div>
                   3228: </div>
                   3229: <div class="chapter" lang="en">
                   3230: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3231: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3232: <div class="toc">
                   3233: <p><b>Table of Contents</b></p>
                   3234: <dl>
1.106     rillig   3235: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3236: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3237: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3238: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3239: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3240: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   3241: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.122   ! reed     3242: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig   3243: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.122   ! reed     3244: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
        !          3245: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
        !          3246: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
1.106     rillig   3247: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3249: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.122   ! reed     3250: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.106     rillig   3251: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.122   ! reed     3252: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig   3253: </dl>
                   3254: </div>
                   3255: <p>This section contains hints, tips &amp; tricks on special things in
                   3256: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3257: it contains items for both pkgsrc users and developers.</p>
                   3258: <div class="sect1" lang="en">
                   3259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3260: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3261: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3262: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  3263: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3264:          This is a general purpose list for most issues regarding
                   3265:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3266:          for pkgsrc configuration, unexpected build failures, using
                   3267:          particular packages, upgrading pkgsrc installations,
                   3268:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3269:          proposals for changes that impact the pkgsrc user community,
                   3270:          e.g. major infrastructure changes, new features, package
                   3271:          removals, etc., may also be posted.</p></li>
1.110     hubertf  3272: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3273:          A list where the results of pkgsrc bulk builds are sent and
                   3274:          discussed.</p></li>
1.110     hubertf  3275: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3276:          This list is for those who are interested in getting a
                   3277:          commit message for every change committed to pkgsrc. It is
                   3278:          also available in digest form, meaning one daily message
                   3279:          containing all commit messages for changes to the package
                   3280:          source tree in that 24 hour period.</p></li>
                   3281: </ul></div>
                   3282: <p>To subscribe, do:</p>
                   3283: <pre class="programlisting">
1.100     rillig   3284: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3285: </pre>
                   3286: <p>Archives for all these mailing lists are available from
1.110     hubertf  3287: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3288: </div>
                   3289: <div class="sect1" lang="en">
                   3290: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3291: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3292: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3293: pkgviews User's guide in
1.76      rillig   3294: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3295: </div>
                   3296: <div class="sect1" lang="en">
                   3297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3298: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3299: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3300: a number of useful utilities for both users and developers of pkgsrc.  This
                   3301: section attempts only to make the reader aware of the utilities and when
                   3302: they might be useful, and not to duplicate the documentation that comes
                   3303: with each package.</p>
                   3304: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3305: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   3306:       Symlinks for use by buildlink.</p></li></ul></div>
                   3307: <p>OS tool augmentation (automatically installed when needed):</p>
                   3308: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3309: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3310:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3311: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   3312:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3313: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      3314:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3315: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   3316:       Up-to-date replacement for
1.76      rillig   3317:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3318:       systems where pkg_install is not present.</p></li>
                   3319: </ul></div>
                   3320: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3321: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3322: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3323:       Create a binary package from an
1.110     hubertf  3324:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3325:       save the old package.</p></li>
1.91      rillig   3326: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   3327:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3328:       from multiple locations. It currently supports the following
                   3329:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3330: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75      rillig   3331:       packages someplace else (enabled by default).</p></li>
1.117     jnemeth  3332: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
                   3333:       the best compiler flags to optimise code for your current
                   3334:       CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
                   3335:       yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
                   3336:       cpuflags. </p></li>
1.75      rillig   3337: </ul></div>
                   3338: <p>Utilities for keeping track of installed packages, being up to date,
                   3339: etc:</p>
                   3340: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3341: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3342:       packages whose installed versions do not match the latest pkgsrc
                   3343:       entries.</p></li>
1.91      rillig   3344: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   3345:       dependency graphs of packages, to aid in choosing a strategy for
                   3346:       updating.</p></li>
1.91      rillig   3347: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   3348:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   3349: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   3350:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3351: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   3352:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3353: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   3354:       packages you have installed.</p></li>
                   3355: </ul></div>
                   3356: <p>Utilities for people maintaining or creating individual packages:</p>
                   3357: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3358: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3359:       making and maintaining patches for a package (includes pkgdiff,
                   3360:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3361: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
                   3362:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   3363:       converting to pkgsrc.</p></li>
1.91      rillig   3364: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75      rillig   3365:       pkgsrc to a Solaris package.</p></li>
                   3366: </ul></div>
                   3367: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3368: utilities)</p>
                   3369: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3370: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3371:       packages in a chrooted area.</p></li>
1.91      rillig   3372: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3373:       kernel version for chrooted cross builds.</p></li>
                   3374: </ul></div>
                   3375: </div>
                   3376: <div class="sect1" lang="en">
                   3377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3378: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3379: <p>If you want to use pkgsrc as non-root user, you can set some
                   3380: variables to make pkgsrc work under these conditions.  At the very least,
                   3381: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3382: will turn on unprivileged mode and set multiple related variables to allow
                   3383: installation of packages as non-root.</p>
                   3384: <p>In case the defaults are not enough, you may want to tune some other
                   3385: variables used.  For example, if the automatic user/group detection leads
                   3386: to incorrect values (or not the ones you would like to use), you can change
                   3387: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3388: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3389: <p>As regards bootstrapping, please note that the
1.110     hubertf  3390: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75      rillig   3391: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3392: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3393: installation targets.  These directories can be overridden by the
1.75      rillig   3394: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3395: that allow finer tuning of the tree layout.</p>
                   3396: </div>
                   3397: <div class="sect1" lang="en">
                   3398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3399: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3400: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3401: enable this feature by adding the option
                   3402: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3403: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3404: distfile is found, pkgsrc will try to resume it.</p>
                   3405: <p>You can also
1.110     hubertf  3406: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.117     jnemeth  3407: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3408: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3409: by using the value manual.  A value of custom disables the system defaults
                   3410: and dependency tracking for the fetch program.  In that case you have to
                   3411: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3412: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3413: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3414: <p>For example, if you want to use
1.117     jnemeth  3415: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3416: like:</p>
                   3417: <pre class="programlisting">
1.117     jnemeth  3418: FETCH_USING=   wget
1.1       grant    3419: </pre>
1.75      rillig   3420: </div>
                   3421: <div class="sect1" lang="en">
                   3422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3423: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3424: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3425: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3426: you will have to add the following line into
1.110     hubertf  3427: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3428: <pre class="programlisting">
1.103     wiz      3429: X11_TYPE=modular
1.1       grant    3430: </pre>
1.75      rillig   3431: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3432: <h3 class="title">Note</h3>
1.103     wiz      3433: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3434: </p>
1.75      rillig   3435: </div>
                   3436: </div>
                   3437: <div class="sect1" lang="en">
                   3438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3439: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3440: <p>If you are sitting behind a firewall which does not allow direct
                   3441: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3442: relevant proxy hosts.  This is done using an environment variable in the
                   3443: form of a URL, e.g. in Amdahl, the machine
                   3444: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3445: port 80 as the proxy port number.  So the proxy environment variables
                   3446: are:</p>
                   3447: <pre class="programlisting">
1.100     rillig   3448: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3449: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3450: </pre>
1.75      rillig   3451: </div>
                   3452: <div class="sect1" lang="en">
                   3453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  3454: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3455: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3456: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3457: the first available command from the following list:</p>
                   3458: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3459: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3460: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3461: </ul></div>
                   3462: <p>On a default NetBSD installation, this will be
1.76      rillig   3463: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3464: connections first, and falls back to active connections if the server
                   3465: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3466: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3467: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3468: <p>Having that option present will prevent
1.76      rillig   3469: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3470: transfers.</p>
                   3471: </div>
                   3472: <div class="sect1" lang="en">
                   3473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3474: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3475: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3476: from work or university, where you can't run a <span class="command"><strong>make
                   3477: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3478: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3479: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3480: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3481: resulting list to your machine at work/school and use it there.  If you
1.110     hubertf  3482: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3483: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3484: URL:</p>
                   3485: <p>At home:</p>
                   3486: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3487: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3488: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3489: <p>At work:</p>
                   3490: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3491: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3492: home.</p>
                   3493: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3494: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3495: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3496: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3497: directly by running:</p>
1.75      rillig   3498: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3499: <p>If you even decide to ignore
                   3500: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3501: by running:</p>
                   3502: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3503: </div>
                   3504: <div class="sect1" lang="en">
                   3505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3506: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3507: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3508: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3509: package, you get the error from make that it doesn't know how to make
1.76      rillig   3510: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3511: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3512: the NetBSD base distribution on your machine.  It is recommended to do
                   3513: that to format man pages.</p>
1.91      rillig   3514: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3515: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3516: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3517: </div>
                   3518: <div class="sect1" lang="en">
                   3519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3520: <a name="bsd.own.mk-missing"></a>9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3521: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3522: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3523: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3524: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3525: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3526: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3527: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3528: -r</strong></span>).</p>
                   3529: </div>
                   3530: <div class="sect1" lang="en">
                   3531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3532: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3533: <p>When installing packages as non-root user and using the just-in-time
1.110     hubertf  3534: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3535: password for each required package installed.  To avoid this, the sudo
                   3536: package can be used, which does password caching over a limited time.  To
                   3537: use it, install sudo (either as binary package or from
1.98      wiz      3538: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3539: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3540: <span class="emphasis"><em>after</em></span> the definition of the
                   3541: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3542: <pre class="programlisting">
1.100     rillig   3543: .if exists(${LOCALBASE}/bin/sudo)
                   3544: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3545: .endif
1.1       grant    3546: </pre>
1.75      rillig   3547: </div>
                   3548: <div class="sect1" lang="en">
                   3549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3550: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3551: <p>As the system administrator, you can choose where configuration files
                   3552: are installed.  The default settings make all these files go into
1.76      rillig   3553: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3554: be suboptimal depending on your expectations (e.g., a read-only,
                   3555: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3556: configuration of the provided packages).</p>
                   3557: <p>In order to change the defaults, you can modify the
                   3558: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3559: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3560: directory; some common examples include <code class="filename">/etc</code> or
                   3561: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3562: <p>Furthermore, you can change this value on a per-package basis by
                   3563: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3564: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3565: package you would like to modify, that is, the contents of
                   3566: <code class="varname">PKGBASE</code>.</p>
                   3567: <p>Note that after changing these settings, you must rebuild and
                   3568: reinstall any affected packages.</p>
                   3569: </div>
                   3570: <div class="sect1" lang="en">
                   3571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3572: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3573: <p>Please be aware that there can often be bugs in third-party software,
                   3574: and some of these bugs can leave a machine vulnerable to exploitation by
                   3575: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3576: maintains a database of known-exploits to packages which have at one time
                   3577: been included in pkgsrc.  The database can be downloaded automatically, and
                   3578: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3579: do this, refer to the following two tools (installed as part of the
                   3580: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.75      rillig   3581: <div class="orderedlist"><ol type="1">
                   3582: <li>
1.122   ! reed     3583: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3584:     download a list of the security vulnerabilities information.  This list
                   3585:     is kept up to date by the NetBSD security officer and the NetBSD
                   3586:     packages team, and is distributed from the NetBSD ftp server:</p>
1.110     hubertf  3587: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3588: </li>
1.122   ! reed     3589: <li><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
1.75      rillig   3590:     current machine, checking each vulnerability which is known.  If a
                   3591:     vulnerable package is installed, it will be shown by output to stdout,
                   3592:     including a description of the type of vulnerability, and a URL
                   3593:     containing more information.</p></li>
                   3594: </ol></div>
1.114     jmcneill 3595: <p>Use of these tools is strongly recommended!  After
                   3596: &#8220;<span class="quote">pkg_install</span>&#8221; is installed, please read
1.75      rillig   3597: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3598: pkg_install</code></strong>.</p>
1.87      wiz      3599: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3600: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.87      wiz      3601: check.</p>
1.75      rillig   3602: </div>
                   3603: <div class="sect1" lang="en">
                   3604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3605: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3606: <p>When you add your own preferences to the
                   3607:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3608:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3609:        environment variables to the <code class="filename">./configure</code>
1.110     hubertf  3610:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3611:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3612:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3613:        package.</p>
                   3614: <p>Currently there is no solution to this problem. If you
                   3615:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3616:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3617:        directory and then inspect any <code class="filename">Makefile</code> and
                   3618:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3619:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3620:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3621:        programmers write so bad code that it only works for the
                   3622:        specific combination of <code class="varname">CFLAGS</code> they have
                   3623:        chosen.</p>
                   3624: </div>
1.80      rillig   3625: <div class="sect1" lang="en">
                   3626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3627: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3628: <div class="procedure"><ol type="1">
                   3629: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3630:        case that occurs often is that people only update pkgsrc in
                   3631:        parts, because of performance reasons. Since pkgsrc is one large
                   3632:        system, not a collection of many small systems, there are
                   3633:        sometimes changes that only work when the whole pkgsrc tree is
                   3634:        updated.</p></li>
                   3635: <li><p>Make sure that you don't have any CVS conflicts.
                   3636:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3637:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3638:        files.</p></li>
                   3639: <li><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3640:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3641:        verify this.</p></li>
                   3642: <li><p>If the problem still exists, write a mail to the
                   3643:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3644: </ol></div>
                   3645: </div>
1.88      wiz      3646: <div class="sect1" lang="en">
                   3647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3648: <a name="faq.rcs-conflicts"></a>9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.89      rillig   3649: <p>You have modified a file from pkgsrc, and someone else has
                   3650: modified that same file afterwards in the CVS repository. Both changes
                   3651: are in the same region of the file, so when you updated pkgsrc, the
                   3652: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3653: file. Because of these markers, the file is no longer a valid
                   3654: <code class="filename">Makefile</code>.</p>
                   3655: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3656: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3657: -dP</strong></span> in that directory to download the current version.</p>
                   3658: </div>
1.75      rillig   3659: </div>
                   3660: </div>
                   3661: <div class="part" lang="en">
                   3662: <div class="titlepage"><div><div><h1 class="title">
                   3663: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3664: <div class="partintro" lang="en">
                   3665: <div></div>
                   3666: <p>This part of the book deals with creating and
                   3667:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3668:        guide on creating a new package. The remaining chapters are more
                   3669:        like a reference manual for pkgsrc.</p>
1.75      rillig   3670: <div class="toc">
                   3671: <p><b>Table of Contents</b></p>
                   3672: <dl>
1.106     rillig   3673: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3674: <dd><dl>
1.106     rillig   3675: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3676: <dd><dl>
1.106     rillig   3677: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3678: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3679: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3680: </dl></dd>
1.106     rillig   3681: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3682: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3683: </dl></dd>
                   3684: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3685: <dd><dl>
1.122   ! reed     3686: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
        !          3687: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   3688: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3689: <dd><dl>
                   3690: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3691: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3692: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3693: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3694: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3695: </dl></dd>
                   3696: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3697: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3698: <dd><dl>
                   3699: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3700: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3701: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3702: </dl></dd>
1.122   ! reed     3703: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
        !          3704: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3705: </dl></dd>
1.122   ! reed     3706: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3707: <dd><dl>
                   3708: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.122   ! reed     3709: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   3710: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3711: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3712: <dd><dl>
                   3713: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3714: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3715: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3716: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3717: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3718: </dl></dd>
                   3719: </dl></dd>
                   3720: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3721: <dd><dl>
                   3722: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.122   ! reed     3723: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
        !          3724: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   3725: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3726: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.122   ! reed     3727: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   3728: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3729: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3730: </dl></dd>
                   3731: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3732: <dd><dl>
                   3733: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.122   ! reed     3734: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3735: <dd><dl>
                   3736: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.122   ! reed     3737: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3738: </dl></dd>
1.122   ! reed     3739: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   3740: <dd><dl>
1.122   ! reed     3741: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   3742: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3743: </dl></dd>
                   3744: </dl></dd>
                   3745: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3746: <dd><dl>
                   3747: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3748: <dd><dl>
                   3749: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3750: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3751: </dl></dd>
                   3752: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3753: <dd><dl>
1.122   ! reed     3754: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   3755: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3756: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3757: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3758: </dl></dd>
                   3759: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3760: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3761: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3762: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3763: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3764: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3765: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3766: </dl></dd>
                   3767: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3768: <dd><dl>
                   3769: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.122   ! reed     3770: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   3771: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3772: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3773: </dl></dd>
                   3774: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3775: <dd><dl>
                   3776: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3779: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.122   ! reed     3780: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3781: <dd><dl>
                   3782: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3783: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3784: </dl></dd>
1.122   ! reed     3785: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
        !          3786: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
        !          3787: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
        !          3788: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
        !          3789: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
        !          3790: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
        !          3791: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
        !          3792: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
        !          3793: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
        !          3794: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   3795: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3796: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3797: </dl></dd>
                   3798: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3799: <dd><dl>
                   3800: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3801: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3803: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3804: </dl></dd>
                   3805: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3806: <dd><dl>
                   3807: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3808: <dd><dl>
                   3809: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.122   ! reed     3810: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig   3811: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3813: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3814: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3815: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3816: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3817: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3818: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3819: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3820: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3821: </dl></dd>
1.122   ! reed     3822: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3823: <dd><dl>
                   3824: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3825: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3826: </dl></dd>
1.122   ! reed     3827: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   3828: <dd><dl>
                   3829: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3831: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3832: </dl></dd>
                   3833: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3834: <dd><dl>
                   3835: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3836: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3837: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3838: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3839: </dl></dd>
1.122   ! reed     3840: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   3841: <dd><dl>
                   3842: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3843: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.122   ! reed     3844: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
1.106     rillig   3845: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3846: </dl></dd>
1.122   ! reed     3847: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   3848: <dd><dl>
                   3849: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3850: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3851: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3855: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3856: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3857: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   3858: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3859: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3860: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3861: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3862: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3866: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3867:     emulation</a></span></dt>
1.106     rillig   3868: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3870: </dl></dd>
1.106     rillig   3871: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3872: </dl></dd>
1.106     rillig   3873: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3874: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3875: <dd><dl>
1.106     rillig   3876: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3877: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3878: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3879: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3880: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122   ! reed     3881: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
        !          3882: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   3883: </dl></dd>
                   3884: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3885: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3886: <dd><dl>
                   3887: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3888: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3889: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3890: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3891: </dl></dd>
1.75      rillig   3892: </dl>
                   3893: </div>
1.77      rillig   3894: </div>
                   3895: <div class="chapter" lang="en">
                   3896: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3897: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3898: <div class="toc">
                   3899: <p><b>Table of Contents</b></p>
                   3900: <dl>
1.106     rillig   3901: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3902: <dd><dl>
1.106     rillig   3903: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3904: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3905: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3906: </dl></dd>
1.106     rillig   3907: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3908: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3909: </dl>
                   3910: </div>
1.77      rillig   3911: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3912: most likely have a URL from where you can download the source
                   3913: code. Starting with this URL, creating a package involves only a
                   3914: few steps.</p>
1.77      rillig   3915: <div class="procedure"><ol type="1">
1.91      rillig   3916: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77      rillig   3917: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3918: category in which you want to place your package. You can also create a
                   3919: directory of your own (maybe called <code class="filename">local</code>). In that
                   3920: category directory, create another directory for your package and change
                   3921: into it.</p></li>
1.110     hubertf  3922: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3923: you for a URL. Enter the URL of the distribution file (in most cases a
                   3924: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3925: of your package are created automatically. The distribution file is
                   3926: extracted automatically to fill in some details in the
                   3927: <code class="filename">Makefile</code> that would otherwise have to be done
                   3928: manually.</p></li>
                   3929: <li>
                   3930: <p>Examine the extracted files to determine the dependencies of
                   3931: your package. Ideally, this is mentioned in some
                   3932: <code class="filename">README</code> file, but things may differ. For each of
                   3933: these dependencies, look where it exists in pkgsrc, and if there is a
                   3934: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3935: line to your package <code class="filename">Makefile</code> which includes that
                   3936: file just before the last line. If the
                   3937: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3938: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3939: version of the dependency and where it can be found in pkgsrc. This line
                   3940: should be placed in the third paragraph. If the dependency is only
                   3941: needed for building the package, but not when using it, use
                   3942: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3943: Your package may then look like this:</p>
1.77      rillig   3944: <pre class="programlisting">
1.100     rillig   3945: [...]
1.77      rillig   3946: 
1.100     rillig   3947: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3948: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3949: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3950: 
1.100     rillig   3951: [...]
1.77      rillig   3952: 
1.100     rillig   3953: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3954: .include "../../devel/glib2/buildlink3.mk"
                   3955: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3956: </pre>
                   3957: </li>
1.110     hubertf  3958: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91      rillig   3959: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.110     hubertf  3960: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3961: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3962: -e</strong></span>, which outputs additional
                   3963: explanations.</p></li>
                   3964: <li><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3965: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3966: over there, you can hopefully continue here.</p></li>
1.110     hubertf  3967: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3968: directory from the extracted files. Besides these files, a lot of cache
                   3969: files and other system information has been saved in the working
                   3970: directory, which may become wrong after you edited the
                   3971: <code class="filename">Makefile</code>.</p></li>
1.110     hubertf  3972: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3973: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.91      rillig   3974: <li><p>When the package builds fine, the next step is to install
1.110     hubertf  3975: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3976: everything works.</p></li>
                   3977: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3978: contains a list of the files that are installed by the package, is
1.110     hubertf  3979: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3980: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3981: the file using your preferred text editor to see if the list of
                   3982: files looks plausible.</p></li>
1.110     hubertf  3983: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3984: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110     hubertf  3985: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3986: has been registered in the database of installed files, but with an
1.110     hubertf  3987: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3988: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3989: registered with the list of files from
                   3990: <code class="filename">PLIST</code>.</p></li>
1.110     hubertf  3991: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3992: package from the set of installed files.</p></li>
1.77      rillig   3993: </ol></div>
1.91      rillig   3994: <div class="sect1" lang="en">
                   3995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3996: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91      rillig   3997: <div class="sect2" lang="en">
                   3998: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3999: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   4000: <p>Simple Perl modules are handled automatically by
1.110     hubertf  4001: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   4002: </div>
                   4003: <div class="sect2" lang="en">
                   4004: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4005: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   4006: <p>KDE applications should always include
                   4007: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4008: settings that are typical of KDE packages.</p>
                   4009: </div>
1.118     imil     4010: <div class="sect2" lang="en">
                   4011: <div class="titlepage"><div><div><h3 class="title">
                   4012: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   4013: <p>Python modules and programs packages are easily created using a
                   4014: set of predefined variables.</p>
                   4015: <p>Most Python packages use either &#8220;<span class="quote">distutils</span>&#8221; or
                   4016: easy-setup (&#8220;<span class="quote">eggs</span>&#8221;).
                   4017: If the software uses &#8220;<span class="quote">distutils</span>&#8221;, set the
                   4018: <code class="varname">PYDISTUTILSPKG</code> variable to &#8220;<span class="quote">yes</span>&#8221; so
                   4019: pkgsrc will make use of this framework.
                   4020: &#8220;<span class="quote">distutils</span>&#8221; uses a script called <code class="filename">setup.py</code>,
                   4021: if the &#8220;<span class="quote">distutils</span>&#8221; driver is not called
                   4022: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   4023: to the name of the script.</p>
                   4024: <p>
                   4025: If the default Python versions are not supported by the software, set the
                   4026: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   4027: the software is known to work with, from the most recent to the older
                   4028: one, e.g.
                   4029: </p>
                   4030: <pre class="programlisting">
                   4031: PYTHON_VERSIONS_ACCEPTED=       25 24 23
                   4032: </pre>
                   4033: <p>
                   4034: If the packaged software is a Python module, include
                   4035: &#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;.
                   4036: In this case, the package directory should be called
                   4037: &#8220;<span class="quote">py-software</span>&#8221; and <code class="varname">PKGNAME</code> should be set to
                   4038: &#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;, e.g.
                   4039: </p>
                   4040: <pre class="programlisting">
                   4041: DISTNAME=   foopymodule-1.2.10
                   4042: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   4043: </pre>
                   4044: <p>If it is an application, also include
                   4045: &#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;
                   4046: before &#8220;<span class="quote">extension.mk</span>&#8221;.</p>
                   4047: <p>If the packaged software, either it is an application or a module, is
                   4048: egg-aware, you only need to include
                   4049: &#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;.</p>
                   4050: <p>In order to correctly set the path to the Python interpreter, use the
                   4051: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   4052: that must be corrected. For example :
                   4053: </p>
                   4054: <pre class="programlisting">
                   4055: REPLACE_PYTHON=   ${WRKSRC}/*.py
                   4056: </pre>
                   4057: </div>
1.91      rillig   4058: </div>
                   4059: <div class="sect1" lang="en">
                   4060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4061: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91      rillig   4062: <div class="sect2" lang="en">
                   4063: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4064: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91      rillig   4065: <div class="sect3" lang="en">
                   4066: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4067: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   4068: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4069: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4070: pkgsrc. As the description says it has to do with the web, the obvious
                   4071: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4072: <pre class="programlisting">
1.100     rillig   4073: <code class="prompt">$</code> mkdir www/nvu
                   4074: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4075: </pre>
                   4076: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  4077: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   4078: <pre class="programlisting">
1.100     rillig   4079: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4080: </pre>
                   4081: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4082: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4083: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4084: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4085: <code class="varname">COMMENT</code> fields. Then the package
                   4086: <code class="filename">Makefile</code> looked like that:</p>
                   4087: <pre class="programlisting">
1.100     rillig   4088: # $NetBSD$
                   4089: #
1.91      rillig   4090: 
1.100     rillig   4091: DISTNAME=       nvu-1.0-sources
                   4092: PKGNAME=        nvu-1.0
                   4093: CATEGORIES=     www
                   4094: MASTER_SITES=   http://cvs.nvu.com/download/
                   4095: EXTRACT_SUFX=   .tar.bz2
                   4096: 
                   4097: MAINTAINER=     rillig@NetBSD.org
                   4098: HOMEPAGE=       http://cvs.nvu.com/
                   4099: COMMENT=        Web Authoring System
1.91      rillig   4100: 
1.100     rillig   4101: # url2pkg-marker (please do not remove this line.)
                   4102: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4103: </pre>
                   4104: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4105: source archive:</p>
                   4106: <pre class="programlisting">
1.100     rillig   4107: url2pkg&gt; Running "make makesum" ...
                   4108: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4109: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4110: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4111: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4112: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4113: url2pkg&gt; Running "make extract" ...
                   4114: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4115: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4116: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4117: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4118: ===&gt; Installing dependencies for nvu-1.0
                   4119: ===&gt; Overriding tools for nvu-1.0
                   4120: ===&gt; Extracting for nvu-1.0
                   4121: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4122: 
1.100     rillig   4123: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4124: 
1.100     rillig   4125: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4126: </pre>
                   4127: </div>
                   4128: <div class="sect3" lang="en">
                   4129: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4130: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   4131: <p>Now that the package has been extracted, let's see what's inside
                   4132: it. The package has a <code class="filename">README.txt</code>, but that only
                   4133: says something about mozilla, so it's probably useless for seeing what
                   4134: dependencies this package has. But since there is a GNU configure script
                   4135: in the package, let's hope that it will complain about everything it
                   4136: needs.</p>
                   4137: <pre class="programlisting">
1.100     rillig   4138: <code class="prompt">$</code> bmake
                   4139: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4140: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4141: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4142: ===&gt; Patching for nvu-1.0
                   4143: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4144: ===&gt; Configuring for nvu-1.0
                   4145: [...]
                   4146: configure: error: Perl 5.004 or higher is required.
                   4147: [...]
                   4148: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4149: [...]
1.91      rillig   4150: </pre>
                   4151: <p>That worked quite well. So I opened the package Makefile in my
                   4152: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4153: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4154: package have changed now, and since a perl wrapper is automatically
                   4155: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4156: from scratch.</p>
                   4157: <pre class="programlisting">
1.100     rillig   4158: <code class="prompt">$</code> bmake clean
                   4159: ===&gt; Cleaning for nvu-1.0
                   4160: <code class="prompt">$</code> bmake
                   4161: [...]
                   4162: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4163: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4164: [...]
1.91      rillig   4165: </pre>
                   4166: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4167: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4168: <pre class="programlisting">
1.100     rillig   4169: [...]
                   4170: checking for GTK - version &gt;= 1.2.0... no
                   4171: *** Could not run GTK test program, checking why...
                   4172: [...]
1.91      rillig   4173: </pre>
                   4174: <p>Now to the other dependencies. The first question is: Where is the
                   4175: GTK package hidden in pkgsrc?</p>
                   4176: <pre class="programlisting">
1.100     rillig   4177: <code class="prompt">$</code> echo ../../*/gtk*
                   4178: [many packages ...]
                   4179: <code class="prompt">$</code> echo ../../*/gtk
                   4180: ../../x11/gtk
                   4181: <code class="prompt">$</code> echo ../../*/gtk2
                   4182: ../../x11/gtk2
                   4183: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4184: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4185: </pre>
                   4186: <p>The first try was definitely too broad. The second one had exactly
                   4187: one result, which is very good. But there is one pitfall with GNOME
                   4188: packages. Before GNOME 2 had been released, there were already many
                   4189: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4190: packages, the GNOME 2 packages were imported as separate packages, and
                   4191: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4192: whether this was the case here, and indeed it was.</p>
                   4193: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4194: file, adding the dependency is very easy. I just inserted an
                   4195: <code class="literal">.include</code> line before the last line of the package
                   4196: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4197: <pre class="programlisting">
1.100     rillig   4198: [...]
                   4199: .include "../../x11/gtk2/buildlink3.mk"
                   4200: .include "../../mk/bsd.pkg.mk
1.91      rillig   4201: </pre>
1.110     hubertf  4202: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4203: was:</p>
                   4204: <pre class="programlisting">
1.100     rillig   4205: [...]
                   4206: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4207: checking for GTK - version &gt;= 1.2.0... no
                   4208: *** Could not run GTK test program, checking why...
                   4209: *** The test program failed to compile or link. See the file config.log for the
                   4210: *** exact error that occured. This usually means GTK was incorrectly installed
                   4211: *** or that you have moved GTK since it was installed. In the latter case, you
                   4212: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4213: configure: error: Test for GTK failed.
                   4214: [...]
1.91      rillig   4215: </pre>
                   4216: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4217: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4218: told me that this package really wanted to have the GNOME 1 version of
                   4219: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4220: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4221: So I changed the <code class="literal">x11/gtk2</code> to
                   4222: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4223: and tried again.</p>
                   4224: <pre class="programlisting">
1.100     rillig   4225: [...]
                   4226: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"   -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include   -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe  -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0   -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
                   4227: In file included from xpidl.c:42:
                   4228: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4229: In file included from xpidl.c:42:
                   4230: xpidl.h:132: error: parse error before "IDL_ns"
                   4231: [...]
1.91      rillig   4232: </pre>
                   4233: <p>The package still does not find all of its dependencies. Now the
                   4234: question is: Which package provides the
                   4235: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4236: <pre class="programlisting">
1.100     rillig   4237: <code class="prompt">$</code> echo ../../*/*idl*
                   4238: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4239: <code class="prompt">$</code> echo ../../*/*IDL*
                   4240: ../../net/libIDL
1.91      rillig   4241: </pre>
                   4242: <p>Let's take the one from the second try. So I included the
                   4243: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4244: again. But the error didn't change. After digging through some of the
                   4245: code, I concluded that the build process of the package was broken and
                   4246: couldn't have ever worked, but since the Mozilla source tree is quite
                   4247: large, I didn't want to fix it. So I added the following to the package
                   4248: <code class="filename">Makefile</code> and tried again:</p>
                   4249: <pre class="programlisting">
1.100     rillig   4250: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4251: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4252: </pre>
                   4253: <p>The latter line is needed because the package expects the library
                   4254: <code class="filename">libIDL.so</code>, but only
                   4255: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4256: wrapper to rewrite that on the fly.</p>
                   4257: <p>The next problem was related to a recent change of the FreeType
                   4258: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
                   4259: which patch files were relevant for this issue and copied them to the
                   4260: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4261: patches so that they applied cleanly and retried again. This time,
                   4262: everything worked.</p>
                   4263: </div>
                   4264: <div class="sect3" lang="en">
                   4265: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4266: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4267: <pre class="programlisting">
1.100     rillig   4268: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4269: [...]
                   4270: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4271: <code class="prompt">$</code> bmake deinstall
                   4272: <code class="prompt">$</code> bmake install
1.91      rillig   4273: </pre>
                   4274: </div>
                   4275: </div>
                   4276: </div>
1.77      rillig   4277: </div>
1.75      rillig   4278: <div class="chapter" lang="en">
                   4279: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4280: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4281: <div class="toc">
                   4282: <p><b>Table of Contents</b></p>
                   4283: <dl>
1.122   ! reed     4284: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
        !          4285: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   4286: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4287: <dd><dl>
                   4288: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4289: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4290: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4291: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4292: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4293: </dl></dd>
                   4294: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4295: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4296: <dd><dl>
                   4297: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4298: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4299: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4300: </dl></dd>
1.122   ! reed     4301: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
        !          4302: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4303: </dl>
                   4304: </div>
1.87      wiz      4305: <p>Whenever you're preparing a package, there are a number of
                   4306: files involved which are described in the following
                   4307: sections.</p>
1.75      rillig   4308: <div class="sect1" lang="en">
                   4309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4310: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4311: </h2></div></div></div>
1.75      rillig   4312: <p>Building, installation and creation of a binary package are all
1.87      wiz      4313:   controlled by the package's <code class="filename">Makefile</code>.
                   4314:   The <code class="filename">Makefile</code> describes various things about
                   4315:   a package, for example from where to get it, how to configure,
                   4316:   build, and install it.</p>
1.76      rillig   4317: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4318:   sections that describe the package.</p>
1.75      rillig   4319: <p>In the first section there are the following variables, which
1.87      wiz      4320:   should appear exactly in the order given here.  The order and
                   4321:   grouping of the variables is mostly historical and has no further
                   4322:   meaning.</p>
1.75      rillig   4323: <div class="itemizedlist"><ul type="disc">
                   4324: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4325:     distribution file to be downloaded from the package's
                   4326:     website.</p></li>
1.75      rillig   4327: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4328:     package, as used by pkgsrc. You only need to provide it if
                   4329:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4330:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4331:     directory name together with the version number. It must match the
                   4332:     regular expression
                   4333:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4334:     starts with a letter or digit, and contains only letters, digits,
                   4335:     dashes, underscores, dots and plus signs.</p></li>
                   4336: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4337:     the package file to create if the <code class="varname">PKGNAME</code>
                   4338:     isn't unique on a SVR4 system. The default is
                   4339:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4340:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87      wiz      4341:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4342:     does not produce an unique package name on a SVR4 system.
                   4343:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4344:     characters.</p></li>
1.75      rillig   4345: <li>
                   4346: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4347:     which the package fits in. You can choose any of the top-level
                   4348:     directories of pkgsrc for it.</p>
1.75      rillig   4349: <p>Currently the following values are available for
1.87      wiz      4350:     <code class="varname">CATEGORIES</code>. If more than
                   4351:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4352: <pre class="programlisting">
1.100     rillig   4353: archivers     cross         geography     meta-pkgs     security
                   4354: audio         databases     graphics      misc          shells
                   4355: benchmarks    devel         ham           multimedia    sysutils
                   4356: biology       editors       inputmethod   net           textproc
                   4357: cad           emulators     lang          news          time
                   4358: chat          finance       mail          parallel      wm
                   4359: comms         fonts         math          pkgtools      www
                   4360: converters    games         mbone         print         x11
                   4361: </pre>
1.75      rillig   4362: </li>
1.81      rillig   4363: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4364:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4365:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4366:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.122   ! reed     4367:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4368: </ul></div>
                   4369: <p>The second section contains information about separately
1.87      wiz      4370:   downloaded patches, if any.
                   4371:   </p>
1.75      rillig   4372: <div class="itemizedlist"><ul type="disc">
                   4373: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4374:     Name(s) of additional files that contain distribution patches.
                   4375:     There is no default. pkgsrc will look for them at
                   4376:     <code class="varname">PATCH_SITES</code>.
                   4377:     They will automatically be uncompressed before patching if
                   4378:     the names end with <code class="filename">.gz</code> or
                   4379:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4380: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4381:     Primary location(s) for distribution patch files (see
                   4382:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4383: </ul></div>
                   4384: <p>The third section contains the following variables.
1.87      wiz      4385:   </p>
1.75      rillig   4386: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 4387: <li><p><code class="varname">MAINTAINER</code> is the email
                   4388:     address of the person who feels responsible for this package,
                   4389:     and who is most likely to look at problems or questions regarding
                   4390:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
                   4391:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4392:     before making changes to the package, but are not required to
                   4393:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4394:     to yourself. If you really can't maintain the package for future
                   4395:     updates, set it to
1.110     hubertf  4396:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.114     jmcneill 4397: <li><p><code class="varname">OWNER</code> should be used instead
                   4398:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4399:     developers to update or change the package without contacting
                   4400:     you first. A package Makefile should contain one of
                   4401:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4402:     not both.  </p></li>
1.75      rillig   4403: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4404:     find more information about the package.</p></li>
1.75      rillig   4405: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4406:     description of the package (should not include the package
                   4407:     name).</p></li>
1.75      rillig   4408: </ul></div>
                   4409: <p>Other variables that affect the build:
1.87      wiz      4410:   </p>
1.75      rillig   4411: <div class="itemizedlist"><ul type="disc"><li>
                   4412: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4413:       interesting distribution files of the package are found. The
                   4414:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4415:       works for most packages.</p>
1.75      rillig   4416: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4417:       (most GNU software does, for instance), but extracts itself in
                   4418:       the current directory, you should set
                   4419:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4420: <p>If a package doesn't create a subdirectory with the
                   4421:       name of <code class="varname">DISTNAME</code> but some different name,
                   4422:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4423:       <code class="filename">${WRKDIR}</code>, for example
                   4424:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4425:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4426: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4427:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4428:       variable. By default, its value is
                   4429:       <code class="filename">work</code>. If you want to use the same
                   4430:       pkgsrc tree for building different kinds of binary packages,
                   4431:       you can change the variable according to your needs. Two
                   4432:       other variables handle common cases of setting
                   4433:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4434:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4435:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4436:       the host's name is attached to the directory name. If
                   4437:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4438:       is attached, which might look like
                   4439:       <code class="filename">work.i386</code> or
                   4440:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4441: </li></ul></div>
                   4442: <p>Please pay attention to the following gotchas:</p>
                   4443: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4444: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4445:       installed in compressed form by the package.  For packages using
                   4446:       BSD-style makefiles which honor MANZ, there is
                   4447:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4448: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4449:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4450:       below).</p></li>
1.110     hubertf  4451: <li><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4452: </ul></div>
                   4453: </div>
                   4454: <div class="sect1" lang="en">
                   4455: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4456: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4457: </h2></div></div></div>
1.76      rillig   4458: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4459:   digest, or checksum, of each distfile needed for the package. This
                   4460:   ensures that the distfiles retrieved from the Internet have not been
                   4461:   corrupted during transfer or altered by a malign force to introduce
                   4462:   a security hole. Due to recent rumor about weaknesses of digest
                   4463:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4464:   message digests, as well as the file size.</p>
1.76      rillig   4465: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4466:   checksums for all the patches found in the
1.110     hubertf  4467:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4468: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4469:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4470:   command.</p>
1.75      rillig   4471: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4472:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87      wiz      4473:   <code class="filename">distinfo</code> file and care should be taken when
                   4474:   upgrading such a package to ensure distfile information is not
                   4475:   lost.</p>
1.75      rillig   4476: </div>
                   4477: <div class="sect1" lang="en">
                   4478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4479: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4480: <p>Many packages still don't work out-of-the box on the various
                   4481:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4482:   patch files are needed to make the package work. These patch files are
                   4483:   found in the <code class="filename">patches/</code> directory.</p>
                   4484: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4485:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4486:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93      rillig   4487:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4488:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4489: <div class="sect2" lang="en">
                   4490: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4491: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4492: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4493:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4494:   problems. (To force patches to apply with fuzz you can set
                   4495:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4496:   should contain only changes for a single file, and no file should be
1.93      rillig   4497:   patched by more than one patch file. This helps to keep future
                   4498:   modifications simple.</p>
                   4499: <p>Each patch file is structured as follows: In the first line,
                   4500:   there is the RCS Id of the patch itself. The second line should be
                   4501:   empty for aesthetic reasons. After that, there should be a comment for
                   4502:   each change that the patch does. There are a number of standard
                   4503:   cases:</p>
                   4504: <div class="itemizedlist"><ul type="disc">
                   4505: <li><p>Patches that replace the <code class="literal">==</code>
1.110     hubertf  4506:   operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111     rillig   4507:   are so common that they don't need a comment at all.</p></li>
1.93      rillig   4508: <li><p>Patches for commonly known vulnerabilities should
                   4509:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4510: <li><p>Patches that change source code should mention the
                   4511:   platform and other environment (for example, the compiler) that the
                   4512:   patch is needed for.</p></li>
                   4513: </ul></div>
                   4514: <p>In all other cases, the patch should be commented so that any
                   4515:   developer who knows the code of the application can make some use of
                   4516:   the patch. Special care should be taken for the upstream developers,
                   4517:   since we generally want that they accept our patches, so we have less
                   4518:   work in the future.</p>
                   4519: </div>
                   4520: <div class="sect2" lang="en">
                   4521: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4522: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4523: <p>One important thing to mention is to pay attention that no RCS
                   4524:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4525:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4526:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   4527:   problems.</p>
1.87      wiz      4528: <p>For even more automation, we recommend using
1.110     hubertf  4529:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4530:   whole set of patches. You just have to backup files before you
                   4531:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4532:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4533:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4534:   you upgrade a package this way, you can easily compare the new
                   4535:   set of patches with the previously existing one with
1.110     hubertf  4536:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87      wiz      4537:   or update from the <code class="filename">work/.newpatches</code>
                   4538:   directory to <code class="filename">patches/</code>.</p>
                   4539: <p>When you have finished a package, remember to generate
1.110     hubertf  4540:   the checksums for the patch files by using the <span class="command"><strong>make
1.122   ! reed     4541:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      4542: <p>When adding a patch that corrects a problem in the
                   4543:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4544:   man pages should go), send the patch as a bug report to the
                   4545:   maintainer.  This benefits non-pkgsrc users of the package,
                   4546:   and usually makes it possible to remove the patch in future
                   4547:   version.</p>
1.101     rillig   4548: <p>The file names of the patch files are usually of the form
                   4549:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4550: </div>
                   4551: <div class="sect2" lang="en">
                   4552: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4553: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4554: <p>If you want to share patches between multiple packages
                   4555:   in pkgsrc, e.g. because they use the same distfiles, set
                   4556:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4557:   can be found, e.g.:</p>
                   4558: <pre class="programlisting">
1.100     rillig   4559: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4560: </pre>
1.75      rillig   4561: <p>Patch files that are distributed by the author or other
1.87      wiz      4562:     maintainers can be listed in
                   4563:     <code class="varname">PATCHFILES</code>.</p>
                   4564: <p>If it is desired to store any patches that should not be
                   4565:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4566:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4567:     directory tree there is expected to have the same
                   4568:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4569:     patches are expected to be stored inside these dirs (also
                   4570:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4571:     example, if you want to keep a private patch for
                   4572:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4573:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4574:     files in the named directory are expected to be patch files,
                   4575:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4576:     applied</em></span>.</p>
1.93      rillig   4577: </div>
1.85      jmmv     4578: <div class="sect2" lang="en">
                   4579: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4580: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4581: <p>When fixing a portability issue in the code do not use
                   4582:       preprocessor magic to check for the current operating system nor
                   4583:       platform.  Doing so hurts portability to other platforms because
                   4584:       the OS-specific details are not abstracted appropriately.</p>
                   4585: <p>The general rule to follow is: instead of checking for the
                   4586:       operating system the application is being built on, check for the
                   4587:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4588:       instead of assuming that kqueue is available under NetBSD and
                   4589:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.114     jmcneill 4590:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4591:       yes, this generally involves patching the
1.110     hubertf  4592:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4593:       that prevents some OSes from adopting interfaces from other OSes
                   4594:       (e.g. Linux implementing kqueue), something that the above checks
                   4595:       cannot take into account.</p>
                   4596: <p>Of course, checking for features generally involves more
                   4597:       work on the developer's side, but the resulting changes are
1.87      wiz      4598:       cleaner and there are chances they will work on many other
1.85      jmmv     4599:       platforms.  Not to mention that there are higher chances of being
                   4600:       later integrated into the mainstream sources.  Remember:
                   4601:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4602: <p>Some typical examples:</p>
                   4603: <div class="table">
1.106     rillig   4604: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4605: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4606: <colgroup>
                   4607: <col>
                   4608: <col>
                   4609: <col>
                   4610: </colgroup>
                   4611: <thead><tr>
                   4612: <th>Where</th>
                   4613: <th>Incorrect</th>
                   4614: <th>Correct</th>
                   4615: </tr></thead>
                   4616: <tbody>
                   4617: <tr>
                   4618: <td>configure script</td>
                   4619: <td>
1.100     rillig   4620: <pre class="programlisting">
                   4621: case ${target_os} in
                   4622: netbsd*) have_kvm=yes ;;
                   4623: *)       have_kvm=no  ;;
                   4624: esac
                   4625: </pre>
1.85      jmmv     4626:              </td>
                   4627: <td>
1.100     rillig   4628: <pre class="programlisting">
                   4629: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4630: </pre>
1.85      jmmv     4631:              </td>
                   4632: </tr>
                   4633: <tr>
                   4634: <td>C source file</td>
                   4635: <td>
1.100     rillig   4636: <pre class="programlisting">
                   4637: #if defined(__NetBSD__)
                   4638: #  include &lt;sys/event.h&gt;
                   4639: #endif
                   4640: </pre>
1.85      jmmv     4641:              </td>
                   4642: <td>
1.100     rillig   4643: <pre class="programlisting">
                   4644: #if defined(HAVE_SYS_EVENT_H)
                   4645: #  include &lt;sys/event.h&gt;
                   4646: #endif
                   4647: </pre>
1.85      jmmv     4648:              </td>
                   4649: </tr>
                   4650: <tr>
                   4651: <td>C source file</td>
                   4652: <td>
1.100     rillig   4653: <pre class="programlisting">
                   4654: int
                   4655: monitor_file(...)
                   4656: {
                   4657: #if defined(__NetBSD__)
                   4658:         int fd = kqueue();
                   4659:         ...
                   4660: #else
                   4661:         ...
                   4662: #endif
                   4663: }
                   4664: </pre>
1.85      jmmv     4665:              </td>
                   4666: <td>
1.100     rillig   4667: <pre class="programlisting">
                   4668: int
                   4669: monitor_file(...)
                   4670: {
                   4671: #if defined(HAVE_KQUEUE)
                   4672:         int fd = kqueue();
                   4673:         ...
                   4674: #else
                   4675:        ...
                   4676: #endif
                   4677: }
                   4678: </pre>
1.85      jmmv     4679:              </td>
                   4680: </tr>
                   4681: </tbody>
1.91      rillig   4682: </table></div>
1.85      jmmv     4683: </div>
1.91      rillig   4684: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4685:       packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4686:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4687:       2</a>).  It summarizes multiple details on how to make
                   4688:       software easier to package; all the suggestions in it were
                   4689:       collected from our experience in pkgsrc work, so they are possibly
                   4690:       helpful when creating patches too.</p>
                   4691: </div>
                   4692: <div class="sect2" lang="en">
                   4693: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4694: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4695: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4696:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4697:       improvements you do to a package to the mainstream developers.
                   4698:       This is the only way to get their attention on portability issues
                   4699:       and to ensure that future versions can be built out-of-the box on
                   4700:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4701:       the fixes straight from the packaged code.</p>
1.93      rillig   4702: <p>This generally involves cleaning up the patches
                   4703:       (because sometimes the patches that are
1.85      jmmv     4704:       added to pkgsrc are quick hacks), filling bug reports in the
                   4705:       appropriate trackers for the projects and working with the
                   4706:       mainstream authors to accept your changes.  It is
                   4707:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4708:       the packages in pkgsrc are kept simple and thus further changes
                   4709:       can be done without much hassle.</p>
                   4710: <p>Support the idea of free software!</p>
                   4711: </div>
1.75      rillig   4712: </div>
                   4713: <div class="sect1" lang="en">
                   4714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4715: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4716: <div class="variablelist"><dl>
1.76      rillig   4717: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4718: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4719:          any credits where they are due.  Please bear in mind that others do not
                   4720:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4721:          will read everything that you write here.</p></dd>
1.76      rillig   4722: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4723: <dd><p>This file governs the files that are installed on your
                   4724:          system: all the binaries, manual pages, etc. There are other
                   4725:          directives which may be entered in this file, to control the
                   4726:          creation and deletion of directories, and the location of
1.110     hubertf  4727:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4728:          information.</p></dd>
1.75      rillig   4729: </dl></div>
                   4730: </div>
                   4731: <div class="sect1" lang="en">
                   4732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4733: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78      rillig   4734: <div class="sect2" lang="en">
                   4735: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4736: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4737: <div class="variablelist"><dl>
1.76      rillig   4738: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110     hubertf  4739: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4740:            First time after package extraction and before files are
                   4741:            moved in place, the second time after the files to install
                   4742:            are moved in place. This can be used to do any custom
                   4743:            procedures not possible with @exec commands in
1.110     hubertf  4744:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4745:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><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="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.76      rillig   4746: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4747: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4748:            this script's responsibility to clean up any additional messy details
                   4749:            around the package's installation, since all pkg_delete knows is how to
                   4750:            delete the files created in the original distribution.
1.110     hubertf  4751:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4752:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76      rillig   4753: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4754: <dd>
                   4755: <p>This file is displayed after installation of the package.
1.87      wiz      4756:            Useful for things like legal notices on almost-free
                   4757:            software and hints for updating config files after
                   4758:            installing modules for apache, PHP etc.
                   4759:            Please note that you can modify variables in it easily by using
                   4760:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4761:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4762: <pre class="programlisting">
1.100     rillig   4763: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4764: </pre>
1.75      rillig   4765: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4766:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4767:            performed for <code class="varname">PKGNAME</code>,
                   4768:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4769:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4770:            <code class="varname">X11BASE</code>,
                   4771:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4772:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4773:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4774: <p>You can display a different or additional files by
                   4775:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4776:            default is <code class="filename">MESSAGE</code>, if the file
                   4777:            exists.</p>
1.75      rillig   4778: </dd>
1.78      rillig   4779: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4780: <dd><p>FIXME: There is no documentation on the
                   4781:        alternatives framework.</p></dd>
                   4782: </dl></div>
                   4783: </div>
                   4784: <div class="sect2" lang="en">
                   4785: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4786: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4787: <div class="variablelist"><dl>
                   4788: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4789: <dd><p>This file contains arbitrary things that could
                   4790:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4791:        to be used by more than one package. This file should only be
                   4792:        used when the packages that will use the file are known in
                   4793:        advance. For other purposes it is often better to write a
                   4794:        <code class="filename">*.mk</code> file and give it a good name that
                   4795:        describes what it does.</p></dd>
                   4796: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4797: <dd><p>This file contains the dependency information
1.110     hubertf  4798:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4799: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4800: <dd><p>This file contains workarounds for compiler bugs
                   4801:        and similar things. It is included automatically by the pkgsrc
                   4802:        infrastructure, so you don't need an extra
                   4803:        <code class="literal">.include</code> line for
                   4804:        it.</p></dd>
                   4805: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4806: <dd><p>This file contains the code for the
1.110     hubertf  4807:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78      rillig   4808:        selected by the user. If a package has only one or two options,
                   4809:        it is equally acceptable to put the code directly into the
                   4810:        <code class="filename">Makefile</code>.</p></dd>
                   4811: </dl></div>
                   4812: </div>
                   4813: <div class="sect2" lang="en">
                   4814: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4815: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4816: <div class="variablelist"><dl>
                   4817: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4818: <dd><p>These files do not take place in the creation of
                   4819:        a package and thus are purely informative to the package
                   4820:        developer.</p></dd>
                   4821: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4822: <dd><p>This file contains things that need to be done
                   4823:        to make the package even
                   4824:        better.</p></dd>
1.75      rillig   4825: </dl></div>
                   4826: </div>
1.78      rillig   4827: </div>
1.75      rillig   4828: <div class="sect1" lang="en">
                   4829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4830: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4831: </h2></div></div></div>
1.110     hubertf  4832: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4833:     unpacked into the directory denoted by
                   4834:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4835:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4836:     directory is also used to keep various timestamp files.
                   4837:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4838:     The default is <code class="filename">${.CURDIR}/work</code>
                   4839:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4840:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4841: </div>
                   4842: <div class="sect1" lang="en">
                   4843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4844: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4845: </h2></div></div></div>
1.75      rillig   4846: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4847:     to configuration or building, you could place these files here and use
1.110     hubertf  4848:     a <span class="command"><strong>${CP}</strong></span> command in the
1.87      wiz      4849:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4850:     this. Alternatively, you could simply diff the file against
                   4851:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4852:     the creation of this file.</p>
                   4853: <p>If you want to share files in this way with other
                   4854:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4855:     to the other package's <code class="filename">files</code> directory,
                   4856:     e.g.:</p>
                   4857: <pre class="programlisting">
1.100     rillig   4858: FILESDIR=${.CURDIR}/../xemacs/files
                   4859: </pre>
1.75      rillig   4860: </div>
                   4861: </div>
                   4862: <div class="chapter" lang="en">
                   4863: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4864: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4865: <div class="toc">
                   4866: <p><b>Table of Contents</b></p>
                   4867: <dl>
1.106     rillig   4868: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.122   ! reed     4869: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4870: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4871: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4872: <dd><dl>
                   4873: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4874: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4875: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4876: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4877: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4878: </dl></dd>
                   4879: </dl>
                   4880: </div>
1.76      rillig   4881: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4882:   each of which forms a well-defined part of the pkgsrc system. Using
1.110     hubertf  4883:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4884:   like pkgsrc requires some discipline to keep the code correct and
                   4885:   understandable.</p>
1.76      rillig   4886: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4887:   programming are variables (which are actually macros) and shell
                   4888:   commands. Among these shell commands may even be more complex ones
1.110     hubertf  4889:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4890:   as intended it is necessary to quote all variables correctly when they
                   4891:   are used.</p>
                   4892: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4893:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4894:   with them.</p>
                   4895: <div class="sect1" lang="en">
                   4896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4897: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97      rillig   4898: <div class="itemizedlist"><ul type="disc"><li>
                   4899: <p>When you are creating a file as a
                   4900:     target of a rule, always write the data to a temporary file first
                   4901:     and finally rename that file. Otherwise there might occur an error
                   4902:     in the middle of generating the file, and when the user runs
1.110     hubertf  4903:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4904:     regenerated properly. Example:</p>
                   4905: <pre class="programlisting">
1.100     rillig   4906: wrong:
                   4907:         @echo "line 1" &gt; ${.TARGET}
                   4908:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4909:         @false
                   4910: 
                   4911: correct:
                   4912:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4913:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4914:         @false
                   4915:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4916: </pre>
1.110     hubertf  4917: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4918:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4919:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4920:     correct</strong></span> gives an error message twice, as expected.</p>
1.110     hubertf  4921: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4922:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4923:     happens when it is interrupted, for example by pressing
                   4924:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110     hubertf  4925:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4926: </li></ul></div>
                   4927: </div>
                   4928: <div class="sect1" lang="en">
                   4929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4930: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4931: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4932:     can be processed using the five operators ``='', ``+='', ``?='',
1.110     hubertf  4933:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4934:     page.</p>
                   4935: <p>When a variable's value is parsed from a
1.76      rillig   4936:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4937:     backslash character ``\'' are handled specially. If a backslash is
                   4938:     followed by a newline, any whitespace immediately in front of the
                   4939:     backslash, the backslash, the newline, and any whitespace
                   4940:     immediately behind the newline are replaced with a single space. A
                   4941:     backslash character and an immediately following hash character are
                   4942:     replaced with a single hash character. Otherwise, the backslash is
                   4943:     passed as is. In a variable assignment, any hash character that is
                   4944:     not preceded by a backslash starts a comment that continues upto the
                   4945:     end of the logical line.</p>
                   4946: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4947:     the only way to create a variable consisting of a single backslash
                   4948:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4949: <p>So far for defining variables. The other thing you can do with
                   4950:     variables is evaluating them. A variable is evaluated when it is
                   4951:     part of the right side of the ``:='' or the ``!='' operator, or
                   4952:     directly before executing a shell command which the variable is part
1.110     hubertf  4953:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   4954:     is, variables are not evaluated until there's no other way. The
                   4955:     ``modifiers'' mentioned in the man page also evaluate the
                   4956:     variable.</p>
                   4957: <p>Some of the modifiers split the string into words and then
                   4958:     operate on the words, others operate on the string as a whole. When
                   4959:     a string is split into words, it is split as you would expect
1.110     hubertf  4960:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.114     jmcneill 4961: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4962:     loop does not follow the shell quoting rules but splits at sequences
                   4963:     of whitespace.</p>
                   4964: <p>There are several types of variables that should be handled
                   4965:     differently. Strings and two types of lists.</p>
                   4966: <div class="itemizedlist"><ul type="disc">
                   4967: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4968:       characters. Nevertheless, you should restrict yourself to only
                   4969:       using printable characters. Examples are
                   4970:       <code class="varname">PREFIX</code> and
                   4971:       <code class="varname">COMMENT</code>.</p></li>
                   4972: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4973:       are never exported to any shell command. Their elements are
                   4974:       separated by whitespace. Therefore, the elements themselves cannot
                   4975:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4976:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4977:       Examples are <code class="varname">DEPENDS</code> and
                   4978:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4979: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4980:       may be exported to a shell command. Their elements can contain any
                   4981:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4982:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4983:       <code class="varname">DISTFILES</code> and
                   4984:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4985: </ul></div>
                   4986: <div class="sect2" lang="en">
                   4987: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4988: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4989: <div class="itemizedlist"><ul type="disc">
                   4990: <li><p>All variable names starting with an underscore
                   4991:        are reserved for use by the pkgsrc infrastructure. They shall
                   4992:        not be used by package
1.76      rillig   4993:        <code class="filename">Makefile</code>s.</p></li>
1.110     hubertf  4994: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4995:        lowercase variable names for the iteration
                   4996:        variables.</p></li>
                   4997: <li><p>All list variables should have a ``plural''
                   4998:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4999:        <code class="varname">DISTFILES</code>.</p></li>
                   5000: </ul></div>
                   5001: </div>
                   5002: </div>
                   5003: <div class="sect1" lang="en">
                   5004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5005: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   5006: <p>This section presents you with some code snippets you should
                   5007:     use in your own code. If you don't find anything appropriate here,
                   5008:     you should test your code and add it here.</p>
                   5009: <div class="sect2" lang="en">
                   5010: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5011: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   5012: <pre class="programlisting">
1.100     rillig   5013: STRING=                 foo * bar `date`
                   5014: INT_LIST=               # empty
                   5015: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5016: EXT_LIST=               # empty
                   5017: ANOTHER_EXT_LIST=       a=b c=d
                   5018: 
                   5019: INT_LIST+=              ${STRING}               # 1
                   5020: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5021: EXT_LIST+=              ${STRING:Q}             # 3
                   5022: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    5023: </pre>
1.75      rillig   5024: <p>When you add a string to an external list (example 3), it
                   5025:       must be quoted. In all other cases, you must not add a quoting
                   5026:       level. You must not merge internal and external lists, unless you
                   5027:       are sure that all entries are correctly interpreted in both
                   5028:       lists.</p>
                   5029: </div>
                   5030: <div class="sect2" lang="en">
                   5031: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5032: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   5033: <pre class="programlisting">
1.100     rillig   5034: EXT_LIST=       # empty
                   5035: .for i in ${INT_LIST}
                   5036: EXT_LIST+=      ${i:Q}""
                   5037: .endfor
1.1       grant    5038: </pre>
1.75      rillig   5039: <p>This code converts the internal list
                   5040:       <code class="varname">INT_LIST</code> into the external list
                   5041:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5042:       are unquoted they must be quoted here. The reason for appending
                   5043:       <code class="varname">""</code> is explained below.</p>
                   5044: </div>
                   5045: <div class="sect2" lang="en">
                   5046: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5047: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   5048: <p>Sometimes you may want to print an arbitrary string. There
                   5049:        are many ways to get it wrong and only few that can handle every
                   5050:        nastiness.</p>
1.75      rillig   5051: <pre class="programlisting">
1.100     rillig   5052: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5053: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5054: 
1.100     rillig   5055: all:
                   5056:         echo ${STRING}                  # 1
                   5057:         echo "${STRING}"                # 2
                   5058:         echo "${STRING:Q}"              # 3
                   5059:         echo ${STRING:Q}                # 4
                   5060:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5061:         printf "%s\\n" ${STRING:Q}""    # 6
                   5062:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5063: </pre>
1.75      rillig   5064: <p>Example 1 leads to a syntax error in the shell, as the
                   5065:       characters are just copied.</p>
                   5066: <p>Example 2 leads to a syntax error too, and if you leave out
                   5067:       the last " character from <code class="varname">${STRING}</code>,
1.110     hubertf  5068:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   5069:       variable would be evaluated, too.</p>
                   5070: <p>Example 3 outputs each space character preceded by a
                   5071:       backslash (or not), depending on the implementation of the
1.110     hubertf  5072:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   5073: <p>Example 4 handles correctly every string that does not start
                   5074:       with a dash. In that case, the result depends on the
1.110     hubertf  5075:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   5076:       guarantee that your input does not start with a dash, this form is
                   5077:       appropriate.</p>
                   5078: <p>Example 5 handles even the case of a leading dash
                   5079:       correctly.</p>
1.79      rillig   5080: <p>Example 6 also works with every string and is the
                   5081:       light-weight solution, since it does not involve a pipe, which has
                   5082:       its own problems.</p>
1.75      rillig   5083: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5084:       because the quoting has already been done when adding elements to
                   5085:       the list.</p>
                   5086: <p>As internal lists shall not be passed to the shell, there is
                   5087:       no example for it.</p>
                   5088: </div>
                   5089: <div class="sect2" lang="en">
                   5090: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5091: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5092: <p>There are many possible sources of wrongly quoted variables.
                   5093:       This section lists some of the commonly known ones.</p>
                   5094: <div class="itemizedlist"><ul type="disc">
                   5095: <li>
                   5096: <p>Whenever you use the value of a list, think
                   5097:        about what happens to leading or trailing whitespace. If the
                   5098:        list is a well-formed shell expression, you can apply the
                   5099:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5100:        whitespace from each word. The <code class="varname">:M</code> operator
                   5101:        first splits its argument according to the rules of the shell,
                   5102:        and then creates a new list consisting of all words that match
                   5103:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5104:        One class of situations where this is needed is when adding a
                   5105:        variable like <code class="varname">CPPFLAGS</code> to
                   5106:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5107:        invokes other configure scripts, it strips the leading and
                   5108:        trailing whitespace from the variable and then passes it to the
                   5109:        other configure scripts. But these configure scripts expect the
                   5110:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5111:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5112:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5113:        here is how we do it:</p>
                   5114: <pre class="programlisting">
1.100     rillig   5115: CPPFLAGS=               # empty
                   5116: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5117: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5118: 
                   5119: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5120: 
                   5121: all:
                   5122:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5123:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5124: </pre>
1.75      rillig   5125: </li>
                   5126: <li><p>The example above contains one bug: The
                   5127:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5128:        expression, but there is the C compiler after it, which also
                   5129:        expects a properly quoted string (this time in C syntax). The
                   5130:        version above is therefore only correct if
                   5131:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5132:        or double quotes. If you want to allow these, you have to add
                   5133:        another layer of quoting to each variable that is used as a C
                   5134:        string literal. You cannot use the <code class="varname">:Q</code>
                   5135:        operator for it, as this operator only works for the
                   5136:        shell.</p></li>
                   5137: <li>
                   5138: <p>Whenever a variable can be empty, the
                   5139:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5140:        are two completely different cases which can be solved with the
                   5141:        same trick.</p>
                   5142: <pre class="programlisting">
1.100     rillig   5143: EMPTY=                  # empty
                   5144: empty_test:
                   5145:         for i in a ${EMPTY:Q} c; do \
                   5146:             echo "$$i"; \
                   5147:         done
                   5148: 
                   5149: for_test:
                   5150: .for i in a:\ a:\test.txt
                   5151:         echo ${i:Q}
                   5152:         echo "foo"
                   5153: .endfor
1.1       grant    5154: </pre>
1.75      rillig   5155: <p>The first example will only print two of the three lines
                   5156:        we might have expected. This is because
                   5157:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5158:        the shell cannot see. The workaround is to write
                   5159:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5160:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5161:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5162: <p>The second example will only print three lines instead of
                   5163:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5164:        This is because the backslash of the value
                   5165:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110     hubertf  5166:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5167:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   5168:        <code class="varname">${i:Q}""</code>.</p>
                   5169: </li>
                   5170: </ul></div>
                   5171: </div>
                   5172: <div class="sect2" lang="en">
                   5173: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5174: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5175: <p>The pkgsrc bmake program does not handle the following
                   5176:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5177:       contains a ``-'' character, one of the closing braces is included
                   5178:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5179: <pre class="programlisting">
1.100     rillig   5180: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5181: </pre>
1.75      rillig   5182: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5183:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75      rillig   5184:       <code class="varname">bug1</code>.</p>
                   5185: </div>
                   5186: </div>
                   5187: </div>
                   5188: <div class="chapter" lang="en">
                   5189: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5190: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5191: <div class="toc">
                   5192: <p><b>Table of Contents</b></p>
                   5193: <dl>
1.106     rillig   5194: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.122   ! reed     5195: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
        !          5196: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   5197: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5198: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.122   ! reed     5199: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   5200: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5201: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5202: </dl>
                   5203: </div>
1.87      wiz      5204: <p>The <code class="filename">PLIST</code> file contains a package's
                   5205:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5206:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5207:   directory it's been installed in) plus some additional statements
1.110     hubertf  5208:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      5209:   This chapter addresses some issues that need attention when
                   5210:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5211:   below!).</p>
1.75      rillig   5212: <div class="sect1" lang="en">
                   5213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5214: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5215: <p>Be sure to add a RCS ID line as the first thing in any
                   5216:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5217: <pre class="programlisting">
1.100     rillig   5218: @comment $NetBSD$
1.87      wiz      5219:     </pre>
1.75      rillig   5220: </div>
                   5221: <div class="sect1" lang="en">
                   5222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5223: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5224: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5225:     to output a PLIST that matches any new files since the package
1.110     hubertf  5226:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      5227:     more information on this target.</p>
1.75      rillig   5228: </div>
                   5229: <div class="sect1" lang="en">
                   5230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5231: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5232: </h2></div></div></div>
1.87      wiz      5233: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5234:     <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
                   5235:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5236:     <code class="varname">@comment</code>s instead of real
                   5237:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5238:     specific directories and files, so that the results of that
                   5239:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5240:     lot</em></span> during the update of packages.</p>
                   5241: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5242:     of AWK patterns and actions that are used to filter the output of
                   5243:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5244:     scripting you like to it, but be careful with quoting.</p>
                   5245: <p>For example, to get all files inside the
                   5246:     <code class="filename">libdata/foo</code> directory removed from the
                   5247:     resulting PLIST:</p>
                   5248: <pre class="programlisting">
1.100     rillig   5249: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5250:     </pre>
                   5251: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5252:     to a specific (shared) directory converted to
                   5253:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5254: <pre class="programlisting">
1.100     rillig   5255: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5256:     </pre>
1.75      rillig   5257: </div>
                   5258: <div class="sect1" lang="en">
                   5259: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5260: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5261: <p>A number of variables are substituted automatically in
                   5262:     PLISTs when a package is installed on a system. This includes the
                   5263:     following variables:</p>
1.75      rillig   5264: <div class="variablelist"><dl>
                   5265: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5266: <dd>
                   5267: <p>Some packages like emacs and perl embed information
1.87      wiz      5268:          about which architecture they were built on into the
                   5269:          pathnames where they install their files. To handle this
                   5270:          case, PLIST will be preprocessed before actually used, and
                   5271:          the symbol
                   5272:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.110     hubertf  5273:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5274:          same is done if the string
                   5275:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5276:          PLIST somewhere - use this on packages that have GNU
                   5277:          autoconf-created configure scripts.</p>
1.75      rillig   5278: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5279: <h3 class="title">Legacy note</h3>
                   5280: <p>There used to be a symbol
1.87      wiz      5281:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.110     hubertf  5282:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5283:            -m</strong></span>, but that's no longer supported and has
                   5284:            been removed.</p>
1.75      rillig   5285: </div>
                   5286: </dd>
                   5287: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5288: <dd>
                   5289: <p>Some packages want to embed the OS name and version
1.87      wiz      5290:          into some paths.  To do this, use these variables in the
                   5291:          <code class="filename">PLIST</code>:
                   5292:          </p>
1.75      rillig   5293: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  5294: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</p></li>
1.75      rillig   5295: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.110     hubertf  5296: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</p></li>
1.75      rillig   5297: </ul></div>
                   5298: </dd>
                   5299: </dl></div>
1.87      wiz      5300: <p>For a complete list of values which are replaced by
                   5301:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5302:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5303: <p>If you want to change other variables not listed above, you
                   5304:     can add variables and their expansions to this variable in the
1.110     hubertf  5305:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   5306: <pre class="programlisting">
1.100     rillig   5307: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5308:     </pre>
1.75      rillig   5309: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5310:     in the <code class="filename">PLIST</code> with
                   5311:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.120     snj      5312: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   5313:     the common case of conditionally including some
                   5314:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5315:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      5316:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5317:     to <code class="literal">yes</code> if the entry should be included.
1.119     mishka   5318:     This will substitute &#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;
                   5319:     in the <code class="filename">PLIST</code> with either
                   5320:     &#8220;<span class="quote"><code class="literal">""</code></span>&#8221; or
                   5321:     &#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;.
                   5322:     For example, in <code class="filename">Makefile</code>:</p>
                   5323: <pre class="programlisting">
                   5324: PLIST_VARS+=   foo
                   5325: .if <em class="replaceable"><code>condition</code></em>
                   5326: PLIST.foo=     yes
                   5327: .else
                   5328:     </pre>
                   5329: <p>And then in <code class="filename">PLIST</code>:</p>
                   5330: <pre class="programlisting">
                   5331: @comment $NetBSD$
                   5332: bin/bar
                   5333: man/man1/bar.1
                   5334: ${PLIST.foo}bin/foo
                   5335: ${PLIST.foo}man/man1/foo.1
                   5336: ${PLIST.foo}share/bar/foo.data
                   5337: ${PLIST.foo}@dirrm share/bar
                   5338:     </pre>
1.75      rillig   5339: </div>
                   5340: <div class="sect1" lang="en">
                   5341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5342: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5343: <p>Man pages should be installed in compressed form if
1.87      wiz      5344:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5345:     and uncompressed otherwise. To handle this in the
                   5346:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5347:     appended/removed automatically for man pages according to
                   5348:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5349:     or not, see above for details. This modification of the
                   5350:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5351:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5352: </div>
                   5353: <div class="sect1" lang="en">
                   5354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5355: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5356: </h2></div></div></div>
1.76      rillig   5357: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5358:     in generating the binary package, set the variable
                   5359:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110     hubertf  5360:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5361:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5362:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5363: </div>
                   5364: <div class="sect1" lang="en">
                   5365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5366: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5367: <p>Some packages decide to install a different set of files based on
1.87      wiz      5368:     the operating system being used. These differences can be
                   5369:     automatically handled by using the following files:</p>
1.75      rillig   5370: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5371: <li><p><code class="filename">PLIST.common</code></p></li>
                   5372: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5373: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5374: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5375: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5376: </ul></div>
                   5377: </div>
                   5378: <div class="sect1" lang="en">
                   5379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5380: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5381: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5382:     multiple (and unrelated) packages install files.  These
                   5383:     directories are problematic because you have to add special tricks
                   5384:     in the PLIST to conditionally remove them, or have some
                   5385:     centralized package handle them.</p>
                   5386: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5387:     is shared by a few unrelated packages, it's often not worth to add
                   5388:     an extra package to remove it.  Therefore, one simply does:</p>
                   5389: <pre class="programlisting">
1.100     rillig   5390: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5391:     </pre>
                   5392: <p>in the PLISTs of all affected packages, instead of the
                   5393:     regular "@dirrm" line.</p>
                   5394: <p>However, if the directory is shared across many packages, two
                   5395:     different solutions are available:</p>
1.75      rillig   5396: <div class="orderedlist"><ol type="1">
1.87      wiz      5397: <li><p>If the packages have a common dependency, the directory
                   5398:        can be removed in that.  For example, see
1.91      rillig   5399:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87      wiz      5400:        removes the shared directory
                   5401:        <code class="filename">share/omf</code>.</p></li>
                   5402: <li><p>If the packages using the directory are not related at
                   5403:        all (they have no common dependencies), a *-dirs package is
                   5404:        used.</p></li>
1.75      rillig   5405: </ol></div>
1.87      wiz      5406: <p>From now on, we'll discuss the second solution.  To get an
                   5407:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5408: <pre class="programlisting">
1.100     rillig   5409: <code class="prompt">%</code> cd .../pkgsrc
                   5410: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5411:     </pre>
                   5412: <p>Their use from other packages is very simple.  The
                   5413:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5414:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5415:     version number (always pick the latest one when writing new
                   5416:     packages).</p>
                   5417: <p>For example, if a package installs files under
                   5418:     <code class="filename">share/applications</code>, it should have the
                   5419:     following line in it:</p>
                   5420: <pre class="programlisting">
1.100     rillig   5421: USE_DIRS+=      xdg-1.1
1.87      wiz      5422:     </pre>
1.110     hubertf  5423: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87      wiz      5424:     print-PLIST</strong></span>, you should get the right (commented out)
                   5425:     lines.</p>
                   5426: <p>Note that even if your package is using
                   5427:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5428:     *-x11-dirs packages.  Just specify the name without that part and
                   5429:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5430:     care of it.</p>
1.75      rillig   5431: </div>
                   5432: </div>
                   5433: <div class="chapter" lang="en">
                   5434: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5435: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5436: <div class="toc">
                   5437: <p><b>Table of Contents</b></p>
                   5438: <dl>
1.106     rillig   5439: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.122   ! reed     5440: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5441: <dd><dl>
1.106     rillig   5442: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.122   ! reed     5443: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5444: </dl></dd>
1.122   ! reed     5445: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5446: <dd><dl>
1.122   ! reed     5447: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   5448: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5449: </dl></dd>
                   5450: </dl>
                   5451: </div>
                   5452: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5453:   are seen by a package's configure and build processes.  This is implemented
                   5454:   in a two step process:</p>
1.75      rillig   5455: <div class="orderedlist"><ol type="1">
                   5456: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5457:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5458:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5459: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5460:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5461:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5462:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5463:       native compiler on some operating systems look like GCC, so that
                   5464:       packages that expect GCC won't require modifications to build with
                   5465:       those native compilers.</p></li>
1.75      rillig   5466: </ol></div>
                   5467: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5468:   package may be built consistently despite what other software may be
                   5469:   installed. Please note that the normal system header and library paths,
                   5470:   e.g. <code class="filename">/usr/include</code>,
                   5471:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5472:   designed to insulate the package build from non-system-supplied
                   5473:   software.</p>
1.75      rillig   5474: <div class="sect1" lang="en">
                   5475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5476: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5477: <p>The process of converting packages to use the buildlink3
1.87      wiz      5478:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5479:     The things to keep in mind are:</p>
1.75      rillig   5480: <div class="orderedlist"><ol type="1">
1.87      wiz      5481: <li><p>Ensure that the build always calls the wrapper scripts
                   5482:        instead of the actual toolchain.  Some packages are tricky,
                   5483:        and the only way to know for sure is the check
                   5484:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5485:        wrappers are being invoked.</p></li>
                   5486: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5487:        the package Makefile, e.g. Java VMs, standalone shells,
                   5488:        etc., because the code to symlink files into
                   5489:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5490:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5491:        </p></li>
                   5492: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5493:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5494:        package's Makefile are added as dependencies for that package.
                   5495:        </p></li>
1.75      rillig   5496: </ol></div>
1.87      wiz      5497: <p>If a dependency on a particular package is required for its libraries and
                   5498:     headers, then we replace:</p>
1.75      rillig   5499: <pre class="programlisting">
1.100     rillig   5500: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5501: </pre>
1.75      rillig   5502: <p>with</p>
                   5503: <pre class="programlisting">
1.100     rillig   5504: .include "../../category/foo/buildlink3.mk"
                   5505: </pre>
1.75      rillig   5506: <p>The buildlink3.mk files usually define the required dependencies.
                   5507:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5508:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5509: <pre class="programlisting">
1.100     rillig   5510: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5511: .include "../../category/foo/buildlink3.mk"
                   5512: </pre>
1.76      rillig   5513: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5514:     files in <code class="filename">pkgsrc/mk</code>
                   5515:     that handle special package issues:</p>
1.75      rillig   5516: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5517: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5518:        the native or a pkgsrc Berkeley DB implementation based on
                   5519:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5520:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5521: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5522:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5523:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76      rillig   5524: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5525:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5526:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5527:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5528: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5529:        system-provided Motif installation or adds a dependency on
1.91      rillig   5530:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.88      wiz      5531:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5532:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5533:        which Motif version will be used.</p></li>
1.76      rillig   5534: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5535:        variables that may be used by packages that use the
                   5536:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5537: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5538:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5539:        the file for more information.</p></li>
1.76      rillig   5540: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5541:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5542:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76      rillig   5543: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5544:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5545:        library.</p></li>
1.75      rillig   5546: </ul></div>
1.76      rillig   5547: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5548:     files provide a more complete
                   5549:     description of how to use them properly.</p>
1.75      rillig   5550: </div>
                   5551: <div class="sect1" lang="en">
                   5552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5553: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5554: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5555:     included by Makefiles to indicate the need to compile and link
                   5556:     against header files and libraries provided by the package.  A
                   5557:     <code class="filename">buildlink3.mk</code> file should always provide
                   5558:     enough information to add the correct type of dependency
                   5559:     relationship and include any other
                   5560:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5561:     headers and libraries that it needs in turn.</p>
                   5562: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5563:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5564:     package is highly recommended.  For most packages, the following
                   5565:     command will generate a good starting point for
                   5566:     <code class="filename">buildlink3.mk</code> files:</p>
                   5567: <pre class="screen">
                   5568: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5569: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5570:     </pre>
1.75      rillig   5571: <div class="sect2" lang="en">
                   5572: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5573: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5574: <p>The following real-life example
1.87      wiz      5575:       <code class="filename">buildlink3.mk</code> is taken
                   5576:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5577: <pre class="programlisting">
1.120     snj      5578: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    5579: 
1.120     snj      5580: BUILDLINK_TREE+=       tiff
1.1       grant    5581: 
1.120     snj      5582: .if !defined(TIFF_BUILDLINK3_MK)
                   5583: TIFF_BUILDLINK3_MK:=
1.87      wiz      5584: 
1.120     snj      5585: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5586: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5587: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.87      wiz      5588: 
1.100     rillig   5589: .include "../../devel/zlib/buildlink3.mk"
                   5590: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      5591: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      5592: 
1.120     snj      5593: BUILDLINK_TREE+=       -tiff
1.100     rillig   5594: </pre>
1.87      wiz      5595: <p>The header and footer manipulate
1.120     snj      5596:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      5597:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      5598:       the dependency tree.</p>
                   5599: <p>The main section is protected from multiple inclusion
1.87      wiz      5600:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5601:       added.  Several important variables are set in the section:</p>
                   5602: <div class="itemizedlist"><ul type="disc">
                   5603: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5604:          is the actual dependency recorded in the installed
                   5605:          package; this should always be set using
1.110     hubertf  5606:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5607:          we're appending to any pre-existing list of values.  This
                   5608:          variable should be set to the first version of the
                   5609:          package that had an API change.
                   5610:          </p></li>
                   5611: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5612:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5613:          pkgsrc directory.</p></li>
                   5614: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5615:          (not shown above) controls whether we use
                   5616:          <code class="varname">BUILD_DEPENDS</code> or
                   5617:          <code class="varname">DEPENDS</code> to add the dependency on
                   5618:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5619:          selected by setting
                   5620:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5621:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5622:          used.</p></li>
                   5623: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5624:            and
                   5625:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5626:            (not shown above) are lists of subdirectories of
1.76      rillig   5627:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5628:            to add to the header and library search paths.  These
                   5629:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5630:          respectively.</p></li>
                   5631: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5632:            (not shown above) is the list of preprocessor flags to add
                   5633:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5634:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5635:            should be avoided and instead be handled using
                   5636:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5637:          above.</p></li>
1.75      rillig   5638: </ul></div>
1.87      wiz      5639: <p>The following variables are all optionally defined within
                   5640:       this second section (protected against multiple inclusion) and
                   5641:       control which package files are symlinked into
                   5642:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5643:       transformed during the symlinking:</p>
1.75      rillig   5644: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5645: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5646:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5647:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5648:            to be symlinked into
1.76      rillig   5649:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5650:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5651: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5652:            (not shown above) is a shell pipeline that
                   5653:            outputs to stdout a list of files relative to
                   5654:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5655:            The resulting files are to be symlinked
                   5656:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5657:            this takes the <code class="filename">+CONTENTS</code> of a
                   5658:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5659:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5660: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5661:            (not shown above) is a filter command that filters
1.76      rillig   5662:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5663:            relative to
1.76      rillig   5664:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5665:            on stdout.  By default for overwrite packages,
                   5666:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5667:            outputs the contents of the <code class="filename">include</code>
                   5668:            and <code class="filename">lib</code> directories in the package
                   5669:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5670:            it outputs any libtool archives in
1.87      wiz      5671:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5672: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5673:            (not shown above) is a list of sed arguments used to
                   5674:            transform the name of the source filename into a
1.110     hubertf  5675:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5676:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5677: </ul></div>
1.120     snj      5678: <p>This section can additionally include any
1.87      wiz      5679:       <code class="filename">buildlink3.mk</code> needed for
                   5680:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5681:       Including these <code class="filename">buildlink3.mk</code> files
                   5682:       means that the headers and libraries for these
                   5683:       dependencies are also symlinked into
                   5684:       <code class="filename">${BUILDLINK_DIR}</code>
                   5685:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5686:       <code class="filename">buildlink3.mk</code>
1.120     snj      5687:       file is included. Dependencies are only added for directly
                   5688:       include <code class="filename">buildlink3.mk</code> files.</p>
1.75      rillig   5689: </div>
                   5690: <div class="sect2" lang="en">
                   5691: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5692: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87      wiz      5693: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5694:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5695:        after a package update is when the API or interface to the
1.87      wiz      5696:       header files change.</p>
                   5697: <p>In this case,
                   5698:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5699:       should be adjusted to require at least the new package
                   5700:       version.  In some cases, the packages that depend on this new
                   5701:       version may need their <code class="varname">PKGREVISION</code>s
                   5702:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5703:       files, their
                   5704:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5705:       adjusted, too.  This is needed so pkgsrc will require the
                   5706:       correct package dependency and not settle for an older one
                   5707:       when building the source.</p>
                   5708: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5709:        should be increased when the binary interface or sonames
                   5710:        (major number of the library version) of any installed
                   5711:        shared libraries change.  This is needed so that binary
                   5712:        packages made using it will require the correct package
                   5713:        dependency and not settle for an older one which will not
1.87      wiz      5714:       contain the necessary shared libraries.</p>
1.110     hubertf  5715: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5716:        more information about dependencies on other packages,
                   5717:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5718:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5719: <p>Please take careful consideration before adjusting
                   5720:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5721:       or
                   5722:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5723:       as we don't want to cause unneeded package deletions and
                   5724:       rebuilds.  In many cases, new versions of packages work just
                   5725:       fine with older dependencies.</p>
                   5726: <p>Also it is not needed to set
1.75      rillig   5727:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5728:        when it is identical to
1.87      wiz      5729:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5730: </div>
                   5731: </div>
                   5732: <div class="sect1" lang="en">
                   5733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5734: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5735: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5736:       coincide with headers and libraries present in the base system.
1.76      rillig   5737:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5738:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5739:       file that includes the necessary checks to decide whether using
                   5740:       the built-in software or the pkgsrc software is
1.87      wiz      5741:     appropriate.</p>
                   5742: <p>The only requirements of a builtin.mk file for
                   5743:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5744: <div class="orderedlist"><ol type="1">
1.87      wiz      5745: <li><p>It should set
                   5746:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5747:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5748:        after it is included.</p></li>
                   5749: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5750:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5751:        which is already set before the
                   5752:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5753: <li><p>It should be written to allow multiple inclusion.  This
                   5754:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5755:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5756: </ol></div>
                   5757: <div class="sect2" lang="en">
                   5758: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5759: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5760: <p>The following is the recommended template for builtin.mk
1.87      wiz      5761:       files:</p>
1.75      rillig   5762: <pre class="programlisting">
1.100     rillig   5763: .if !defined(IS_BUILTIN.foo)
                   5764: #
                   5765: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5766: # genuinely exists in the system or not.
                   5767: #
                   5768: IS_BUILTIN.foo?=        no
                   5769: 
                   5770: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5771: # version can be determined.
                   5772: #
                   5773: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5774: BUILTIN_PKG.foo?=       foo-1.0
                   5775: .  endif
                   5776: .endif  # IS_BUILTIN.foo
                   5777: 
                   5778: .if !defined(USE_BUILTIN.foo)
                   5779: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5780: .  if defined(BUILTIN_PKG.foo)
                   5781: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5782: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5783: USE_BUILTIN.foo!=                                                       \
                   5784:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5785:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5786: .      endif
                   5787: .    endfor
                   5788: .  endif
                   5789: .endif  # USE_BUILTIN.foo
                   5790: 
                   5791: CHECK_BUILTIN.foo?=     no
                   5792: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5793: #
                   5794: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5795: # "yes" or "no".
                   5796: #
                   5797: .endif  # CHECK_BUILTIN.foo
                   5798: </pre>
1.87      wiz      5799: <p>The first section sets
                   5800:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5801:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5802:       in the base system.  This should not be a base system software
                   5803:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5804:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5805:       included as part of the base system.  This variable is only
                   5806:       used internally within the <code class="filename">builtin.mk</code>
                   5807:       file.</p>
                   5808: <p>The second section sets
                   5809:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5810:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5811:       system if it exists (if
                   5812:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5813:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5814:       within the <code class="filename">builtin.mk</code> file.</p>
                   5815: <p>The third section sets
                   5816:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5817:       and is <span class="emphasis"><em>required</em></span> in all
                   5818:       <code class="filename">builtin.mk</code> files.  The code in this
                   5819:       section must make the determination whether the built-in
                   5820:       software is adequate to satisfy the dependencies listed in
                   5821:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5822:       This is typically done by comparing
                   5823:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5824:       against each of the dependencies in
                   5825:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5826:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5827:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5828:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5829:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5830:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5831:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5832:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5833:       that the built-in version of the software is similar enough to
                   5834:       be used as a replacement.</p>
                   5835: <p>The last section is guarded by
                   5836:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5837:       and includes code that uses the value of
                   5838:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5839:       set in the previous section.  This typically includes, e.g.,
                   5840:       adding additional dependency restrictions and listing additional
                   5841:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5842:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5843: </div>
                   5844: <div class="sect2" lang="en">
                   5845: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5846: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5847: <p>When building packages, it's possible to choose whether to set
                   5848:        a global preference for using either the built-in (native)
                   5849:        version or the pkgsrc version of software to satisfy a
                   5850:        dependency.  This is controlled by setting
                   5851:        <code class="varname">PREFER_PKGSRC</code> and
                   5852:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5853:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5854:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5855:        use the pkgsrc versions of software, while
                   5856:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5857:        built-in versions.  Preferences are determined by the most
                   5858:        specific instance of the package in either
                   5859:        <code class="varname">PREFER_PKGSRC</code> or
                   5860:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5861:        in neither or in both variables, then
                   5862:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5863:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5864:        using pkgsrc versions of software for all but the most basic
                   5865:       bits on a NetBSD system, you can set:</p>
                   5866: <pre class="programlisting">
1.100     rillig   5867: PREFER_PKGSRC=  yes
                   5868: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5869: </pre>
1.87      wiz      5870: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5871:       <code class="filename">builtin.mk</code>
                   5872:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5873:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5874: </div>
                   5875: </div>
                   5876: </div>
                   5877: <div class="chapter" lang="en">
                   5878: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5879: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5880: <div class="toc">
                   5881: <p><b>Table of Contents</b></p>
                   5882: <dl>
1.106     rillig   5883: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5884: <dd><dl>
1.106     rillig   5885: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5886: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5887: </dl></dd>
1.106     rillig   5888: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5889: <dd><dl>
1.122   ! reed     5890: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   5891: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5892: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5893: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5894: </dl></dd>
                   5895: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5896: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5897: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5898: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5899: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5900: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5901: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5902: </dl>
                   5903: </div>
                   5904: <p>This chapter describes the framework known as
                   5905: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5906: <div class="itemizedlist"><ul type="disc">
                   5907: <li><p>Generic installation and manipulation of directories and files
                   5908:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5909: <li><p>Automatic handling of configuration files during installation,
                   5910:     provided that packages are correctly designed.</p></li>
                   5911: <li><p>Generation and installation of system startup scripts.</p></li>
                   5912: <li><p>Registration of system users and groups.</p></li>
                   5913: <li><p>Registration of system shells.</p></li>
                   5914: <li><p>Automatic updating of fonts databases.</p></li>
                   5915: </ul></div>
                   5916: <p>The following sections inspect each of the above points in detail.</p>
                   5917: <p>You may be thinking that many of the things described here could be
                   5918: easily done with simple code in the package's post-installation target
                   5919: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5920: as the code in them is only executed when building from source.  Machines
                   5921: using binary packages could not benefit from it at all (as the code itself
                   5922: could be unavailable).  Therefore, the only way to achieve any of the items
                   5923: described above is by means of the installation scripts, which are
                   5924: automatically generated by pkginstall.</p>
                   5925: <div class="sect1" lang="en">
                   5926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5927: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5928: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5929: of files and directories that belong to a package.  The names used in it
1.76      rillig   5930: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5931: which means that it cannot register files outside this directory (absolute
                   5932: path names are not allowed).  Despite this restriction, some packages need
                   5933: to install files outside this location; e.g., under
1.76      rillig   5934: <code class="filename">${VARBASE}</code> or
1.87      wiz      5935: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5936: is to create such files during installation time by using
                   5937: installation scripts.</p>
                   5938: <p>The generic installation scripts are shell scripts that can
                   5939: contain arbitrary code.  The list of scripts to execute is taken from
                   5940: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5941: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5942: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5943: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5944: commands, so they have the potential to create and manage files
                   5945: anywhere in the file system.</p>
                   5946: <p>Using these general installation files is not recommended, but
                   5947: may be needed in some special cases.  One reason for avoiding them is
                   5948: that the user has to trust the packager that there is no unwanted or
                   5949: simply erroneous code included in the installation script. Also,
                   5950: previously there were many similar scripts for the same functionality,
                   5951: and fixing a common error involved finding and changing all of
                   5952: them.</p>
                   5953: <p>The pkginstall framework offers another, standardized way.  It
                   5954: provides generic scripts to abstract the manipulation of such files
                   5955: and directories based on variables set in the package's
                   5956: <code class="filename">Makefile</code>.  The rest of this section describes
                   5957: these variables.</p>
1.75      rillig   5958: <div class="sect2" lang="en">
                   5959: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5960: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5961: <p>The following variables can be set to request the creation of
                   5962: directories anywhere in the file system:</p>
                   5963: <div class="itemizedlist"><ul type="disc">
                   5964: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5965:     contain a list of directories that should be created and should attempt
                   5966:     to be destroyed by the installation scripts.  The difference between
                   5967:     the two is that the latter prompts the administrator to remove any
                   5968:     directories that may be left after deinstallation (because they were
                   5969:     not empty), while the former does not.</p></li>
                   5970: <li>
                   5971: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5972:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5973:     which directories should be created and should attempt to be destroyed
                   5974:     by the installation scripts.  Each tuple holds the following values,
                   5975:     separated by spaces: the directory name, its owner, its group and its
                   5976:     numerical mode.  For example:</p>
                   5977: <pre class="programlisting">
1.100     rillig   5978: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5979: </pre>
1.75      rillig   5980: <p>The difference between the two is exactly the same as their
                   5981:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5982: </li>
                   5983: </ul></div>
                   5984: </div>
                   5985: <div class="sect2" lang="en">
                   5986: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5987: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5988: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5989: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5990: To overcome this problem, the only solution is to extract the file in the
                   5991: known place (i.e., inside the installation prefix) and copy it to the
                   5992: appropriate location during installation (done by the installation scripts
                   5993: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5994: file</em></span> in the following paragraphs, which describe the variables
                   5995: that can be used to automatically and consistently handle files outside the
                   5996: installation prefix:</p>
                   5997: <div class="itemizedlist"><ul type="disc">
                   5998: <li>
                   5999: <p><code class="varname">CONF_FILES</code> and
                   6000:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   6001:     During installation time, the master file is copied to the target one
                   6002:     if and only if the latter does not exist.  Upon deinstallation, the
                   6003:     target file is removed provided that it was not modified by the
                   6004:     installation.</p>
                   6005: <p>The difference between the two is that the latter prompts the
                   6006:     administrator to remove any files that may be left after
                   6007:     deinstallation (because they were not empty), while the former does
                   6008:     not.</p>
                   6009: </li>
                   6010: <li>
                   6011: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6012:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   6013:     files as well as their target locations.  For each of them, it also
                   6014:     specifies their owner, their group and their numeric permissions, in
                   6015:     this order.  For example:</p>
                   6016: <pre class="programlisting">
1.100     rillig   6017: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6018: </pre>
1.75      rillig   6019: <p>The difference between the two is exactly the same as their
                   6020:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6021: </li>
                   6022: </ul></div>
                   6023: </div>
                   6024: </div>
                   6025: <div class="sect1" lang="en">
                   6026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6027: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   6028: <p>Configuration files are special in the sense that they are installed
                   6029: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6030: need special treatment during installation (most of which is automated by
                   6031: pkginstall).  The main concept you must bear in mind is that files marked
                   6032: as configuration files are automatically copied to the right place (somewhere
                   6033: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6034: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6035: be removed if they have local modifications.  This ensures that
                   6036: administrators never lose any custom changes they may have made.</p>
                   6037: <div class="sect2" lang="en">
                   6038: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6039: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   6040: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6041: specifies where configuration files shall be installed.  Its contents are
                   6042: set based upon the following variables:</p>
                   6043: <div class="itemizedlist"><ul type="disc">
                   6044: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   6045:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   6046:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   6047:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   6048:     Packages must not use it directly.</p></li>
                   6049: <li>
                   6050: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6051:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6052:     for the package being built shall be installed.  The definition of this
                   6053:     variable only makes sense in the package's
1.76      rillig   6054:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   6055: <p>As an example, consider the Apache package,
1.91      rillig   6056:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75      rillig   6057:     configuration files under the
1.76      rillig   6058:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6059:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6060:     Makefile.</p>
                   6061: </li>
                   6062: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6063:     variable that holds this package's configuration directory (if
                   6064:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6065:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6066:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6067: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6068:     directory where the configuration files for the package identified by
                   6069:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6070: </ul></div>
                   6071: <p>Based on the above variables, pkginstall determines the value of
                   6072: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6073: variable that can be used within a package to refer to its configuration
                   6074: directory.  The algorithm used to set its value is basically the
                   6075: following:</p>
                   6076: <div class="orderedlist"><ol type="1">
                   6077: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6078:     its value is used.</p></li>
                   6079: <li><p>If the previous variable is not defined but
                   6080:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6081:     <code class="filename">Makefile</code>, the resulting value is
                   6082:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   6083: <li><p>Otherwise, it is set to
1.76      rillig   6084:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6085: </ol></div>
1.76      rillig   6086: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  6087: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
                   6088: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6089: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   6090: </div>
                   6091: <div class="sect2" lang="en">
                   6092: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6093: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6094: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6095: known place, you need to teach each package where it shall install its
                   6096: files.  In some cases you will have to patch the package Makefiles to
                   6097: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6098: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6099: generated files:</p>
                   6100: <pre class="programlisting">
1.100     rillig   6101: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6102: </pre>
1.75      rillig   6103: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6104: for</em></span> its configuration files, not where they will be originally
                   6105: installed (although the difference is never explicit,
                   6106: unfortunately).</p>
                   6107: </div>
                   6108: <div class="sect2" lang="en">
                   6109: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6110: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6111: <p>As said before, pkginstall automatically handles configuration files.
                   6112: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6113: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6114: directly</strong></span>.  Bad news is that many software installation scripts
                   6115: will, out of the box, mess with the contents of that directory.  So what is
                   6116: the correct procedure to fix this issue?</p>
                   6117: <p>You must teach the package (usually by manually patching it) to
                   6118: install any configuration files under the examples hierarchy,
1.76      rillig   6119: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6120: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6121: has the original copies available.</p>
                   6122: <p>Once the required configuration files are in place (i.e., under the
                   6123: examples hierarchy), the pkginstall framework can use them as master copies
                   6124: during the package installation to update what is in
1.76      rillig   6125: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6126: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  6127: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   6128: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6129: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   6130: <pre class="programlisting">
1.100     rillig   6131: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6132: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6133: </pre>
1.75      rillig   6134: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6135: package and has no meaning outside it.</p>
                   6136: </div>
                   6137: <div class="sect2" lang="en">
                   6138: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6139: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6140: <p>The automatic copying of config files can be toggled by setting the
                   6141: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6142: installation.</p>
                   6143: </div>
                   6144: </div>
                   6145: <div class="sect1" lang="en">
                   6146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6147: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   6148: <p>System startup scripts are special files because they must be
                   6149: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  6150: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   6151: can be used.  However, pkginstall provides a special mechanism to handle
                   6152: these files.</p>
                   6153: <p>In order to provide system startup scripts, the package has
                   6154: to:</p>
                   6155: <div class="orderedlist"><ol type="1">
1.76      rillig   6156: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6157:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6158:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   6159:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6160: <li>
                   6161: <p>Tell pkginstall to handle it, appending the name of the script,
                   6162:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6163:     Continuing the previous example:</p>
                   6164: <pre class="programlisting">
1.100     rillig   6165: RCD_SCRIPTS+=   cupsd
1.1       grant    6166: </pre>
1.75      rillig   6167: </li>
                   6168: </ol></div>
                   6169: <p>Once this is done, pkginstall will do the following steps for each
                   6170: script in an automated fashion:</p>
                   6171: <div class="orderedlist"><ol type="1">
                   6172: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6173:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6174:     variable.</p></li>
                   6175: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6176:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6177:     that this master file must be explicitly registered in the
1.76      rillig   6178:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6179: <li><p>Add code to the installation scripts to copy the startup script
                   6180:     from the examples hierarchy into the system-wide startup scripts
                   6181:     directory.</p></li>
                   6182: </ol></div>
                   6183: <div class="sect2" lang="en">
                   6184: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6185: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6186: <p>The automatic copying of config files can be toggled by setting the
                   6187: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6188: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6189: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6190: matter what the value of this variable is.</p>
                   6191: </div>
                   6192: </div>
                   6193: <div class="sect1" lang="en">
                   6194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6195: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6196: <p>If a package needs to create special users and/or groups during
                   6197: installation, it can do so by using the pkginstall framework.</p>
                   6198: <p>Users can be created by adding entries to the
                   6199: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6200: syntax:</p>
                   6201: <pre class="programlisting">
1.100     rillig   6202: user:group
1.1       grant    6203: </pre>
1.87      wiz      6204: <p>Further specification of user details may be done by setting
                   6205: per-user variables.
                   6206: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6207: numeric UID for the user.
                   6208: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6209: user's description or comment.
                   6210: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6211: user's home directory, and defaults to
                   6212: <code class="filename">/nonexistent</code> if not specified.
                   6213: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6214: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6215: not specified.</p>
1.75      rillig   6216: <p>Similarly, groups can be created by adding entries to the
                   6217: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6218: <pre class="programlisting">
1.100     rillig   6219: group
1.1       grant    6220: </pre>
1.93      rillig   6221: <p>The numeric GID of the group may be set by defining
1.75      rillig   6222: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6223: <p>If a package needs to create the users and groups at an earlier
                   6224: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6225: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6226: indicate the phase before which the users and groups are created.  In
                   6227: this case, the numeric UIDs and GIDs of the created users and groups
                   6228: are automatically hardcoded into the final installation scripts.</p>
                   6229: </div>
                   6230: <div class="sect1" lang="en">
                   6231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6232: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6233: <p>Packages that install system shells should register them in the shell
1.76      rillig   6234: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6235: administrator.  This must be done from the installation scripts to keep
                   6236: binary packages working on any system.  pkginstall provides an easy way to
                   6237: accomplish this task.</p>
                   6238: <p>When a package provides a shell interpreter, it has to set the
                   6239: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6240: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6241: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   6242: <pre class="programlisting">
1.100     rillig   6243: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6244: </pre>
1.75      rillig   6245: <div class="sect2" lang="en">
                   6246: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6247: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6248: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6249: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6250: environment variable to <code class="literal">NO</code>.</p>
                   6251: </div>
                   6252: </div>
                   6253: <div class="sect1" lang="en">
                   6254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6255: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6256: <p>Packages that install X11 fonts should update the database files
                   6257: that index the fonts within each fonts directory.  This can easily be
                   6258: accomplished within the pkginstall framework.</p>
                   6259: <p>When a package installs X11 fonts, it must list the directories in
                   6260: which fonts are installed in the
                   6261: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6262: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6263: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6264: installation scripts to run the appropriate commands to update the fonts
                   6265: database files within each of those directories.  For convenience, if the
                   6266: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6267: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   6268: <pre class="programlisting">
1.100     rillig   6269: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6270: </pre>
1.75      rillig   6271: <div class="sect2" lang="en">
                   6272: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6273: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6274: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6275: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6276: environment variable to <code class="literal">NO</code>.</p>
                   6277: </div>
                   6278: </div>
                   6279: </div>
                   6280: <div class="chapter" lang="en">
                   6281: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6282: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6283: <div class="toc">
                   6284: <p><b>Table of Contents</b></p>
                   6285: <dl>
1.106     rillig   6286: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.122   ! reed     6287: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   6288: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6289: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6290: </dl>
                   6291: </div>
                   6292: <p>Many packages have the ability to be built to support different
1.76      rillig   6293: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6294: in pkgsrc that provides generic handling of those options that
                   6295: determine different ways in which the packages can be built.  It's
                   6296: possible for the user to specify exactly which sets of options will be
                   6297: built into a package or to allow a set of global default options
                   6298: apply.</p>
1.107     rillig   6299: <p>There are two broad classes of behaviors that one might want to
                   6300: control via options.  One is whether some particular feature is
                   6301: enabled in a program that will be built anyway, often by including or
                   6302: not including a dependency on some other package.  The other is
                   6303: whether or not an additional program will be built as part of the
                   6304: package.  Generally, it is better to make a split package for such
                   6305: additional programs instead of using options, because it enables
                   6306: binary packages to be built which can then be added separately.  For
                   6307: example, the foo package might have minimal dependencies (those
                   6308: packages without which foo doesn't make sense), and then the foo-gfoo
                   6309: package might include the GTK frontend program gfoo.  This is better
                   6310: than including a gtk option to foo that adds gfoo, because either that
                   6311: option is default, in which case binary users can't get foo without
                   6312: gfoo, or not default, in which case they can't get gfoo.  With split
                   6313: packages, they can install foo without having GTK, and later decide to
                   6314: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6315: source users too, avoiding the need for rebuilds.</p>
                   6316: <p>Plugins with widely varying dependencies should usually be split
                   6317: instead of options.</p>
                   6318: <p>It is often more work to maintain split packages, especially if
                   6319: the upstream package does not support this.  The decision of split
                   6320: vs. option should be made based on the likelihood that users will want
                   6321: or object to the various pieces, the size of the dependencies that are
                   6322: included, and the amount of work.</p>
                   6323: <p>A further consideration is licensing.  Non-free parts, or parts
                   6324: that depend on non-free dependencies (especially plugins) should
                   6325: almost always be split if feasible.</p>
1.75      rillig   6326: <div class="sect1" lang="en">
                   6327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6328: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6329: <p>Global default options are listed in
                   6330: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6331: that should be built into every package if that option is supported.
1.110     hubertf  6332: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6333: </div>
                   6334: <div class="sect1" lang="en">
                   6335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6336: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6337: </h2></div></div></div>
1.75      rillig   6338: <p>The following example shows how
1.76      rillig   6339: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6340: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6341: <code class="filename">Makefile</code>, or in a file,
                   6342: e.g. <code class="filename">options.mk</code>, that is included by the
                   6343: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6344: <pre class="programlisting">
1.100     rillig   6345: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6346: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6347: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6348: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6349: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6350: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6351: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6352: 
                   6353: .include "../../mk/bsd.prefs.mk"
                   6354: 
                   6355: # this package was previously named wibble2
                   6356: .if defined(PKG_OPTIONS.wibble2)
                   6357: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6358: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6359:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6360: .endif
                   6361: 
                   6362: .include "../../mk/bsd.options.mk"
                   6363: 
                   6364: # Package-specific option-handling
                   6365: 
                   6366: ###
                   6367: ### FOO support
                   6368: ###
                   6369: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6370: CONFIGURE_ARGS+=    --enable-foo
                   6371: .endif
                   6372: 
                   6373: ###
                   6374: ### LDAP support
                   6375: ###
                   6376: .if !empty(PKG_OPTIONS:Mldap)
                   6377: .  include "../../databases/openldap-client/buildlink3.mk"
                   6378: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6379: .endif
                   6380: 
                   6381: ###
                   6382: ### database support
                   6383: ###
                   6384: .if !empty(PKG_OPTIONS:Mmysql)
                   6385: .  include "../../mk/mysql.buildlink3.mk"
                   6386: .endif
                   6387: .if !empty(PKG_OPTIONS:Mpgsql)
                   6388: .  include "../../mk/pgsql.buildlink3.mk"
                   6389: .endif
1.75      rillig   6390: </pre>
                   6391: <p>The first section contains the information about which build
                   6392: options are supported by the package, and any default options settings
                   6393: if needed.</p>
                   6394: <div class="orderedlist"><ol type="1">
                   6395: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110     hubertf  6396: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6397: options.  It should be set to
1.78      rillig   6398: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6399: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6400: at the point where the options are processed.</p></li>
1.75      rillig   6401: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6402: build options supported by the package.</p></li>
                   6403: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6404: list of names of groups of mutually exclusive options.  The options in
                   6405: each group are listed in
                   6406: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6407: The most specific setting of any option from the group takes
                   6408: precedence over all other options in the group.  Options from the
                   6409: groups will be automatically added to
                   6410: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6411: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6412: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6413: packages will fail if no option from the group is
                   6414: selected.</p></li>
                   6415: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6416: of names of sets of options.  At least one option from each set must
                   6417: be selected.  The options in each set are listed in
                   6418: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6419: Options from the sets will be automatically added to
                   6420: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6421: fail if no option from the set is selected.</p></li>
                   6422: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6423: build options which are enabled by default.</p></li>
                   6424: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6425: of
                   6426: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.110     hubertf  6427: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6428: their option counterparts.  Pairs should be added with
                   6429: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6430: warning will be issued if the user uses a legacy
                   6431: variable.</p></li>
                   6432: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6433: of
                   6434: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6435: pairs that map options that have been renamed to their new
                   6436: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6437: the listing of global legacy options.  A warning will be issued if
                   6438: the user uses a legacy option.</p></li>
                   6439: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6440: options implied by deprecated variables used.  This can be used for
                   6441: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6442: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6443: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6444: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6445: a list of warnings about deprecated variables or options used, and
                   6446: what to use instead.</p></li>
                   6447: </ol></div>
                   6448: <p>A package should never modify
                   6449: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6450: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6451: To suggest a default set of options, use
                   6452: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6453: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6454: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6455: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6456: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6457: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6458: happen with platform-specific options if none of them is supported on
                   6459: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6460: empty list and the package is otherwise treated as not using the
                   6461: options framework.</p>
1.76      rillig   6462: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6463: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6464: build options, properly filtered to remove unsupported and duplicate
                   6465: options.</p>
                   6466: <p>The remaining sections contain the logic that is specific to
                   6467: each option.  The correct way to check for an option is to check
                   6468: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6469: <pre class="programlisting">
1.100     rillig   6470: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6471: </pre>
                   6472: </div>
                   6473: <div class="sect1" lang="en">
                   6474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6475: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6476: <p>Options that enable similar features in different packages (like
                   6477: optional support for a library) should use a common name in all
                   6478: packages that support it (like the name of the library).  If another
                   6479: package already has an option with the same meaning, use the same
                   6480: name.</p>
                   6481: <p>Options that enable features specific to one package, where it's
                   6482: unlikely that another (unrelated) package has the same (or a similar)
                   6483: optional feature, should use a name prefixed with
                   6484: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6485: <p>If a group of related packages share an optional feature
                   6486: specific to that group, prefix it with the name of the
                   6487: &#8220;<span class="quote">main</span>&#8221; package
                   6488: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6489: <p>For new options, add a line to
1.76      rillig   6490: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6491: fields, separated by tab.  The first field is the option name, the
                   6492: second its description.  The description should be a whole sentence
                   6493: (starting with an uppercase letter and ending with a period) that
                   6494: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6495: support.</span>&#8221; The file is sorted by option names.</p>
                   6496: </div>
1.107     rillig   6497: <div class="sect1" lang="en">
                   6498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6499: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6500: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6501: different dependencies based on the options with which the package was
                   6502: built. For querying these options, the file
                   6503: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6504: typical example looks like this:</p>
                   6505: <pre class="programlisting">
                   6506: pkgbase := libpurple
                   6507: .include "../../mk/pkg-build-options.mk"
                   6508: 
                   6509: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6510: ...
                   6511: .endif
                   6512: </pre>
                   6513: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6514: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6515: options of the libpurple package, which can then be queried like
                   6516: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6517: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6518: details.</p>
                   6519: </div>
1.75      rillig   6520: </div>
                   6521: <div class="chapter" lang="en">
                   6522: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6523: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6524: <div class="toc">
                   6525: <p><b>Table of Contents</b></p>
                   6526: <dl>
1.106     rillig   6527: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6528: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6529: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6530: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.122   ! reed     6531: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   6532: <dd><dl>
                   6533: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6534: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6535: </dl></dd>
1.122   ! reed     6536: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
        !          6537: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
        !          6538: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
        !          6539: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
        !          6540: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
        !          6541: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
        !          6542: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
        !          6543: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
        !          6544: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
        !          6545: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   6546: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6547: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6548: </dl>
                   6549: </div>
                   6550: <div class="sect1" lang="en">
                   6551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6552: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6553: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6554:     built. Building a package is separated into different
                   6555:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6556:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      6557:     described in the following sections. Each phase is split into
1.87      wiz      6558:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6559:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6560:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6561:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6562:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6563: <p>Never override the regular targets (like
                   6564:     <code class="varname">fetch</code>), if you have to, override the
                   6565:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6566: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6567:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6568:     the local system and then extracted. After any pkgsrc-specific patches
                   6569:     to compile properly are applied, the software can be configured, then
                   6570:     built (usually by compiling), and finally the generated binaries, etc.
                   6571:     can be put into place on the system.</p>
1.97      rillig   6572: <p>To get more details about what is happening at each step,
                   6573:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6574:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6575:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6576: </div>
                   6577: <div class="sect1" lang="en">
                   6578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6579: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6580: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6581:     the next section, here's a brief discussion on where programs are
                   6582:     installed, and which variables influence this.</p>
1.75      rillig   6583: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6584:     where all files of the final program shall be installed. It is
                   6585:     usually set to <code class="varname">LOCALBASE</code>
                   6586:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6587:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6588:     <code class="varname">PREFIX</code> needs to be put
                   6589:     into the various places in the program's source where paths to
1.110     hubertf  6590:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6591: <p>When choosing which of these variables to use,
1.87      wiz      6592:     follow the following rules:</p>
1.75      rillig   6593: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6594: <li><p><code class="varname">PREFIX</code> always points to the location
                   6595:        where the current pkg will be installed.  When referring to a
                   6596:        pkg's own installation path, use
                   6597:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6598: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6599:        are installed.  If you need to construct a -I or -L argument
                   6600:        to the compiler to find includes and libraries installed by
                   6601:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6602:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6603:        installed all packages in <code class="filename">/usr/local</code>. As
                   6604:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6605:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6606: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6607:        distribution (from xsrc, etc.) is installed. When looking for
                   6608:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6609:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6610: <li>
                   6611: <p>X11-based packages are special in that they may be
                   6612:        installed in either <code class="varname">X11BASE</code> or
                   6613:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6614: <p>Usually, X11 packages should be installed under
1.88      wiz      6615:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6616:        will need to include
                   6617:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6618:        request the presence of X11 and to get the right compilation
                   6619:        flags.</p>
1.75      rillig   6620: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6621:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6622:        files. These packages are special and they must be placed under
                   6623:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6624:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6625:        your package.</p>
1.75      rillig   6626: <p>Some notes: If you need
1.87      wiz      6627:        to find includes or libraries installed by a pkg that has
                   6628:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6629:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6630:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6631:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6632:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6633:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87      wiz      6634:        is enabled by default.</p>
1.75      rillig   6635: </li>
1.88      wiz      6636: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6637:        the installed location of an X11
                   6638:        package. <code class="varname">X11PREFIX</code> will be set to
                   6639:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6640:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6641:        installed.</p></li>
                   6642: <li>
                   6643: <p>If xpkgwedge is installed, it is possible to have some
                   6644:        packages installed in <code class="varname">X11BASE</code> and some in
                   6645:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6646:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6647:        definition can be used. It takes pairs in the format
1.110     hubertf  6648:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6649:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6650:        of the installed package &lt;package&gt;, or
                   6651:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6652:        installed.</p>
1.75      rillig   6653: <p>This is best illustrated by example.</p>
                   6654: <p>The following lines are taken from
1.87      wiz      6655:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6656: <pre class="programlisting">
1.100     rillig   6657: EVAL_PREFIX+=           GTKDIR=gtk+
                   6658: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6659: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6660: CONFIGURE_ARGS+=        --enable-multibyte
                   6661: </pre>
1.88      wiz      6662: <p>Specific defaults can be defined for the packages
                   6663:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6664:        definition of the form:</p>
1.75      rillig   6665: <pre class="programlisting">
1.100     rillig   6666: GTKDIR_DEFAULT= ${LOCALBASE}
                   6667: </pre>
1.75      rillig   6668: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6669:        to the first definition in
                   6670:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6671: </li>
1.76      rillig   6672: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110     hubertf  6673:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6674:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6675:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6676: </ul></div>
                   6677: </div>
                   6678: <div class="sect1" lang="en">
                   6679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6680: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6681: <p>When building a package, various directories are used to store
1.87      wiz      6682:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6683:     directories are explained here.</p>
1.75      rillig   6684: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6685:     are two common base directories for these relative directories:
                   6686:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6687:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6688:     inside the package itself.</p>
1.75      rillig   6689: <div class="variablelist"><dl>
                   6690: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6691: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6692:       root directory. Generally, you don't need
                   6693:       it.</p></dd>
1.97      rillig   6694: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6695: <dd><p>This is an absolute pathname that points to the
                   6696:       current package.</p></dd>
1.75      rillig   6697: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6698: <dd><p>This is a pathname relative to
1.87      wiz      6699:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6700:       package.</p></dd>
1.75      rillig   6701: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6702: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6703:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6704:       directory. It also contains temporary directories and log files used by
                   6705:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6706:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6707: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6708: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6709:       where the distfiles are extracted. It is usually a direct subdirectory
                   6710:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6711:       that isn't hidden. This variable may be changed by a package
                   6712:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6713: </dl></div>
1.114     jmcneill 6714: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6715:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6716:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6717:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6718:     If users would like to have their pkgsrc trees behave in a
                   6719:     read-only manner, then the value of
                   6720:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6721:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6722: </div>
                   6723: <div class="sect1" lang="en">
                   6724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6725: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6726: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6727:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6728:     phase. This will automatically run all phases that are required for this
                   6729:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6730:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6731:     the package will be built, but not installed.</p>
1.75      rillig   6732: </div>
                   6733: <div class="sect1" lang="en">
                   6734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6735: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6736: <p>The first step in building a package is to fetch the
1.88      wiz      6737:     distribution files (distfiles) from the sites that are providing
                   6738:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6739:     phase.</p>
1.81      rillig   6740: <div class="sect2" lang="en">
                   6741: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6742: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6743: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6744:       defines all URLs from where the distfile, whose name is
                   6745:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6746:       fetched. The more complicated cases are described
                   6747:       below.</p>
                   6748: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6749:       the list of distfiles that have to be fetched. Its value
                   6750:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6751:       so that most packages don't need to define it at all.
                   6752:       <code class="varname">EXTRACT_SUFX</code> is
                   6753:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6754:       freely. Note that if your package requires additional
                   6755:       distfiles to the default one, you cannot just append the
                   6756:       additional filenames using the <code class="literal">+=</code>
                   6757:       operator, but you have write for example:</p>
1.81      rillig   6758: <pre class="programlisting">
1.100     rillig   6759: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6760: </pre>
1.88      wiz      6761: <p>Each distfile is fetched from a list of sites, usually
                   6762:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6763:       <code class="varname">DISTFILES</code> or multiple
                   6764:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6765:       set
                   6766:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6767:       to the list of URLs where the file
                   6768:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6769:       (including the suffix) can be found.</p>
                   6770: <pre class="programlisting">
1.100     rillig   6771: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6772: DISTFILES+=     foo-file.tar.gz
                   6773: SITES.foo-file.tar.gz= \
                   6774: http://www.somewhere.com/somehow/ \
                   6775: http://www.somewhereelse.com/mirror/somehow/
                   6776: </pre>
1.81      rillig   6777: <p>When actually fetching the distfiles, each item from
1.88      wiz      6778:       <code class="varname">MASTER_SITES</code> or
                   6779:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6780:       appended to it, without an intermediate slash. Therefore,
                   6781:       all site values have to end with a slash or other separator
                   6782:       character. This allows for example to set
                   6783:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6784:       that gets the name of the distfile as a parameter. In this
                   6785:       case, the definition would look like:</p>
1.81      rillig   6786: <pre class="programlisting">
1.100     rillig   6787: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6788: </pre>
1.81      rillig   6789: <p>There are some predefined values for
1.88      wiz      6790:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6791:       packages.  The names of the variables should speak for
                   6792:       themselves.</p>
                   6793: <pre class="programlisting">
1.100     rillig   6794: ${MASTER_SITE_APACHE}
                   6795: ${MASTER_SITE_BACKUP}
                   6796: ${MASTER_SITE_CYGWIN}
                   6797: ${MASTER_SITE_DEBIAN}
                   6798: ${MASTER_SITE_FREEBSD}
                   6799: ${MASTER_SITE_FREEBSD_LOCAL}
                   6800: ${MASTER_SITE_GENTOO}
                   6801: ${MASTER_SITE_GNOME}
                   6802: ${MASTER_SITE_GNU}
                   6803: ${MASTER_SITE_GNUSTEP}
                   6804: ${MASTER_SITE_IFARCHIVE}
                   6805: ${MASTER_SITE_KDE}
                   6806: ${MASTER_SITE_MOZILLA}
                   6807: ${MASTER_SITE_MYSQL}
                   6808: ${MASTER_SITE_OPENOFFICE}
                   6809: ${MASTER_SITE_PERL_CPAN}
                   6810: ${MASTER_SITE_PGSQL}
                   6811: ${MASTER_SITE_R_CRAN}
                   6812: ${MASTER_SITE_SOURCEFORGE}
                   6813: ${MASTER_SITE_SOURCEFORGE_JP}
                   6814: ${MASTER_SITE_SUNSITE}
                   6815: ${MASTER_SITE_SUSE}
                   6816: ${MASTER_SITE_TEX_CTAN}
                   6817: ${MASTER_SITE_XCONTRIB}
                   6818: ${MASTER_SITE_XEMACS}
                   6819: </pre>
1.88      wiz      6820: <p>Some explanations for the less self-explaining ones:
                   6821:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110     hubertf  6822:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   6823:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6824: <p>If you choose one of these predefined sites, you may
                   6825:       want to specify a subdirectory of that site. Since these
                   6826:       macros may expand to more than one actual site, you
                   6827:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6828:       specify a subdirectory:</p>
1.81      rillig   6829: <pre class="programlisting">
1.100     rillig   6830: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6831: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6832: </pre>
1.81      rillig   6833: <p>Note the trailing slash after the subdirectory
1.88      wiz      6834:       name.</p>
1.81      rillig   6835: </div>
                   6836: <div class="sect2" lang="en">
                   6837: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6838: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6839: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6840:       all the distfiles exist in a local directory
1.93      rillig   6841:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6842:       user). If the files do not exist, they are fetched using
                   6843:       commands of the form</p>
1.75      rillig   6844: <pre class="programlisting">
1.100     rillig   6845: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6846: </pre>
1.88      wiz      6847: <p>where <code class="literal">${site}</code> varies through
                   6848:       several possibilities in turn: first,
                   6849:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6850:       sites specified in either <code class="varname">SITES.file</code> if
                   6851:       defined, else <code class="varname">MASTER_SITES</code> or
                   6852:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6853:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6854:       all except the first and the last can be optionally sorted
                   6855:       by the user, via setting either
                   6856:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6857:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6858:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6859: <p> The specific command and arguments used depend on the
                   6860:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6861:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6862: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6863:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6864:       distfiles, if they are freely distributable.  Packages setting
                   6865:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6866:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6867:       mirrored.</p>
1.81      rillig   6868: </div>
1.75      rillig   6869: </div>
                   6870: <div class="sect1" lang="en">
                   6871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6872: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6873: <p>After the distfile(s) are fetched, their checksum is
                   6874:     generated and compared with the checksums stored in the
                   6875:     distinfo file. If the checksums don't match, the build is
                   6876:     aborted. This is to ensure the same distfile is used for
                   6877:     building, and that the distfile wasn't changed, e.g. by some
                   6878:     malign force, deliberately changed distfiles on the master
                   6879:     distribution site or network lossage.</p>
1.75      rillig   6880: </div>
                   6881: <div class="sect1" lang="en">
                   6882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6883: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6884: <p>When the distfiles are present on the local system, they
1.88      wiz      6885:     need to be extracted, as they usually come in the form of some
                   6886:     compressed archive format.</p>
1.75      rillig   6887: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6888:     extracted. If you only need some of them, you can set the
                   6889:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6890:     files.</p>
                   6891: <p>Extracting the files is usually done by a little
1.93      rillig   6892:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6893:     already knows how to extract various archive formats, so most
                   6894:     likely you will not need to change anything here. But if you
                   6895:     need, the following variables may help you:</p>
1.75      rillig   6896: <div class="variablelist"><dl>
                   6897: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6898: <dd><p>Use these variables to override the default
1.88      wiz      6899:       options for an extract command, which are defined in
1.93      rillig   6900:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6901: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6902: <dd><p>This variable can be set to
1.114     jmcneill 6903:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6904:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6905:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6906:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6907:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6908: </dl></div>
1.88      wiz      6909: <p>If the <code class="filename">extract</code> program doesn't
                   6910:     serve your needs, you can also override the
                   6911:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6912:     command used for extracting the files. This command is
                   6913:     executed in the <code class="filename">${WRKSRC}</code>
                   6914:     directory. During execution of this command, the shell
                   6915:     variable <code class="varname">extract_file</code> holds the absolute
                   6916:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6917: <p>And if that still does not suffice, you can override the
1.88      wiz      6918:     <code class="varname">do-extract</code> target in the package
                   6919:     Makefile.</p>
1.75      rillig   6920: </div>
                   6921: <div class="sect1" lang="en">
                   6922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6923: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6924: <p>After extraction, all the patches named by the
1.88      wiz      6925:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6926:     subdirectory of the package as well as in
                   6927:     $LOCALPATCHES/$PKGPATH (e.g.
                   6928:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6929:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6930:     <code class="filename">.gz</code> are uncompressed before they are
                   6931:     applied, files ending in <code class="filename">.orig</code> or
                   6932:     <code class="filename">.rej</code> are ignored. Any special options to
1.110     hubertf  6933:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
                   6934:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
                   6935: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6936:     it fail if the patches apply with some lines of fuzz. Please
                   6937:     fix (regen) the patches so that they apply cleanly. The
                   6938:     rationale behind this is that patches that don't apply cleanly
                   6939:     may end up being applied in the wrong place, and cause severe
                   6940:     harm there.</p>
1.75      rillig   6941: </div>
                   6942: <div class="sect1" lang="en">
                   6943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6944: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6945: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88      wiz      6946:     </p>
1.75      rillig   6947: </div>
                   6948: <div class="sect1" lang="en">
                   6949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6950: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6951: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6952:     linkers. The following variables can be used to tweak the
                   6953:     wrappers.</p>
1.75      rillig   6954: <div class="variablelist"><dl>
                   6955: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6956: <dd><p>The command used to print progress
1.88      wiz      6957:       messages. Does nothing by default. Set to
                   6958:       <code class="literal">${ECHO}</code> to see the progress
                   6959:       messages.</p></dd>
1.75      rillig   6960: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6961: <dd><p>This variable can be set to
1.88      wiz      6962:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6963:       depending on whether you want additional information in the
                   6964:       wrapper log file.</p></dd>
1.75      rillig   6965: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6966: <dd><p>This variable can be set to
1.88      wiz      6967:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6968:       on whether the wrapper should use its cache, which will
                   6969:       improve the speed. The default value is
                   6970:       <code class="literal">yes</code>, but is forced to
                   6971:       <code class="literal">no</code> if the platform does not support
                   6972:       it.</p></dd>
1.75      rillig   6973: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6974: <dd><p>A list of reordering commands. A reordering
                   6975:       command has the form
                   6976:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6977:       It ensures that that
                   6978:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6979:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6980:       </p></dd>
1.75      rillig   6981: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6982: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6983:       investigate further]</p></dd>
1.75      rillig   6984: </dl></div>
                   6985: </div>
                   6986: <div class="sect1" lang="en">
                   6987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6988: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6989: <p>Most pieces of software need information on the header
                   6990:     files, system calls, and library routines which are available
                   6991:     on the platform they run on. The process of determining this
                   6992:     information is known as configuration, and is usually
                   6993:     automated. In most cases, a script is supplied with the
                   6994:     distfiles, and its invocation results in generation of header
                   6995:     files, Makefiles, etc.</p>
                   6996: <p>If the package contains a configure script, this can be
                   6997:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6998:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6999:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   7000:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   7001:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   7002: <pre class="programlisting">
1.100     rillig   7003: .for d in ${CONFIGURE_DIRS}
                   7004:         cd ${WRKSRC} \
                   7005:         &amp;&amp; cd ${d} \
                   7006:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   7007: .endfor
                   7008: </pre>
1.88      wiz      7009: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   7010:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7011:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   7012:     configure script is run with the environment
                   7013:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7014:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7015:     <code class="varname">CONFIGURE_ENV</code>,
                   7016:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   7017:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   7018:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7019:     package.</p>
                   7020: <p>If the program uses an <code class="filename">Imakefile</code>
                   7021:     for configuration, the appropriate steps can be invoked by
                   7022:     setting <code class="varname">USE_IMAKE</code> to
                   7023:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   7024:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   7025:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7026:     xmkmf's environment by adding them to the
                   7027:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   7028: <p>If the program uses <code class="filename">cmake</code>
                   7029:     for configuration, the appropriate steps can be invoked by
                   7030:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7031:     You can add variables to cmake's environment by adding them to the
                   7032:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7033:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7034:     The top directory argument is given by the
                   7035:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   7036:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   7037: <p>If there is no configure step at all, set
                   7038:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7039: </div>
                   7040: <div class="sect1" lang="en">
                   7041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7042: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      7043: <p>For building a package, a rough equivalent of the
                   7044:     following code is executed.</p>
1.75      rillig   7045: <pre class="programlisting">
1.100     rillig   7046: .for d in ${BUILD_DIRS}
                   7047:         cd ${WRKSRC} \
                   7048:         &amp;&amp; cd ${d} \
                   7049:         &amp;&amp; env ${MAKE_ENV} \
                   7050:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7051:                 -f ${MAKE_FILE} \
                   7052:                 ${BUILD_TARGET}
                   7053: .endfor
                   7054: </pre>
1.88      wiz      7055: <p><code class="varname">BUILD_DIRS</code> (default:
                   7056:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7057:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7058:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7059:     <code class="varname">MAKE_ENV</code> and arguments
                   7060:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7061:     <code class="varname">MAKE_ENV</code>,
                   7062:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7063:     <code class="varname">MAKE_FILE</code> and
                   7064:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7065:     package.</p>
1.75      rillig   7066: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      7067:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   7068:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   7069:     default value of <code class="varname">MAKE_FILE</code> is
                   7070:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   7071:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   7072: <p>If there is no build step at all, set
                   7073:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7074: </div>
                   7075: <div class="sect1" lang="en">
                   7076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7077: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   7078: <p>[TODO]</p>
                   7079: </div>
                   7080: <div class="sect1" lang="en">
                   7081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7082: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   7083: <p>Once the build stage has completed, the final step is to
1.88      wiz      7084:     install the software in public directories, so users can
                   7085:     access the programs and files.</p>
1.75      rillig   7086: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      7087:     equivalent of the following code is executed. Additionally,
                   7088:     before and after this code, much magic is performed to do
                   7089:     consistency checks, registering the package, and so on.</p>
                   7090: <pre class="programlisting">
1.100     rillig   7091: .for d in ${INSTALL_DIRS}
                   7092:         cd ${WRKSRC} \
                   7093:         &amp;&amp; cd ${d} \
                   7094:         &amp;&amp; env ${MAKE_ENV} \
                   7095:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7096:                 -f ${MAKE_FILE} \
                   7097:                 ${INSTALL_TARGET}
                   7098: .endfor
                   7099: </pre>
1.75      rillig   7100: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      7101:     <span class="emphasis"><em>build</em></span> phase.
                   7102:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7103:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   7104:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   7105:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   7106:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7107:     defined.</p>
1.75      rillig   7108: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      7109:     variables are useful. They are all variations of the
1.110     hubertf  7110:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      7111:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7112:     install command. The specialized variants, together with their
                   7113:     intended use, are:</p>
1.75      rillig   7114: <div class="variablelist"><dl>
                   7115: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      7116: <dd><p>directories that contain
                   7117:       binaries</p></dd>
1.75      rillig   7118: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7119: <dd><p>directories that contain
                   7120:       scripts</p></dd>
1.75      rillig   7121: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7122: <dd><p>directories that contain shared and static
                   7123:       libraries</p></dd>
1.75      rillig   7124: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7125: <dd><p>directories that contain data
                   7126:       files</p></dd>
1.75      rillig   7127: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7128: <dd><p>directories that contain man
                   7129:       pages</p></dd>
1.75      rillig   7130: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7131: <dd><p>binaries that can be stripped from debugging
                   7132:       symbols</p></dd>
1.75      rillig   7133: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7134: <dd><p>binaries that cannot be
                   7135:       stripped</p></dd>
1.75      rillig   7136: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7137: <dd><p>game
                   7138:       binaries</p></dd>
1.75      rillig   7139: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7140: <dd><p>shared and static
                   7141:       libraries</p></dd>
1.75      rillig   7142: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7143: <dd><p>data files</p></dd>
                   7144: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7145: <dd><p>data files for
                   7146:       games</p></dd>
1.75      rillig   7147: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7148: <dd><p>man pages</p></dd>
                   7149: </dl></div>
                   7150: <p>Some other variables are:</p>
                   7151: <div class="variablelist"><dl>
                   7152: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7153: <dd><p>A list of directories relative to
1.88      wiz      7154:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7155:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7156:       The package is supposed to create all needed directories itself
                   7157:       before installing files to it and list all other directories here.
                   7158:       </p></dd>
1.75      rillig   7159: </dl></div>
1.97      rillig   7160: <p>In the rare cases that a package shouldn't install anything,
                   7161:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7162:     mostly relevant for packages in the <code class="filename">regress</code>
                   7163:     category.</p>
1.75      rillig   7164: </div>
                   7165: <div class="sect1" lang="en">
                   7166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7167: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7168: <p>Once the install stage has completed, a binary package of
                   7169:     the installed files can be built.  These binary packages can be
                   7170:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  7171:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7172:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7173: <p>By default, the binary packages are created in
                   7174:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7175:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7176:     one for each category in the <code class="varname">CATEGORIES</code>
                   7177:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7178:     <code class="filename">pkgsrc/packages</code>.</p>
                   7179: </div>
                   7180: <div class="sect1" lang="en">
                   7181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7182: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7183: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7184:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7185:     to clean the work directories of all dependencies too, use
1.110     hubertf  7186:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7187: </div>
                   7188: <div class="sect1" lang="en">
                   7189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7190: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7191: <div class="variablelist"><dl>
                   7192: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7193: <dd><p>For any of the main targets described in the
                   7194:          previous section, two auxiliary targets exist with
1.87      wiz      7195:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7196:          prefix for the main target's name.  These targets are
1.88      wiz      7197:          invoked before and after the main target is called,
                   7198:          allowing extra configuration or installation steps be
                   7199:          performed from a package's Makefile, for example, which
                   7200:          a program's configure script or install target
                   7201:          omitted.</p></dd>
1.75      rillig   7202: <dt><span class="term">do-*</span></dt>
1.88      wiz      7203: <dd><p>Should one of the main targets do the wrong thing,
                   7204:          and should there be no variable to fix this, you can
                   7205:          redefine it with the do-* target.  (Note that redefining
                   7206:          the target itself instead of the do-* target is a bad
                   7207:          idea, as the pre-* and post-* targets won't be called
                   7208:          anymore, etc.) You will not usually need to do
                   7209:          this.</p></dd>
1.75      rillig   7210: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7211: <dd>
1.110     hubertf  7212: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7213:          you noticed some file was not installed properly, you
                   7214:          can repeat the installation with this target, which will
                   7215:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7216: <p>This is the default value of
                   7217:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7218:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7219:          package</strong></span>, where the defaults are
                   7220:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7221:          respectively.</p>
                   7222: </dd>
1.75      rillig   7223: <dt><span class="term">deinstall</span></dt>
                   7224: <dd>
1.110     hubertf  7225: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      7226:          current directory, effectively de-installing the
                   7227:          package. The following variables can be used to tune the
                   7228:          behaviour:</p>
1.75      rillig   7229: <div class="variablelist"><dl>
                   7230: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110     hubertf  7231: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   7232: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7233: <dd><p>Remove all packages that require (depend on)
                   7234:                the given package.  This can be used to remove any
                   7235:                packages that may have been pulled in by a given
1.110     hubertf  7236:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7237:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7238:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7239:                likely to remove whole KDE. Works by adding
1.110     hubertf  7240:                &#8220;<span class="quote">-R</span>&#8221; to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      7241:                command line.</p></dd>
1.75      rillig   7242: </dl></div>
                   7243: </dd>
1.88      wiz      7244: <dt><span class="term">bin-install</span></dt>
                   7245: <dd><p>Install a binary package from local disk and via FTP
                   7246:          from a list of sites (see the
                   7247:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7248:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7249:          available anywhere.  The arguments given to
1.110     hubertf  7250:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7251:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7252:          operation, etc.</p></dd>
1.75      rillig   7253: <dt><span class="term">update</span></dt>
                   7254: <dd>
1.88      wiz      7255: <p>This target causes the current package to be
                   7256:          updated to the latest version.  The package and all
                   7257:          depending packages first get de-installed, then current
                   7258:          versions of the corresponding packages get compiled and
                   7259:          installed.  This is similar to manually noting which
                   7260:          packages are currently installed, then performing a
1.110     hubertf  7261:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7262:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7263:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7264:          packages.</p>
                   7265: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.110     hubertf  7266:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7267:          update</strong></span> was interrupted for some reason.
                   7268:          However, in this case, make sure you don't call
1.110     hubertf  7269:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7270:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7271:          Otherwise, you lose the ability to automatically update
                   7272:          the current package along with the dependent packages
                   7273:          you have installed.</p>
1.110     hubertf  7274: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7275:          update</strong></span> will only work as long as the package
                   7276:          tree remains unchanged.  If the source code for one of
                   7277:          the packages to be updated has been changed, resuming
1.110     hubertf  7278:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7279:          fail!</p>
                   7280: <p>The following variables can be used either on the
1.110     hubertf  7281:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7282:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7283:          update</strong></span>:</p>
1.75      rillig   7284: <div class="variablelist"><dl>
                   7285: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7286: <dd><p>Install target to recursively use for the
                   7287:                updated package and the dependent packages.
                   7288:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7289:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.110     hubertf  7290:                <span class="command"><strong>make update</strong></span>.  Other good
1.88      wiz      7291:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7292:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7293:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7294:                endless loop!</p></dd>
1.75      rillig   7295: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7296: <dd><p>Don't clean up after updating.  Useful if
                   7297:                you want to leave the work sources of the updated
                   7298:                packages around for inspection or other purposes.
                   7299:                Be sure you eventually clean up the source tree
                   7300:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7301:                or you may run into troubles with old source code
                   7302:                still lying around on your next
1.110     hubertf  7303:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7304:                update</strong></span>.</p></dd>
1.75      rillig   7305: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7306: <dd><p>Deinstall each package before installing
                   7307:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7308:                may be necessary if the
                   7309:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.110     hubertf  7310:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7311:                update</strong></span>.</p></dd>
1.75      rillig   7312: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7313: <dd><p>Allows you to disable recursion and hardcode
                   7314:                the target for packages.  The default is
                   7315:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7316:                facilitating a recursive update of prerequisite
                   7317:                packages.  Only set
                   7318:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7319:                disable recursive updates. Use
                   7320:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7321:                set a specific target for each package to be
1.110     hubertf  7322:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7323:                (see above).</p></dd>
1.75      rillig   7324: </dl></div>
                   7325: </dd>
                   7326: <dt><span class="term">clean-update</span></dt>
                   7327: <dd>
1.88      wiz      7328: <p>Clean the source tree for all packages that would
1.110     hubertf  7329:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7330:          from the current directory.  This target should not be
                   7331:          used if the current package (or any of its depending
                   7332:          packages) have already been de-installed (e.g., after
1.110     hubertf  7333:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7334:          some packages you intended to update. As a rule of
                   7335:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7336:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7337:          and only if you have a dirty package tree (e.g., if you
                   7338:          used <code class="varname">NOCLEAN</code>).</p>
                   7339: <p>If you are unsure about whether your tree is
1.110     hubertf  7340:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7341:          clean</strong></span> at the top of the tree, or use the
                   7342:          following sequence of commands from the directory of the
                   7343:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7344:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7345:          time, otherwise you lose all the packages you wanted to
                   7346:          update!):</p>
1.87      wiz      7347: <pre class="screen">
                   7348: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7349: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7350: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7351:          </pre>
1.88      wiz      7352: <p>The following variables can be used either on the
1.110     hubertf  7353:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7354:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.75      rillig   7355: <div class="variablelist"><dl>
                   7356: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7357: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7358:                reconstruct the list of directories to update for
1.110     hubertf  7359:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7360:                update</strong></span> successfully installed all
                   7361:                packages you wanted to update.  Normally, this is
1.110     hubertf  7362:                done automatically on <span class="command"><strong>make
1.88      wiz      7363:                update</strong></span>, but may have been suppressed by
                   7364:                the <code class="varname">NOCLEAN</code> variable (see
                   7365:                above).</p></dd>
1.75      rillig   7366: </dl></div>
                   7367: </dd>
1.88      wiz      7368: <dt><span class="term">replace</span></dt>
                   7369: <dd>
                   7370: <p>Update the installation of the current package.  This
                   7371:          differs from update in that it does not replace dependent
1.93      rillig   7372:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7373:          target to work.</p>
                   7374: <p><span class="emphasis"><em>Be careful when using this
                   7375:          target!</em></span> There are no guarantees that dependent
                   7376:          packages will still work, in particular they will most
1.110     hubertf  7377:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7378:          library package whose shared library major version changed
                   7379:          between your installed version and the new one.  For this
                   7380:          reason, this target is not officially supported and only
                   7381:          recommended for advanced users.</p>
                   7382: </dd>
1.75      rillig   7383: <dt><span class="term">info</span></dt>
1.110     hubertf  7384: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7385:          package. You can use this to check which version of a
                   7386:          package is installed.</p></dd>
                   7387: <dt><span class="term">index</span></dt>
                   7388: <dd>
                   7389: <p>This is a top-level command, i.e. it should be used in
                   7390:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7391:          database of all packages in the local pkgsrc tree, including
                   7392:          dependencies, comment, maintainer, and some other useful
                   7393:          information.  Individual entries are created by running
1.110     hubertf  7394:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7395:          directories.  This index file is saved as
                   7396:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7397:          verbose format by running <span class="command"><strong>make
1.88      wiz      7398:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7399:          <span class="command"><strong>make search
1.88      wiz      7400:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7401:          extract a list of all packages that depend on a particular
1.110     hubertf  7402:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7403:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7404: <p>Running this command takes a very long time, some
                   7405:          hours even on fast machines!</p>
                   7406: </dd>
1.75      rillig   7407: <dt><span class="term">readme</span></dt>
1.88      wiz      7408: <dd>
                   7409: <p>This target generates a
                   7410:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7411:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7412:          contain references to any packages which are in the
                   7413:          <code class="varname">PACKAGES</code> directory on the local
                   7414:          host. The generated files can be made to refer to URLs
                   7415:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7416:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7417:          wanted to generate <code class="filename">README.html</code>
                   7418:          files which pointed to binary packages on the local
                   7419:          machine, in the directory
                   7420:          <code class="filename">/usr/packages</code>, set
                   7421:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7422:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7423:          <code class="varname">${PACKAGES}</code> directory and its
                   7424:          subdirectories will be searched for all the binary
                   7425:          packages.</p>
                   7426: <p>The target can be run at the toplevel or in category
                   7427:          directories, in which case it descends recursively.</p>
                   7428: </dd>
1.75      rillig   7429: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7430: <dd><p>This is a top-level command, run it in
                   7431:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7432:          file <code class="filename">README-all.html</code> which contains a
                   7433:          list of all packages currently available in the NetBSD
                   7434:          Packages Collection, together with the category they belong
                   7435:          to and a short description. This file is compiled from the
                   7436:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7437:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7438:          readme</strong></span>.</p></dd>
1.75      rillig   7439: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7440: <dd><p>This is very much the same as the
                   7441:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7442:          used when generating a pkgsrc tree to be written to a
                   7443:          CD-ROM.  This target also produces
                   7444:          <code class="filename">README.html</code> files, and can be made
                   7445:          to refer to URLs based on
                   7446:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7447:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7448: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7449: <dd><p>This target shows which distfiles and patchfiles
                   7450:          are needed to build the package
                   7451:          (<code class="varname">ALLFILES</code>, which contains all
                   7452:          <code class="varname">DISTFILES</code> and
1.87      wiz      7453:          <code class="varname">PATCHFILES</code>, but not
                   7454:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7455: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7456: <dd><p>This target shows nothing if the package is not
                   7457:          installed. If a version of this package is installed,
                   7458:          but is not the version provided in this version of
                   7459:          pkgsrc, then a warning message is displayed. This target
                   7460:          can be used to show which of your installed packages are
                   7461:          downlevel, and so the old versions can be deleted, and
                   7462:          the current ones added.</p></dd>
1.75      rillig   7463: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7464: <dd><p>This target shows the directory in the pkgsrc
                   7465:          hierarchy from which the package can be built and
                   7466:          installed. This may not be the same directory as the one
                   7467:          from which the package was installed. This target is
                   7468:          intended to be used by people who may wish to upgrade
                   7469:          many packages on a single host, and can be invoked from
                   7470:          the top-level pkgsrc Makefile by using the
1.87      wiz      7471:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7472: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7473: <dd><p>This target shows which installed packages match
                   7474:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7475:          if out of date dependencies are causing build
                   7476:          problems.</p></dd>
1.75      rillig   7477: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7478: <dd><p>After a package is installed, check all its
                   7479:          binaries and (on ELF platforms) shared libraries to see
                   7480:          if they find the shared libs they need.  Run by default
1.110     hubertf  7481:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   7482: <dt><span class="term">print-PLIST</span></dt>
                   7483: <dd>
                   7484: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7485:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7486:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7487:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7488:          to care for shared libs etc., but it is
1.87      wiz      7489:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7490:          result before putting it into
                   7491:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7492:          diff the output of this command against an already
                   7493:          existing <code class="filename">PLIST</code> file.</p>
1.110     hubertf  7494: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7495:          other methods that don't update file access times, be
                   7496:          sure to add these files manually to your
1.87      wiz      7497:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7498:          -newer</span>&#8221; command used by this target won't catch
                   7499:          them!</p>
1.122   ! reed     7500: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      7501:          information on this target.</p>
1.75      rillig   7502: </dd>
                   7503: <dt><span class="term">bulk-package</span></dt>
                   7504: <dd>
1.88      wiz      7505: <p>Used to do bulk builds. If an appropriate binary
                   7506:          package already exists, no action is taken. If not, this
                   7507:          target will compile, install and package it (and its
                   7508:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7509:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7510:          After creating the binary package, the sources, the
                   7511:          just-installed package and its required packages are
                   7512:          removed, preserving free disk space.</p>
                   7513: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7514:          all packages installed on a system!</em></span></p>
1.75      rillig   7515: </dd>
                   7516: <dt><span class="term">bulk-install</span></dt>
                   7517: <dd>
1.88      wiz      7518: <p>Used during bulk-installs to install required
                   7519:          packages. If an up-to-date binary package is available,
1.110     hubertf  7520:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
                   7521:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7522:          but the installed binary won't be removed.</p>
1.88      wiz      7523: <p>A binary package is considered
                   7524:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.110     hubertf  7525:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88      wiz      7526: <div class="itemizedlist"><ul type="disc">
                   7527: <li><p>None of the package's files
                   7528:              (<code class="filename">Makefile</code>, ...) were modified
                   7529:              since it was built.</p></li>
                   7530: <li><p>None of the package's required (binary)
                   7531:              packages were modified since it was built.</p></li>
1.75      rillig   7532: </ul></div>
1.88      wiz      7533: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7534:          all packages installed on a system!</em></span></p>
1.75      rillig   7535: </dd>
                   7536: </dl></div>
                   7537: </div>
                   7538: </div>
                   7539: <div class="chapter" lang="en">
                   7540: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7541: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7542: <div class="toc">
                   7543: <p><b>Table of Contents</b></p>
                   7544: <dl>
1.106     rillig   7545: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7546: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7547: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7548: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7549: </dl>
                   7550: </div>
1.87      wiz      7551: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7552: by pkgsrc and also for individual packages to define what commands
                   7553: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7554: or for later run-time of an installed packaged (such as
                   7555: <code class="varname">DEPENDS</code>).
                   7556: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7557: package will not be used.</p>
                   7558: <p>When building a package, the replacement tools are
1.75      rillig   7559: made available in a directory (as symlinks or wrapper scripts)
                   7560: that is early in the executable search path. Just like the buildlink
1.87      wiz      7561: system, this helps with consistent builds.</p>
                   7562: <p>A tool may be needed to help build a specific package. For example,
                   7563: perl, GNU make (gmake) or yacc may be needed.</p>
                   7564: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7565: tool may be inefficient for building a package with pkgsrc.
                   7566: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7567: yacc) or a better sed.</p>
                   7568: <p>The tools used by a package can be listed by running
1.110     hubertf  7569: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75      rillig   7570: <div class="sect1" lang="en">
                   7571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7572: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7573: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7574: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7575: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7576: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7577: These can be seen by running:
1.110     hubertf  7578: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7579: <p>If a package needs a specific program to build
1.75      rillig   7580: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7581: to define the tools needed.</p>
1.75      rillig   7582: </div>
                   7583: <div class="sect1" lang="en">
                   7584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7585: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7586: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7587: and not the native version for a build dependency.
                   7588: And the :run means that it is used for a
                   7589: run-time dependencies also (and becomes a DEPENDS).
                   7590: The default is a build dependency which can be set with
                   7591: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7592: and pkg-config:build.)</p>
1.75      rillig   7593: <pre class="programlisting">
                   7594: USE_TOOLS+=     mktemp:pkgsrc
                   7595: USE_TOOLS+=     gmake perl:run pkg-config
                   7596: </pre>
1.87      wiz      7597: <p>When using the tools framework, a
1.75      rillig   7598: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7599: which contains the full path to the appropriate tool. For example,
                   7600: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7601: on Linux systems.</p>
                   7602: <p>If you always need a pkgsrc version of the
1.75      rillig   7603: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7604: </p>
                   7605: </div>
                   7606: <div class="sect1" lang="en">
                   7607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7608: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7609: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7610: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7611: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7612: the name of the common tools. For example:</p>
                   7613: <pre class="programlisting">
                   7614: .if exists(/usr/bin/bzcat)
                   7615: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7616: .elif exists(/usr/bin/bzip2)
                   7617: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7618: .endif
1.69      rillig   7619: 
1.75      rillig   7620: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7621: </pre>
                   7622: </div>
1.97      rillig   7623: <div class="sect1" lang="en">
                   7624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7625: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97      rillig   7626: <div class="qandaset">
                   7627: <dl>
1.106     rillig   7628: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7629: </dt>
1.106     rillig   7630: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7631:        tools?</a>
                   7632: </dt>
1.106     rillig   7633: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7634:        package is using while being built? I want to know whether it
                   7635:        uses sed or not.</a>
                   7636: </dt>
                   7637: </dl>
                   7638: <table border="0" summary="Q and A Set">
                   7639: <col align="left" width="1%">
                   7640: <tbody>
                   7641: <tr class="question">
                   7642: <td align="left" valign="top">
1.122   ! reed     7643: <a name="tools.new"></a><a name="id1168230188209"></a><p><b>18.4.1.</b></p>
1.97      rillig   7644: </td>
                   7645: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7646: </tr>
                   7647: <tr class="answer">
                   7648: <td align="left" valign="top"></td>
                   7649: <td align="left" valign="top"><p>TODO</p></td>
                   7650: </tr>
                   7651: <tr class="question">
                   7652: <td align="left" valign="top">
1.122   ! reed     7653: <a name="tools.listall"></a><a name="id1168230188217"></a><p><b>18.4.2.</b></p>
1.97      rillig   7654: </td>
                   7655: <td align="left" valign="top"><p>How do I get a list of all available
                   7656:        tools?</p></td>
                   7657: </tr>
                   7658: <tr class="answer">
                   7659: <td align="left" valign="top"></td>
                   7660: <td align="left" valign="top"><p>TODO</p></td>
                   7661: </tr>
                   7662: <tr class="question">
                   7663: <td align="left" valign="top">
1.122   ! reed     7664: <a name="tools.used"></a><a name="id1168230188226"></a><p><b>18.4.3.</b></p>
1.97      rillig   7665: </td>
                   7666: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7667:        package is using while being built? I want to know whether it
                   7668:        uses sed or not.</p></td>
                   7669: </tr>
                   7670: <tr class="answer">
                   7671: <td align="left" valign="top"></td>
                   7672: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7673:        to do it.)</p></td>
                   7674: </tr>
                   7675: </tbody>
                   7676: </table>
                   7677: </div>
                   7678: </div>
1.75      rillig   7679: </div>
                   7680: <div class="chapter" lang="en">
                   7681: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7682: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7683: <div class="toc">
                   7684: <p><b>Table of Contents</b></p>
                   7685: <dl>
1.106     rillig   7686: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7687: <dd><dl>
1.106     rillig   7688: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.122   ! reed     7689: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig   7690: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7691: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7692: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7693: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7694: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7695: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7696: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7697: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7698: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7699: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7700: </dl></dd>
1.122   ! reed     7701: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   7702: <dd><dl>
                   7703: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7704: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   7705: </dl></dd>
1.122   ! reed     7706: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   7707: <dd><dl>
                   7708: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7709: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7710: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7711: </dl></dd>
                   7712: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7713: <dd><dl>
                   7714: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7715: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7716: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7717: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7718: </dl></dd>
1.122   ! reed     7719: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   7720: <dd><dl>
                   7721: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7722: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.122   ! reed     7723: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
1.106     rillig   7724: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7725: </dl></dd>
1.122   ! reed     7726: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   7727: <dd><dl>
                   7728: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7729: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7730: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7731: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7732: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7733: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7734: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7735: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7736: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   7737: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7738: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7739: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7740: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7741: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7742: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7743: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7744: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7745: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7746:     emulation</a></span></dt>
1.106     rillig   7747: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7748: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7749: </dl></dd>
1.106     rillig   7750: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7751: </dl>
                   7752: </div>
                   7753: <div class="sect1" lang="en">
                   7754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7755: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75      rillig   7756: <div class="sect2" lang="en">
                   7757: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7758: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7759: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7760:     different platforms. As a result, it is important to ensure,
                   7761:     where possible, that packages in pkgsrc are portable. This
                   7762:     chapter mentions some particular details you should pay
                   7763:     attention to while working on pkgsrc.</p>
1.78      rillig   7764: </div>
                   7765: <div class="sect2" lang="en">
                   7766: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7767: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7768: </h3></div></div></div>
1.78      rillig   7769: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7770:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7771:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7772:     want to use those variables in the preprocessor directives of
1.110     hubertf  7773:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7774:     <code class="literal">.for</code>), you need to include the file
                   7775:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7776:     loads the user preferences.</p>
1.78      rillig   7777: <p>But note that some variables may not be completely defined
1.87      wiz      7778:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7779:     included, as they may contain references to variables that are
                   7780:     not yet defined. In shell commands this is no problem, since
                   7781:     variables are actually macros, which are only expanded when they
                   7782:     are used. But in the preprocessor directives mentioned above and
                   7783:     in dependency lines (of the form <code class="literal">target:
                   7784:     dependencies</code>) the variables are expanded at load
                   7785:     time.</p>
1.78      rillig   7786: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7787: <h3 class="title">Note</h3>
                   7788: <p>Currently there is no exhaustive list of all
1.87      wiz      7789:     variables that tells you whether they can be used at load time
                   7790:     or only at run time, but it is in preparation.</p>
1.78      rillig   7791: </div>
                   7792: </div>
                   7793: <div class="sect2" lang="en">
                   7794: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7795: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7796: <p>Occasionally, packages require interaction from the user,
                   7797:     and this can be in a number of ways:</p>
1.78      rillig   7798: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7799: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7800:        interaction such as entering username/password or accepting a
                   7801:        license on a web page.</p></li>
1.88      wiz      7802: <li><p>When extracting the distfiles, some packages may ask for
                   7803:        passwords.</p></li>
1.78      rillig   7804: <li><p>help to configure the package before it is built</p></li>
                   7805: <li><p>help during the build process</p></li>
                   7806: <li><p>help during the installation of a package</p></li>
                   7807: </ul></div>
1.88      wiz      7808: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7809:     provided to notify the pkgsrc mechanism of an interactive stage
                   7810:     which will be needed, and this should be set in the package's
                   7811:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7812: <pre class="programlisting">
1.100     rillig   7813: INTERACTIVE_STAGE=      build
1.87      wiz      7814:     </pre>
1.78      rillig   7815: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7816: <pre class="programlisting">
1.100     rillig   7817: INTERACTIVE_STAGE=      configure install
1.87      wiz      7818:     </pre>
1.88      wiz      7819: <p>The user can then decide to skip this package by setting the
                   7820:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7821: </div>
                   7822: <div class="sect2" lang="en">
                   7823: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7824: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7825: <p>Authors of software can choose the licence under which
                   7826:     software can be copied.  This is due to copyright law, and reasons
                   7827:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7828:     system recognizes that there are a number of licenses which some
                   7829:     users may find objectionable or difficult or impossible to comply
                   7830:     with.  The Free Software Foundation has declared some licenses
                   7831:     "Free", and the Open Source Initiative has a definition of "Open
                   7832:     Source".  The pkgsrc system, as a policy choice, does not label
                   7833:     packages which have licenses that are Free or Open Source.
                   7834:     However, packages without a license meeting either of those tests
                   7835:     are labeled with a license tag denoting the license.  Note that a
                   7836:     package with no license to copy trivially does not meet either the
                   7837:     Free or Open Source test.</p>
                   7838: <p>For packages which are not Free or Open Source, pkgsrc will
                   7839:     not build the package unless the user has indicated to pkgsrc that
                   7840:     packages with that particular license may be built.  Note that
                   7841:     this documentation avoids the term "accepted the license".  The
                   7842:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7843:     accidentally building a package with a non-free license;
1.98      wiz      7844:     judgement and responsibility remain with the user.  (Installation
                   7845:     of binary packages are not currently subject to this mechanism;
                   7846:     this is a bug.)</p>
                   7847: <p>One might want to only install packages with a BSD license,
1.121     jnemeth  7848:     or the GPL, and not the other.  The free licenses are added to the 
                   7849:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7850:     user can override the default by setting the
                   7851:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7852:     of "+=".  The licenses accepted by default are:
                   7853:     </p>
                   7854: <pre class="programlisting">
                   7855:     public-domain
                   7856:     gnu-gpl-v2 gnu-lgpl-v2
                   7857:     gnu-gpl-v3 gnu-lgpl-v3
                   7858:     original-bsd modified-bsd
                   7859:     x11
                   7860:     apache-2.0
                   7861:     cddl-1.0
                   7862:     open-font-license
                   7863:     </pre>
                   7864: <p>
                   7865:     </p>
1.78      rillig   7866: <p>The license tag mechanism is intended to address
1.87      wiz      7867:     copyright-related issues surrounding building, installing and
                   7868:     using a package, and not to address redistribution issues (see
                   7869:     <code class="varname">RESTRICTED</code> and
1.121     jnemeth  7870:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7871:     Packages with redistribution restrictions should set these
                   7872:     tags.</p>
1.98      wiz      7873: <p>Denoting that a package may be copied according to a
                   7874:     particular license is done by placing the license in
1.87      wiz      7875:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7876:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7877:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7878: <pre class="programlisting">
1.100     rillig   7879: LICENSE=        xv-license
1.87      wiz      7880:     </pre>
                   7881: <p>When trying to build, the user will get a notice that the
1.98      wiz      7882:     package is covered by a license which has not been placed in the
                   7883:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7884: <pre class="programlisting">
1.100     rillig   7885: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7886: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7887: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7888: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7889: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7890: *** Error code 1
1.87      wiz      7891:     </pre>
1.110     hubertf  7892: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7893:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7894:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7895:     convey to pkgsrc that it should not in the future fail because of
                   7896:     that license:</p>
1.78      rillig   7897: <pre class="programlisting">
1.100     rillig   7898: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7899:     </pre>
1.98      wiz      7900: <p>When adding a package with a new license, the license text
                   7901:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7902:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7903:     directory.</p>
1.98      wiz      7904: <p>When the license changes (in a way other than formatting),
                   7905:     please make sure that the new license has a different name (e.g.,
                   7906:     append the version number if it exists, or the date).  Just
                   7907:     because a user told pkgsrc to build programs under a previous
                   7908:     version of a license does not mean that pkgsrc should build
1.99      rillig   7909:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7910:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7911:     test is a mechanistic test of whether a particular text has been
                   7912:     approved by either of two bodies.</p>
1.78      rillig   7913: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7914:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7915:     is deprecated because it does not crisply refer to a particular
                   7916:     license text.  Another problem with such usage is that it does not
                   7917:     enable a user to tell pkgsrc to proceed for a single package
                   7918:     without also telling pkgsrc to proceed for all packages with that
                   7919:     tag.</p>
1.75      rillig   7920: </div>
                   7921: <div class="sect2" lang="en">
                   7922: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7923: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7924: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7925:     Because a license tag is required unless the package is Free or
                   7926:     Open Source, all packages with restrictions should have license
                   7927:     tags.  By declaring the restrictions, package tools can
                   7928:     automatically refrain from e.g. placing binary packages on FTP
                   7929:     sites.</p>
                   7930: <p>There are four restrictions that may be encoded, which are
                   7931:     the cross product of sources (distfiles) and binaries not being
                   7932:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7933:     language in any license, and because non-Free licenses tend to be
                   7934:     different from each other, pkgsrc adopts a definition of FTP and
                   7935:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7936:     should not be made available over the Internet at no charge.
                   7937:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7938:     made available on some kind of media, together with other source
                   7939:     and binary packages, and which is sold for a distribution charge.
                   7940:     </p>
                   7941: <p>In order to encode these restrictions, the package system
1.87      wiz      7942:     defines five make variables that can be set to note these
                   7943:     restrictions:</p>
1.75      rillig   7944: <div class="itemizedlist"><ul type="disc">
                   7945: <li>
                   7946: <p><code class="varname">RESTRICTED</code></p>
                   7947: <p>This variable should be set whenever a restriction
1.87      wiz      7948:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7949:        string containing the reason for the restriction.  It should
                   7950:        be understood that those wanting to understand the restriction
                   7951:        will have to read the license, and perhaps seek advice of
                   7952:        counsel.</p>
1.75      rillig   7953: </li>
                   7954: <li>
                   7955: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7956: <p>Binaries may not be placed on CD-ROM containing other
                   7957:        binary packages, for which a distribution charge may be made.
                   7958:        In this case, set this variable to
                   7959:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7960: </li>
                   7961: <li>
                   7962: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7963: <p>Binaries may not made available on the Internet without
                   7964:        charge.  In this case, set this variable to
                   7965:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7966:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7967: </li>
                   7968: <li>
                   7969: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7970: <p>Distfiles may not be placed on CD-ROM, together with
                   7971:        other distfiles, for which a fee may be charged.  In this
                   7972:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7973:        </p>
1.75      rillig   7974: </li>
                   7975: <li>
                   7976: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7977: <p>Distfiles may not made available via FTP at no charge.
                   7978:        In this case, set this variable to
                   7979:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7980:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7981: </li>
                   7982: </ul></div>
                   7983: </div>
                   7984: <div class="sect2" lang="en">
                   7985: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7986: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7987: <p>Your package may depend on some other package being present
1.88      wiz      7988:     - and there are various ways of expressing this dependency.
                   7989:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7990:     <code class="varname">DEPENDS</code> definitions, the
                   7991:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7992:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7993:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7994:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7995: <p>The basic difference between the two variables is as
1.87      wiz      7996:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7997:     that pre-requisite in the binary package so it will be pulled in
                   7998:     when the binary package is later installed, whilst the
                   7999:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   8000:     dependency that is only needed for building the package.</p>
1.75      rillig   8001: <p>This means that if you only need a package present whilst
1.87      wiz      8002:     you are building, it should be noted as a
                   8003:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   8004: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      8005:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   8006: <pre class="programlisting">
1.100     rillig   8007: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      8008:     </pre>
1.75      rillig   8009: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      8010:     may include any of the wildcard version numbers recognized by
1.110     hubertf  8011:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75      rillig   8012: <div class="orderedlist"><ol type="1">
                   8013: <li>
                   8014: <p>If your package needs another package's binaries or
1.87      wiz      8015:        libraries to build or run, and if that package has a
                   8016:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   8017: <pre class="programlisting">
1.100     rillig   8018: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      8019:        </pre>
1.75      rillig   8020: </li>
                   8021: <li>
                   8022: <p>If your package needs to use another package to build
1.87      wiz      8023:        itself and there is no <code class="filename">buildlink3.mk</code>
                   8024:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   8025:        definition:</p>
1.75      rillig   8026: <pre class="programlisting">
1.100     rillig   8027: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      8028:        </pre>
1.75      rillig   8029: </li>
                   8030: <li>
                   8031: <p>If your package needs a library with which to link and
1.76      rillig   8032:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      8033:        available, this is specified using the
                   8034:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   8035: <pre class="programlisting">
1.100     rillig   8036: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      8037:        </pre>
1.109     rillig   8038: <p>You can also use wildcards in package dependencies:</p>
1.75      rillig   8039: <pre class="programlisting">
1.100     rillig   8040: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      8041:        </pre>
1.75      rillig   8042: <p>Note that such wildcard dependencies are retained when
1.87      wiz      8043:        creating binary packages.  The dependency is checked when
                   8044:        installing the binary package and any package which matches
                   8045:        the pattern will be used.  Wildcard dependencies should be
                   8046:        used with care.</p>
1.75      rillig   8047: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      8048:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   8049:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   8050:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   8051: <p>Wildcards can also be used to specify that a package
1.87      wiz      8052:        will only build against a certain minimum version of a
                   8053:        pre-requisite:</p>
1.75      rillig   8054: <pre class="programlisting">
1.100     rillig   8055: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      8056:        </pre>
1.75      rillig   8057: <p>This means that the package will build against version
1.87      wiz      8058:        3.5.4 of the tiff library or newer.  Such a dependency may
                   8059:        be warranted if, for example, the API of the library has
                   8060:        changed with version 3.5.4 and a package would not compile
                   8061:        against an earlier version of tiff.</p>
1.75      rillig   8062: <p>Please note that such dependencies should only be
1.87      wiz      8063:        updated if a package requires a newer pre-requisite, but
1.93      rillig   8064:        not to denote recommendations such as
1.87      wiz      8065:        ABI changes that do not prevent a package from building
                   8066:        correctly.  Such recommendations can be expressed using
                   8067:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   8068: <pre class="programlisting">
1.100     rillig   8069: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      8070:        </pre>
1.75      rillig   8071: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      8072:        line, this denotes that while a package will build against
                   8073:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   8074:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   8075:        dependencies unless explicitly ignored (in which case a
                   8076:        warning will be printed).</p>
1.75      rillig   8077: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      8078:        use the required <code class="varname">DEPENDS</code>, set
                   8079:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   8080:        it easier and faster to update packages built using pkgsrc,
                   8081:        since older compatible dependencies can continue to be
                   8082:        used. This is useful for people who watch their rebuilds
                   8083:        very carefully; it is not very good as a general-purpose
                   8084:        hammer.  If you use it, you need to be mindful of possible
                   8085:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   8086: <p>Packages that are built with recommendations ignored
1.87      wiz      8087:        may not be uploaded to ftp.NetBSD.org by developers and
                   8088:        should not be used across different systems that may have
                   8089:        different versions of binary packages installed.</p>
1.75      rillig   8090: <p>For security fixes, please update the package
1.110     hubertf  8091:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      8092:        information.</p>
1.75      rillig   8093: </li>
                   8094: <li>
                   8095: <p>If your package needs some executable to be able to run
1.87      wiz      8096:        correctly and if there's no
                   8097:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8098:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   8099:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87      wiz      8100:        be able to execute the latex binary from the teTeX package
                   8101:        when it runs, and that is specified:</p>
1.75      rillig   8102: <pre class="programlisting">
1.100     rillig   8103: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      8104:        </pre>
1.75      rillig   8105: <p>The comment about wildcard dependencies from previous
1.87      wiz      8106:        paragraph applies here, too.</p>
1.75      rillig   8107: </li>
                   8108: </ol></div>
                   8109: <p>If your package needs files from another package to build,
1.87      wiz      8110:     add the relevant distribution files to
                   8111:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   8112:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      8113:     (It relies on the jpeg sources being present in source form
                   8114:     during the build.)</p>
1.75      rillig   8115: </div>
                   8116: <div class="sect2" lang="en">
                   8117: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8118: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8119: <p>Your package may conflict with other packages a user might
1.87      wiz      8120:     already have installed on his system, e.g. if your package
1.88      wiz      8121:     installs the same set of files as another package in the pkgsrc
                   8122:     tree.</p>
1.75      rillig   8123: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8124:     space-separated list of packages (including version string) your
                   8125:     package conflicts with.</p>
1.91      rillig   8126: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
                   8127:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87      wiz      8128:     install the same shared library, thus you set in
                   8129:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8130: <pre class="programlisting">
1.100     rillig   8131: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8132:     </pre>
                   8133: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8134: <pre class="programlisting">
1.100     rillig   8135: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8136:     </pre>
1.75      rillig   8137: <p>Packages will automatically conflict with other packages
1.87      wiz      8138:     with the name prefix and a different version
                   8139:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8140:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8141: </div>
                   8142: <div class="sect2" lang="en">
                   8143: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8144: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8145: <p>There are several reasons why a package might be
1.88      wiz      8146:     instructed to not build under certain circumstances.  If the
1.87      wiz      8147:     package builds and runs on most platforms, the exceptions
                   8148:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8149:     the package builds and runs on a small handful of platforms,
                   8150:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8151:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8152:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8153:     (OS-version-platform) that can use glob-style
                   8154:     wildcards.</p>
1.88      wiz      8155: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8156:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      8157:     backwards compatible with other versions of the OS, and should be
                   8158:     uploaded to a version specific directory on the FTP server.  Mark
                   8159:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8160:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8161:     the package system internals, but may be used in the
                   8162:     future.</p>
1.75      rillig   8163: <p>If the package should be skipped (for example, because it
1.87      wiz      8164:     provides functionality already provided by the system), set
1.88      wiz      8165:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8166:     the package should fail because some preconditions are not met,
                   8167:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8168:     message.</p>
1.75      rillig   8169: </div>
                   8170: <div class="sect2" lang="en">
                   8171: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8172: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8173: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8174:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8175:     be set in the package Makefile. This will be carried into any
                   8176:     binary package that is made from this pkgsrc entry. A
                   8177:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.110     hubertf  8178:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87      wiz      8179:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8180: </div>
                   8181: <div class="sect2" lang="en">
                   8182: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8183: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8184: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8185:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110     hubertf  8186:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87      wiz      8187:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8188: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8189:     <code class="varname">PKGREVISION</code> should be increased (this
                   8190:     is of course not necessary if the problem is fixed by using
                   8191:     a newer release of the software).</p>
1.75      rillig   8192: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8193:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8194: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8195:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8196: </div>
                   8197: <div class="sect2" lang="en">
                   8198: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8199: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   8200: <p>When making fixes to an existing package it can be useful
1.87      wiz      8201:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8202:     avoid conflicting with future versions by the original author, a
                   8203:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8204:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8205:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8206:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8207: <pre class="programlisting">
1.100     rillig   8208: DISTNAME=       foo-17.42
                   8209: PKGREVISION=    9
1.87      wiz      8210:     </pre>
1.75      rillig   8211: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8212:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8213:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8214:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8215:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8216: <p>When a new release of the package is released, the
1.87      wiz      8217:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8218:     minor release of the above package, things should be like:</p>
1.75      rillig   8219: <pre class="programlisting">
1.100     rillig   8220: DISTNAME=       foo-17.43
1.87      wiz      8221:     </pre>
                   8222: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8223:     non-trivial change in the resulting binary package.  Without a
                   8224:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8225:     version installed has no way of knowing that their package is out
                   8226:     of date.  Thus, changes without increasing
                   8227:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8228:     trivial that no reasonable person would want to upgrade", and this
                   8229:     is the rough test for when increasing
                   8230:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8231:     changes that do not merit increasing
                   8232:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8233: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 8234: <li><p>Changing <code class="varname">HOMEPAGE</code>,
                   8235:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8236:       or comments in Makefile.</p></li>
                   8237: <li><p>
                   8238:       Changing build variables if the resulting binary package is the same.</p></li>
                   8239: <li><p>
                   8240:       Changing <code class="filename">DESCR</code>.</p></li>
                   8241: <li><p>
                   8242:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8243: </ul></div>
1.87      wiz      8244: <p>Examples of changes that do merit an increase to
                   8245:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8246: <div class="itemizedlist"><ul type="disc">
                   8247: <li><p>
                   8248:       Security fixes</p></li>
                   8249: <li><p>
                   8250:       Changes or additions to a patch file</p></li>
                   8251: <li><p>
                   8252:       Changes to the <code class="filename">PLIST</code></p></li>
1.112     weinem   8253: <li><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8254: </ul></div>
1.78      rillig   8255: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8256:     changes.</p>
1.75      rillig   8257: </div>
1.79      rillig   8258: <div class="sect2" lang="en">
                   8259: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8260: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8261: <p>When you want to replace the same text in multiple files
1.87      wiz      8262:     or when the replacement text varies, patches alone cannot help.
                   8263:     This is where the SUBST framework comes in. It provides an
                   8264:     easy-to-use interface for replacing text in files.
                   8265:     Example:</p>
                   8266: <pre class="programlisting">
1.100     rillig   8267: SUBST_CLASSES+=                 fix-paths
                   8268: SUBST_STAGE.fix-paths=          pre-configure
                   8269: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8270: SUBST_FILES.fix-paths=          src/*.c
                   8271: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8272: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8273: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8274:     </pre>
1.79      rillig   8275: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8276:     that are used to identify the different SUBST blocks that are
                   8277:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8278:     important to always use the <code class="literal">+=</code> operator with
                   8279:     this variable. Otherwise some substitutions may be
                   8280:     skipped.</p>
1.79      rillig   8281: <p>The remaining variables of each SUBST block are
1.87      wiz      8282:     parameterized with the identifier from the first line
                   8283:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8284:     parameters to a function call.</p>
1.79      rillig   8285: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8286:     which the replacement will take place. All combinations of
                   8287:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8288:     <code class="literal">post-</code> together with a phase name are
                   8289:     possible, though only few are actually used. Most commonly used
                   8290:     are <code class="literal">post-patch</code> and
                   8291:     <code class="literal">pre-configure</code>. Of these two,
                   8292:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8293:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8294:     have the state after applying the patches but before making any
                   8295:     other changes. This is especially useful when you are debugging
                   8296:     a package in order to create new patches for it. Similarly,
                   8297:     <code class="literal">post-build</code> is preferred over
                   8298:     <code class="literal">pre-install</code>, because the install phase should
                   8299:     generally be kept as simple as possible. When you use
                   8300:     <code class="literal">post-build</code>, you have the same files in the
                   8301:     working directory that will be installed later, so you can check
                   8302:     if the substitution has succeeded.</p>
1.79      rillig   8303: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8304:     that is printed just before the substitution is done.</p>
1.79      rillig   8305: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8306:     globbing patterns that specifies the files in which the
                   8307:     substitution will take place. The patterns are interpreted
                   8308:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8309: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110     hubertf  8310:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8311:     command should be prefixed with <code class="literal">-e</code>, so that
                   8312:     all SUBST blocks look uniform.</p>
1.79      rillig   8313: <p>There are some more variables, but they are so seldomly
1.87      wiz      8314:     used that they are only documented in the
                   8315:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8316: </div>
1.75      rillig   8317: </div>
                   8318: <div class="sect1" lang="en">
                   8319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8320: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8321: <div class="sect2" lang="en">
                   8322: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8323: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8324: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8325:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8326:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8327:     with the name of each file to download as an argument, expecting
                   8328:     it to output the URL of the directory from which to download
1.91      rillig   8329:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8330:     example of this usage.</p>
1.75      rillig   8331: <p>If the download can't be automated, because the user must
1.87      wiz      8332:     submit personal information to apply for a password, or must pay
                   8333:     for the source, or whatever, you can set
                   8334:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8335:     displayed to the user before aborting the build. Example:</p>
                   8336: <pre class="programlisting">
1.100     rillig   8337: FETCH_MESSAGE=  "Please download the files"
                   8338: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8339: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8340:     </pre>
1.75      rillig   8341: </div>
                   8342: <div class="sect2" lang="en">
                   8343: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8344: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8345: <p>Sometimes authors of a software package make some
1.87      wiz      8346:     modifications after the software was released, and they put up a
                   8347:     new distfile without changing the package's version number. If a
                   8348:     package is already in pkgsrc at that time, the checksum will
                   8349:     no longer match. The contents of the new distfile should be
                   8350:     compared against the old one before changing anything, to make
                   8351:     sure the distfile was really updated on purpose, and that
                   8352:     no trojan horse or so crept in.
1.97      rillig   8353:     Please mention that the distfiles were compared and what was found
                   8354:     in your commit message.
1.87      wiz      8355:     Then, the correct way to work around this is to
                   8356:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8357:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8358:     <code class="varname">DISTFILES</code> and
1.93      rillig   8359:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8360:     subdirectory of the local distfiles directory.
1.110     hubertf  8361:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.97      rillig   8362:     In case this
1.87      wiz      8363:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8364:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8365:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8366:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8367:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8368:     path in the filenames.
1.97      rillig   8369:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8370:     Furthermore, a mail to the package's authors seems appropriate
                   8371:     telling them that changing distfiles after releases without
                   8372:     changing the file names is not good practice.</p>
1.75      rillig   8373: </div>
                   8374: </div>
                   8375: <div class="sect1" lang="en">
                   8376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8377: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8378: <div class="sect2" lang="en">
                   8379: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8380: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8381: <p>pkgsrc supports many different machines, with different
1.87      wiz      8382:     object formats like a.out and ELF, and varying abilities to do
                   8383:     shared library and dynamic loading at all. To accompany this,
                   8384:     varying commands and options have to be passed to the
                   8385:     compiler, linker, etc. to get the Right Thing, which can be
                   8386:     pretty annoying especially if you don't have all the machines
                   8387:     at your hand to test things.  The
1.91      rillig   8388:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87      wiz      8389:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8390:     both static and dynamic libraries from a set of source files,
                   8391:     thus being platform-independent.</p>
                   8392: <p>Here's how to use libtool in a package in seven simple
                   8393:     steps:</p>
1.75      rillig   8394: <div class="orderedlist"><ol type="1">
                   8395: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8396:        Makefile.</p></li>
1.75      rillig   8397: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8398:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8399:        add it to the definition of <code class="varname">CC</code>, if only
                   8400:        libraries are being built in a given Makefile. This one command
                   8401:        will build both PIC and non-PIC library objects, so you need not
                   8402:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8403: <li>
                   8404: <p>For the linking of the library, remove any
1.87      wiz      8405:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8406:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8407: <pre class="programlisting">
1.100     rillig   8408: ${LIBTOOL} --mode=link \
                   8409:     ${CC} -o ${.TARGET:.a=.la} \
                   8410:         ${OBJS:.o=.lo} \
                   8411:         -rpath ${PREFIX}/lib \
                   8412:         -version-info major:minor
1.87      wiz      8413:        </pre>
1.75      rillig   8414: <p>Note that the library is changed to have a
1.87      wiz      8415:        <code class="filename">.la</code> extension, and the objects are
                   8416:        changed to have a <code class="filename">.lo</code>
                   8417:        extension. Change <code class="varname">OBJS</code> as
                   8418:        necessary. This automatically creates all of the
                   8419:        <code class="filename">.a</code>,
                   8420:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8421:        necessary) in the build directory. Be sure to include
                   8422:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8423:        minor are zero, as libtool will otherwise strip off the
                   8424:        shared library version.</p>
1.75      rillig   8425: <p>From the libtool manual:</p>
                   8426: <pre class="programlisting">
1.100     rillig   8427: So, libtool library versions are described by three integers:
1.69      rillig   8428: 
1.100     rillig   8429: CURRENT
                   8430: The most recent interface number that this library implements.
1.69      rillig   8431: 
1.100     rillig   8432: REVISION
                   8433: The implementation number of the CURRENT interface.
1.69      rillig   8434: 
1.100     rillig   8435: AGE
                   8436: The difference between the newest and oldest interfaces that
                   8437: this library implements.  In other words, the library implements
                   8438: all the interface numbers in the range from number `CURRENT -
                   8439: AGE' to `CURRENT'.
1.1       grant    8440: 
1.100     rillig   8441: If two libraries have identical CURRENT and AGE numbers, then the
                   8442: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8443:        </pre>
1.75      rillig   8444: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8445:        different results for a.out and ELF (excluding symlinks)
                   8446:        in only one case. An ELF library of the form
                   8447:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8448:        will have a symlink of
                   8449:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8450:        on an a.out platform. This is handled
                   8451:        automatically.</p>
1.75      rillig   8452: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8453:        directory of the library being built.</p>
1.76      rillig   8454: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8455:        <code class="filename">.la</code> file, the other files will be
                   8456:        added automatically.</p>
1.75      rillig   8457: </li>
                   8458: <li>
1.76      rillig   8459: <p>When linking shared object (<code class="filename">.so</code>)
1.110     hubertf  8460:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87      wiz      8461:        shared libraries, use &#8220;<span class="quote">-module
                   8462:        -avoid-version</span>&#8221; to prevent them getting version
                   8463:        tacked on.</p>
1.76      rillig   8464: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8465:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8466: </li>
                   8467: <li>
                   8468: <p>When linking programs that depend on these libraries
1.87      wiz      8469:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.110     hubertf  8470:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><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+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8471:        --mode=link</span>&#8221;, and it will find the correct
                   8472:        libraries (static or shared), but please be aware that
                   8473:        libtool will not allow you to specify a relative path in
                   8474:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8475:        expects you to change that argument to be the
                   8476:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8477: <pre class="programlisting">
1.100     rillig   8478: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8479:        </pre>
1.75      rillig   8480: <p>should be changed to:</p>
                   8481: <pre class="programlisting">
1.100     rillig   8482: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8483:        </pre>
1.75      rillig   8484: <p>and it will do the right thing with the libraries.</p>
                   8485: </li>
                   8486: <li>
1.110     hubertf  8487: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8488:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8489:        --mode=install</span>&#8221;, and change the library name to
                   8490:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8491: <pre class="programlisting">
1.100     rillig   8492: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8493:        </pre>
1.76      rillig   8494: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8495:        shared library, any needed symlinks, and run
1.110     hubertf  8496:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8497: </li>
1.76      rillig   8498: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8499:        the <code class="filename">.la</code>
                   8500:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8501: </ol></div>
                   8502: </div>
                   8503: <div class="sect2" lang="en">
                   8504: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8505: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8506: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8507:     package Makefile. This will override the package's own libtool
                   8508:     in most cases.  For older libtool using packages,  libtool is
                   8509:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8510:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8511:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8512: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8513:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8514:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8515:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8516:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8517: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8518:     libraries built and installed, then use
                   8519:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8520: <p>If your package makes use of the platform-independent library
1.87      wiz      8521:     for loading dynamic shared objects, that comes with libtool
                   8522:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8523: <p>Some packages use libtool incorrectly so that the package
                   8524:     may not work or build in some circumstances. Some of the more
                   8525:     common errors are:</p>
1.75      rillig   8526: <div class="itemizedlist"><ul type="disc">
                   8527: <li>
                   8528: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8529:        executable or library. This in itself isn't a problem if one of two things
                   8530:        has been done:</p>
1.75      rillig   8531: <div class="orderedlist"><ol type="1">
                   8532: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8533:            <code class="filename">libfoo.la</code>, not
                   8534:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8535: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8536: </ol></div>
                   8537: </li>
                   8538: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8539:        The function lt_dlinit() should be called and the macro
                   8540:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8541:        executables.</p></li>
1.75      rillig   8542: </ul></div>
                   8543: </div>
                   8544: <div class="sect2" lang="en">
                   8545: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8546: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8547: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8548:     to regenerate the configure script and Makefile.in makefile
                   8549:     templates, then they should be executed in a pre-configure
                   8550:     target.</p>
1.75      rillig   8551: <p>For packages that need only autoconf:</p>
                   8552: <pre class="programlisting">
1.100     rillig   8553: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8554: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8555: ...
1.1       grant    8556: 
1.100     rillig   8557: pre-configure:
                   8558:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8559: 
1.100     rillig   8560: ...
1.87      wiz      8561:     </pre>
1.75      rillig   8562: <p>and for packages that need automake and autoconf:</p>
                   8563: <pre class="programlisting">
1.100     rillig   8564: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8565: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8566: ...
                   8567: 
                   8568: pre-configure:
                   8569:         set -e; cd ${WRKSRC}; \
                   8570:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8571: 
1.100     rillig   8572: ...
1.87      wiz      8573:     </pre>
1.75      rillig   8574: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8575:     require GNU Make.</p>
1.75      rillig   8576: <p>There are times when the configure process makes
1.87      wiz      8577:     additional changes to the generated files, which then causes
                   8578:     the build process to try to re-execute the automake sequence.
                   8579:     This is prevented by touching various files in the configure
                   8580:     stage. If this causes problems with your package you can set
                   8581:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8582:     Makefile.</p>
1.75      rillig   8583: </div>
                   8584: </div>
                   8585: <div class="sect1" lang="en">
                   8586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8587: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87      wiz      8588: <div class="sect2" lang="en">
                   8589: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8590: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8591: <p>Compilers for the C, C++, and Fortran languages comes with
                   8592:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8593:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8594:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8595: <p>To declare which language's compiler a package needs, set
                   8596:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8597:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8598:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8599:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8600:     written in C++, usually need a C compiler for the configure
                   8601:     phase.</p>
                   8602: </div>
                   8603: <div class="sect2" lang="en">
                   8604: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8605: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8606: <p>If a program is written in Java, use the Java framework in
                   8607:     pkgsrc.  The package must include
                   8608:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8609:     provides the following variables:</p>
                   8610: <div class="itemizedlist"><ul type="disc">
                   8611: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8612:       dependency on the JDK is added.  If
                   8613:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8614:       there is only a runtime dependency on the JDK.  The default is
                   8615:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8616:       JDK.</p></li>
                   8617: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8618:       a package needs a Java2 implementation.  The supported values
                   8619:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8620:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8621:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8622:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8623:       above. This variable is not set by default.</p></li>
                   8624: </ul></div>
                   8625: </div>
                   8626: <div class="sect2" lang="en">
                   8627: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8628: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8629: <p>If your package contains interpreted perl scripts, add
                   8630:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8631:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8632:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8633:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8634:     that you want adjusted.  Every occurrence of
                   8635:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8636:     path to the perl executable.</p>
                   8637: <p>If a particular version of perl is needed, set the
                   8638:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8639:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.110     hubertf  8640: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8641:     about handling perl modules.</p>
                   8642: </div>
                   8643: <div class="sect2" lang="en">
                   8644: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8645: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8646: <p>Currently, there is no special handling for other languages
                   8647:     in pkgsrc.  If a compiler package provides a
                   8648:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8649:     just add a (build) dependency on the appropriate compiler
                   8650:     package.</p>
                   8651: </div>
                   8652: </div>
                   8653: <div class="sect1" lang="en">
                   8654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8655: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8656: <p>The most common failures when building a package are that
                   8657:        some platforms do not provide certain header files, functions or
                   8658:        libraries, or they provide the functions in a library that the
                   8659:        original package author didn't know. To work around this, you
                   8660:        can rewrite the source code in most cases so that it does not
                   8661:        use the missing functions or provides a replacement function.</p>
                   8662: <div class="sect2" lang="en">
                   8663: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8664: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8665: <p>If a package already comes with a GNU configure script, the
                   8666:        preferred way to fix the build failure is to change the
                   8667:        configure script, not the code. In the other cases, you can
                   8668:        utilize the C preprocessor, which defines certain macros
                   8669:        depending on the operating system and hardware architecture it
                   8670:        compiles for. These macros can be queried using for example
                   8671:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8672:        system, hardware architecture and compiler has its own macro.
                   8673:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8674:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8675:        are all defined, you know that you are using NetBSD on an i386
                   8676:        compatible CPU, and your compiler is GCC.</p>
                   8677: <p>The list of the following macros for hardware and
                   8678:        operating system depends on the compiler that is used. For
                   8679:        example, if you want to conditionally compile code on Solaris,
                   8680:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8681:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8682: <div class="sect3" lang="en">
                   8683: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8684: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8685: <p>To distinguish between 4.4 BSD-derived systems and the
                   8686:         rest of the world, you should use the following code.</p>
                   8687: <pre class="programlisting">
1.100     rillig   8688: #include &lt;sys/param.h&gt;
                   8689: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8690: /* BSD-specific code goes here */
                   8691: #else
                   8692: /* non-BSD-specific code goes here */
                   8693: #endif
1.75      rillig   8694: </pre>
1.77      rillig   8695: <p>If this distinction is not fine enough, you can also test
                   8696:        for the following macros.</p>
1.75      rillig   8697: <pre class="programlisting">
1.100     rillig   8698: FreeBSD     __FreeBSD__
                   8699: DragonFly   __DragonFly__
                   8700: Interix     __INTERIX
                   8701: IRIX        __sgi (TODO: get a definite source for this)
                   8702: Linux       linux, __linux, __linux__
                   8703: NetBSD      __NetBSD__
                   8704: OpenBSD     __OpenBSD__
                   8705: Solaris     sun, __sun
1.75      rillig   8706: </pre>
                   8707: </div>
                   8708: <div class="sect3" lang="en">
                   8709: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8710: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8711: <pre class="programlisting">
1.100     rillig   8712: i386        i386, __i386, __i386__
                   8713: MIPS        __mips
                   8714: SPARC       sparc, __sparc
1.75      rillig   8715: </pre>
                   8716: </div>
                   8717: <div class="sect3" lang="en">
                   8718: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8719: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8720: <pre class="programlisting">
1.100     rillig   8721: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8722: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8723: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8724: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8725: </pre>
                   8726: </div>
                   8727: </div>
1.78      rillig   8728: <div class="sect2" lang="en">
                   8729: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8730: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8731: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8732:         combinations of compiler version and architecture and almost
                   8733:         always relation to optimisation being enabled.  Common symptoms
                   8734:         are gcc internal errors or never finishing compiling a
1.78      rillig   8735:        file.</p>
                   8736: <p>Typically, a workaround involves testing the
                   8737:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8738:         optimisation for that combination of file,
                   8739:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8740:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8741:        number of examples.</p>
                   8742: </div>
                   8743: <div class="sect2" lang="en">
                   8744: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8745: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8746: <p>This error message often means that a package did not
1.78      rillig   8747:        link to a shared library it needs. The following functions are
                   8748:        known to cause this error message over and over.</p>
                   8749: <div class="informaltable">
                   8750: <a name="undefined-reference-functions"></a><table border="1">
                   8751: <colgroup>
                   8752: <col>
                   8753: <col>
                   8754: <col>
                   8755: </colgroup>
                   8756: <thead><tr>
                   8757: <th>Function</th>
                   8758: <th>Library</th>
                   8759: <th>Affected platforms</th>
                   8760: </tr></thead>
                   8761: <tbody>
                   8762: <tr>
                   8763: <td>accept, bind, connect</td>
                   8764: <td>-lsocket</td>
                   8765: <td>Solaris</td>
                   8766: </tr>
                   8767: <tr>
                   8768: <td>crypt</td>
                   8769: <td>-lcrypt</td>
                   8770: <td>DragonFly, NetBSD</td>
                   8771: </tr>
                   8772: <tr>
                   8773: <td>dlopen, dlsym</td>
                   8774: <td>-ldl</td>
                   8775: <td>Linux</td>
                   8776: </tr>
                   8777: <tr>
                   8778: <td>gethost*</td>
                   8779: <td>-lnsl</td>
                   8780: <td>Solaris</td>
                   8781: </tr>
                   8782: <tr>
                   8783: <td>inet_aton</td>
                   8784: <td>-lresolv</td>
                   8785: <td>Solaris</td>
                   8786: </tr>
                   8787: <tr>
                   8788: <td>nanosleep, sem_*, timer_*</td>
                   8789: <td>-lrt</td>
                   8790: <td>Solaris</td>
                   8791: </tr>
                   8792: <tr>
                   8793: <td>openpty</td>
                   8794: <td>-lutil</td>
                   8795: <td>Linux</td>
                   8796: </tr>
                   8797: </tbody>
                   8798: </table>
                   8799: </div>
                   8800: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8801:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8802:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8803:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8804:     bmake</strong></span>.</p>
1.92      rillig   8805: <div class="sect3" lang="en">
                   8806: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8807: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8808: <p>When you are using the SunPro compiler, there is another
                   8809: possibility. That compiler cannot handle the following code:</p>
                   8810: <pre class="programlisting">
1.100     rillig   8811: extern int extern_func(int);
1.93      rillig   8812: 
1.100     rillig   8813: static inline int
                   8814: inline_func(int x)
                   8815: {
1.92      rillig   8816:         return extern_func(x);
1.100     rillig   8817: }
1.93      rillig   8818: 
1.100     rillig   8819: int main(void)
                   8820: {
1.92      rillig   8821:         return 0;
1.100     rillig   8822: }
1.92      rillig   8823: </pre>
                   8824: <p>It generates the code for <code class="function">inline_func</code> even if
                   8825: that function is never used. This code then refers to
                   8826: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8827: solve this problem you can try to tell the package to disable inlining
                   8828: of functions.</p>
                   8829: </div>
1.87      wiz      8830: </div>
                   8831: <div class="sect2" lang="en">
                   8832: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8833: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8834: <p>Sometimes packages fail to build because the compiler runs
                   8835:     into an operating system specific soft limit.  With the
                   8836:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8837:     to unlimit the resources.  Currently, the allowed values are
                   8838:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8839:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8840:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8841:     segment size or maximum stack size of a process, respectively, to
                   8842:     their hard limits.</p>
1.78      rillig   8843: </div>
1.75      rillig   8844: </div>
                   8845: <div class="sect1" lang="en">
                   8846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8847: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8848: <div class="sect2" lang="en">
                   8849: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8850: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8851: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8852:     with some operating systems cannot create more than one
                   8853:     directory at a time. As such, you should call
                   8854:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8855: <pre class="programlisting">
1.100     rillig   8856: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8857: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8858:     </pre>
1.78      rillig   8859: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8860:     dir2</code></span>&#8221; to the
                   8861:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8862:     automatically do the right thing.</p>
1.75      rillig   8863: </div>
                   8864: <div class="sect2" lang="en">
                   8865: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8866: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8867: <p>In general, documentation should be installed into
1.87      wiz      8868:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8869:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8870:     includes the version number of the package).</p>
1.84      wiz      8871: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8872:     directory where HTML documentation is installed with the
                   8873:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8874:     is needed because otherwise the documentation ends up in
                   8875:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8876:     places.</p>
                   8877: <p>An exception to the above is that library API documentation
1.91      rillig   8878:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8879:     browsers (devhelp) should be left at their default location, which
                   8880:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8881:     documentation can be recognized from files ending in
                   8882:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8883:     (It is also acceptable to install such files in
                   8884:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8885:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8886:     <code class="filename">.devhelp*</code> file must be directly in that
                   8887:     directory then, no additional subdirectory level is allowed in
                   8888:     this case. This is usually achieved by using
                   8889:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8890:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8891:     though.)</p>
1.75      rillig   8892: </div>
                   8893: <div class="sect2" lang="en">
                   8894: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8895: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8896: <p>Certain packages, most of them in the games category, install
1.87      wiz      8897:     a score file that allows all users on the system to record their
                   8898:     highscores.  In order for this to work, the binaries need to be
                   8899:     installed setgid and the score files owned by the appropriate
                   8900:     group and/or owner (traditionally the "games" user/group).  The
                   8901:     following variables, documented in more detail in
                   8902:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8903:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8904:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8905:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8906: <p>Note that per default, setgid installation of games is
1.87      wiz      8907:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8908:     the other variables accordingly.</p>
1.114     jmcneill 8909: <p>A package should therefore never hard code file ownership or
1.87      wiz      8910:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8911:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8912:     correctly.</p>
1.75      rillig   8913: </div>
                   8914: <div class="sect2" lang="en">
                   8915: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8916: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8917: <p><code class="varname">DESTDIR</code> support means that a package
                   8918:     installs into a staging directory, not the final location of the
                   8919:     files. Then a binary package is created which can be used for
                   8920:     installation as usual. There are two ways: Either the package must
                   8921:     install as root (&#8220;<span class="quote">destdir</span>&#8221;) or the package can
                   8922:     install as non-root user (&#8220;<span class="quote">user-destdir</span>&#8221;).</p>
                   8923: <div class="itemizedlist"><ul type="disc">
                   8924: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8925:       set to &#8220;<span class="quote">destdir</span>&#8221; or &#8220;<span class="quote">user-destdir</span>&#8221;. If
                   8926:       bsd.prefs.mk is included in the Makefile,
                   8927:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8928:       the inclusion.</p></li>
1.103     wiz      8929: <li><p>All installation operations have to be prefixed with
                   8930:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8931: <li><p>automake gets this DESTDIR mostly right
                   8932:       automatically. Many manual rules and pre/post-install often are
                   8933:       incorrect; fix them.</p></li>
                   8934: <li><p>If files are installed with special owner/group
1.118     imil     8935:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.103     wiz      8936: <li><p>In general, packages should support
                   8937:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8938:       DESTDIR.</p></li>
                   8939: </ul></div>
                   8940: </div>
                   8941: <div class="sect2" lang="en">
                   8942: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8943: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8944: <p>Your package may also contain scripts with hardcoded paths to
                   8945:       other interpreters besides (or as well as) perl.  To correct the
                   8946:       full pathname to the script interpreter, you need to set the
                   8947:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8948:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8949: <pre class="programlisting">
1.100     rillig   8950: REPLACE_INTERPRETER+=   tcl
                   8951: REPLACE.tcl.old=        .*/bin/tclsh
                   8952: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8953: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8954: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8955:     </pre>
1.75      rillig   8956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8957: <h3 class="title">Note</h3>
                   8958: <p>Before March 2006, these variables were called
1.87      wiz      8959:     <code class="varname">_REPLACE.*</code> and
                   8960:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8961: </div>
                   8962: </div>
                   8963: <div class="sect2" lang="en">
                   8964: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8965: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8966: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8967:     the Makefile fragment
                   8968:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8969:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8970:     configuration for such modules as well as various hooks to tune
                   8971:     this configuration.  See comments in this file for
                   8972:     details.</p>
1.75      rillig   8973: <p>Perl5 modules will install into different places depending
1.87      wiz      8974:     on the version of perl used during the build process.  To
                   8975:     address this, pkgsrc will append lines to the
                   8976:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8977:     the installed <code class="filename">.packlist</code> file generated by
                   8978:     most perl5 modules.  This is invoked by defining
                   8979:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8980:     paths to packlist files, e.g.:</p>
1.75      rillig   8981: <pre class="programlisting">
1.100     rillig   8982: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8983:     </pre>
1.75      rillig   8984: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8985:     <code class="varname">PERL5_SITEARCH</code>, and
                   8986:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8987:     in which perl5 modules may be installed, and may be used by
                   8988:     perl5 packages that don't have a packlist.  These three
                   8989:     variables are also substituted for in the
                   8990:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8991: </div>
                   8992: <div class="sect2" lang="en">
                   8993: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8994: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8995: <p>Some packages install info files or use the
1.87      wiz      8996:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8997:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8998:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8999:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9000:     handle registration of the info files in the Info directory
                   9001:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   9002:     files registration is either provided by the system, or by a
                   9003:     special purpose package automatically added as dependency if
                   9004:     needed.</p>
1.75      rillig   9005: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9006:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9007:     located. <code class="varname">PKGINFODIR</code> defaults to
                   9008:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   9009: <p>The info files for the package should be listed in the
1.87      wiz      9010:     package <code class="filename">PLIST</code>; however any split info files
                   9011:     need not be listed.</p>
1.75      rillig   9012: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      9013:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   9014:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   9015:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   9016:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9017:     variable in the package <code class="filename">Makefile</code>. By
                   9018:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9019:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9020:     does not match the required minimum, a build dependency on the
1.91      rillig   9021:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      9022:     be added automatically.</p>
1.75      rillig   9023: <p>The build and installation process of the software provided
1.87      wiz      9024:     by the package should not use the
1.110     hubertf  9025:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9026:     info files is the task of the package
                   9027:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9028:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9029: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9030:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9031:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9032:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9033: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9034:     no effect except the logging of a message. The script overriding
1.110     hubertf  9035:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9036:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9037:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9038: </div>
                   9039: <div class="sect2" lang="en">
                   9040: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9041: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9042: <p>All packages that install manual pages should install them
1.87      wiz      9043:     into the same directory, so that there is one common place to look
                   9044:     for them. In pkgsrc, this place is
                   9045:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9046:     should be used in packages. The default for
                   9047:     <code class="varname">PKGMANDIR</code> is
                   9048:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   9049:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   9050: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9051: <h3 class="title">Note</h3>
1.87      wiz      9052: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9053:     is far from complete.</p>
1.75      rillig   9054: </div>
1.81      rillig   9055: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9056:     <code class="filename">man/</code> as the top level directory for the man
                   9057:     page file entries, and the pkgsrc framework will convert as
                   9058:     needed. In all other places, the correct
                   9059:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9060: <p>Packages that are
                   9061:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   9062:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   9063:     <code class="filename">./configure</code>
                   9064:     --mandir switch to set where the man pages should be installed.
                   9065:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9066:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9067: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9068:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   9069:     to &#8220;<span class="quote">no</span>&#8221;.
                   9070:     Or if the <code class="filename">./configure</code> script uses
                   9071:     a non-standard use of --mandir, you can set
                   9072:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  9073: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      9074:     information on installation of compressed manual pages.</p>
1.75      rillig   9075: </div>
                   9076: <div class="sect2" lang="en">
                   9077: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   9078: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9079: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9080:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9081:     you need to take some extra steps to make sure they get registered
                   9082:     in the database:</p>
1.75      rillig   9083: <div class="orderedlist"><ol type="1">
1.107     rillig   9084: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9085:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9086:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9087:        deinstallation time, and tells the package where to install
1.107     rillig   9088:        GConf data files using some standard configure arguments.  It
1.87      wiz      9089:        also disallows any access to the database directly from the
                   9090:        package.</p></li>
1.75      rillig   9091: <li><p>Ensure that the package installs its
1.87      wiz      9092:        <code class="filename">.schemas</code> files under
                   9093:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9094:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9095:        need to manually patch the package.</p></li>
1.75      rillig   9096: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9097:        directory, as they will be handled automatically.  See
1.110     hubertf  9098:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.107     rillig   9099: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9100:        your <code class="filename">Makefile</code> with a list of all
                   9101:        <code class="filename">.schemas</code> files installed by the package, if
                   9102:        any.  Names must not contain any directories in them.</p></li>
1.107     rillig   9103: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9104:        your <code class="filename">Makefile</code> with a
                   9105:        list of all <code class="filename">.entries</code> files installed by the
                   9106:        package, if any. Names must not contain any directories in
                   9107:        them.</p></li>
1.75      rillig   9108: </ol></div>
                   9109: </div>
                   9110: <div class="sect2" lang="en">
                   9111: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   9112: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9113: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9114:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9115:     get registered in the database:</p>
1.75      rillig   9116: <div class="orderedlist"><ol type="1">
                   9117: <li><p>Include
1.119     mishka   9118:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9119:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9120:        takes care of rebuilding the scrollkeeper database at
                   9121:        installation and deinstallation time, and disallows any access
                   9122:        to it directly from the package.</p></li>
1.75      rillig   9123: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9124:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9125:        will be handled automatically.</p></li>
1.76      rillig   9126: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9127:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9128:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9129: </ol></div>
                   9130: </div>
                   9131: <div class="sect2" lang="en">
                   9132: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9133: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9134: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9135:     the fonts database in the directory where they get installed at
                   9136:     installation and deinstallation time.  This can be automatically
                   9137:     done by using the pkginstall framework.</p>
1.75      rillig   9138: <p>You can list the directories where fonts are installed in the
1.87      wiz      9139:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9140:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9141:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9142:     Also make sure that the database file
                   9143:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9144: <p>Note that you should not create new directories for fonts;
1.87      wiz      9145:     instead use the standard ones to avoid that the user needs to
                   9146:     manually configure his X server to find them.</p>
1.75      rillig   9147: </div>
                   9148: <div class="sect2" lang="en">
                   9149: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9150: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9151: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9152:     take some extra steps to get them registered in the GTK2 database
                   9153:     properly:</p>
1.75      rillig   9154: <div class="orderedlist"><ol type="1">
                   9155: <li><p>Include
1.87      wiz      9156:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9157:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9158:       rebuilding the database at installation and deinstallation time.</p></li>
                   9159: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9160:       your package installs GTK2 immodules.</p></li>
                   9161: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9162:       GTK2 loaders.</p></li>
1.75      rillig   9163: <li>
1.87      wiz      9164: <p>Patch the package to not touch any of the GTK2
                   9165:       databases directly.  These are:</p>
1.75      rillig   9166: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9167: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9168: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9169: </ul></div>
                   9170: </li>
1.87      wiz      9171: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9172:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9173:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9174: </ol></div>
                   9175: </div>
                   9176: <div class="sect2" lang="en">
                   9177: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9178: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9179: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9180:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9181:     etc.), you need to take some extra steps:</p>
1.75      rillig   9182: <div class="orderedlist"><ol type="1">
                   9183: <li><p>Include
1.87      wiz      9184:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9185:        your <code class="filename">Makefile</code>, which takes care of
                   9186:        registering those files in system-wide catalogs at
                   9187:        installation and deinstallation time.</p></li>
1.75      rillig   9188: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9189:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9190: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9191:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9192: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9193:        to be added to the SGML catalog.  These come in groups of
                   9194:        three strings; see xmlcatmgr(1) for more information
                   9195:        (specifically, arguments recognized by the 'add' action).
                   9196:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9197: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9198:        to be added to the XML catalog.  These come in groups of three
                   9199:        strings; see xmlcatmgr(1) for more information (specifically,
                   9200:        arguments recognized by the 'add' action).  Note that you will
                   9201:        normally not use this variable.</p></li>
1.75      rillig   9202: </ol></div>
                   9203: </div>
                   9204: <div class="sect2" lang="en">
                   9205: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9206: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9207: <p>If a package provides extensions to the MIME database by
1.87      wiz      9208:     installing <code class="filename">.xml</code> files inside
                   9209:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9210:     need to take some extra steps to ensure that the database is kept
                   9211:     consistent with respect to these new files:</p>
1.75      rillig   9212: <div class="orderedlist"><ol type="1">
                   9213: <li><p>Include
1.87      wiz      9214:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9215:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9216:        this same directory, which is reserved for inclusion from
                   9217:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9218:        care of rebuilding the MIME database at installation and
                   9219:        deinstallation time, and disallows any access to it directly
                   9220:        from the package.</p></li>
1.75      rillig   9221: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9222:        <code class="filename">share/mime</code> directory,
                   9223:        <span class="emphasis"><em>except</em></span> for files saved under
                   9224:        <code class="filename">share/mime/packages</code>.  The former are
                   9225:        handled automatically by
                   9226:        the update-mime-database program, but the latter are
                   9227:        package-dependent and must be removed by the package that
                   9228:        installed them in the first place.</p></li>
1.76      rillig   9229: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9230:        from the PLIST.  They will be handled by the shared-mime-info
                   9231:        package.</p></li>
1.75      rillig   9232: </ol></div>
                   9233: </div>
                   9234: <div class="sect2" lang="en">
                   9235: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9236: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9237: <p>If a package uses intltool during its build, add
                   9238:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9239:     which forces it to use the intltool package provided by pkgsrc,
                   9240:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9241: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9242:     latest available version; this way, the package benefits of any
                   9243:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9244: </div>
                   9245: <div class="sect2" lang="en">
                   9246: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9247: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9248: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9249:     the startup directory by default, but you can enable it, by adding
                   9250:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9251:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9252:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9253:     it will automatically remove the scripts when the package is
                   9254:     deinstalled.</p>
1.75      rillig   9255: </div>
                   9256: <div class="sect2" lang="en">
                   9257: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9258: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9259: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9260:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9261:     updated.</p>
1.75      rillig   9262: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9263: <h3 class="title">Note</h3>
                   9264: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9265:     packages should install files
                   9266:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9267:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9268: </div>
                   9269: <div class="orderedlist"><ol type="1">
                   9270: <li><p>Include
1.87      wiz      9271:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9272:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9273:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9274:       database at installation and deinstallation time.</p></li>
1.75      rillig   9275: <li>
                   9276: <p>If your package installs files into a texmf
1.87      wiz      9277:       tree other than the one
                   9278:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9279:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9280:       trees that need database update.</p>
1.75      rillig   9281: <p>If your package also installs font map files that need
1.110     hubertf  9282:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.87      wiz      9283:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110     hubertf  9284:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9285:       be run automatically at installation/deinstallation to
                   9286:       enable/disable font map files for TeX output
                   9287:       drivers.</p>
1.75      rillig   9288: </li>
1.76      rillig   9289: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9290:       databases are included in <code class="filename">PLIST</code>, as
                   9291:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9292: </ol></div>
                   9293: </div>
1.85      jmmv     9294: <div class="sect2" lang="en">
                   9295: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9296: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9297:     emulation</h3></div></div></div>
                   9298: <p>There are some packages that provide libraries and
                   9299:     executables for running binaries from a one operating system
                   9300:     on a different one (if the latter supports it).  One example
                   9301:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9302: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9303:     helps in extracting and packaging Linux rpm packages.</p>
                   9304: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9305:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9306:     if all libraries for each installed executable can be found by
                   9307:     the dynamic linker.  Since the standard dynamic linker is run,
                   9308:     this fails for emulation packages, because the libraries used
                   9309:     by the emulation are not in the standard directories.</p>
                   9310: </div>
                   9311: <div class="sect2" lang="en">
                   9312: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9313: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9314: <p>If a package installs images under the
1.87      wiz      9315:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9316:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9317:     database, you need to take some extra steps to make sure that the
                   9318:     shared theme directory is handled appropriately and that the cache
                   9319:     database is rebuilt:</p>
1.85      jmmv     9320: <div class="orderedlist"><ol type="1">
                   9321: <li><p>Include
1.87      wiz      9322:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9323: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9324:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9325: <li><p>Ensure that the PLIST does not remove the shared icon
                   9326:          directories from the <code class="filename">share/icons/hicolor</code>
                   9327:          hierarchy because they will be handled automatically.</p></li>
                   9328: </ol></div>
                   9329: <p>The best way to verify that the PLIST is correct with
                   9330:       respect to the last two points is to regenerate it using
1.110     hubertf  9331:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9332: </div>
                   9333: <div class="sect2" lang="en">
                   9334: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9335: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9336: <p>If a package installs <code class="filename">.desktop</code> files
                   9337:       under <code class="filename">share/applications</code> and these include
                   9338:       MIME information, you need to take extra steps to ensure that they
                   9339:       are registered into the MIME database:</p>
                   9340: <div class="orderedlist"><ol type="1">
                   9341: <li><p>Include
                   9342:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9343: <li><p>Check the PLIST and remove the entry that refers to the
                   9344:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9345:          It will be handled automatically.</p></li>
                   9346: </ol></div>
                   9347: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9348:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9349:       print-PLIST</strong></span>.</p>
1.75      rillig   9350: </div>
                   9351: </div>
1.87      wiz      9352: <div class="sect1" lang="en">
                   9353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9354: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9355: <p>In some cases one does not have the time to solve a problem
                   9356:   immediately.  There are currently two ways to declare that one knows
                   9357:   that a package has problems.</p>
                   9358: <div class="itemizedlist"><ul type="disc">
                   9359: <li><p>The first way is to plainly mark it as broken.  For
                   9360:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9361:     reason why the package is broken (similar to the
                   9362:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9363:     the package will immediately be shown this message, and the build
                   9364:     will not be even tried.</p></li>
                   9365: <li><p>After each pkgsrc freeze period (a time when the
                   9366:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9367:     that were not building in the official branch build on the latest
                   9368:     NetBSD release will be marked as broken on that branch.  This is
                   9369:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9370:     branch name (or appending the branch name to it).  If a user tries
                   9371:     to build such a package and the build fails, the user gets a
                   9372:     message that says that the package was broken on the respective
                   9373:     branch(es).</p></li>
                   9374: </ul></div>
                   9375: <p>Both types of packages are removed from pkgsrc in irregular
                   9376:   intervals.</p>
                   9377: </div>
1.75      rillig   9378: </div>
                   9379: <div class="chapter" lang="en">
                   9380: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9381: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9382: <p>To check out all the gotchas when building a package, here are
                   9383:   the steps that I do in order to get a package working.  Please note
                   9384:   this is basically the same as what was explained in the previous
                   9385:   sections, only with some debugging aids.</p>
1.75      rillig   9386: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9387: <li><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>
1.75      rillig   9388: <li>
1.91      rillig   9389: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9390:       create a directory for a new package, change into it, then run
1.110     hubertf  9391:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9392: <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>
                   9393: <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>
                   9394: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9395: </li>
1.76      rillig   9396: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9397: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110     hubertf  9398: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75      rillig   9399: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9400:       configure step to the package's
                   9401:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9402: <li>
                   9403: <p>Make the package compile, doing multiple rounds of</p>
                   9404: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9405: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9406: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9407: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9408: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9409: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9410: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9411: <p>Doing this step as non-root user will ensure that no files
                   9412:       are modified that shouldn't be, especially during the build
1.110     hubertf  9413:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9414:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9415:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9416:       package.</p>
1.75      rillig   9417: </li>
1.88      wiz      9418: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.122   ! reed     9419:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.75      rillig   9420: <li>
1.76      rillig   9421: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9422: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9423: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9424: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9425: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9426: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9427: <p>You usually need to be <code class="username">root</code> to do
                   9428:       this.  Look if there are any files left:</p>
1.75      rillig   9429: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9430: <p>If this reveals any files that are missing in
1.88      wiz      9431:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9432: </li>
                   9433: <li>
1.88      wiz      9434: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9435:       package again and make a binary package:</p>
1.75      rillig   9436: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9437: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9438: </li>
                   9439: <li>
                   9440: <p>Delete the installed package:</p>
1.88      wiz      9441: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9442: </li>
                   9443: <li>
1.110     hubertf  9444: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9445:       command, which shouldn't find anything now:</p>
1.75      rillig   9446: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9447: </li>
                   9448: <li>
                   9449: <p>Reinstall the binary package:</p>
1.93      rillig   9450: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9451: </li>
1.88      wiz      9452: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9453: <li>
1.110     hubertf  9454: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9455:       reports:</p>
1.75      rillig   9456: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9457: </li>
1.110     hubertf  9458: <li><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9459: </ul></div>
                   9460: </div>
                   9461: <div class="chapter" lang="en">
                   9462: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9463: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9464: <div class="toc">
                   9465: <p><b>Table of Contents</b></p>
                   9466: <dl>
1.106     rillig   9467: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9468: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9469: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9470: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9471: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122   ! reed     9472: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
        !          9473: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9474: </dl>
                   9475: </div>
                   9476: <div class="sect1" lang="en">
                   9477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9478: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9479: <p>Our policy is that we accept binaries only from pkgsrc
                   9480:        developers to guarantee that the packages don't contain any
                   9481:        trojan horses etc. This is not to annoy anyone but rather to
                   9482:        protect our users! You're still free to put up your home-made
                   9483:        binary packages and tell the world where to get them. NetBSD
                   9484:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9485:        see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.75      rillig   9486: </div>
                   9487: <div class="sect1" lang="en">
                   9488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9489: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9490: <p>First, check that your package is complete, compiles and
1.110     hubertf  9491:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9492:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9493:        archive that contains all files that make up the package.
1.87      wiz      9494:        Finally, send this package to the pkgsrc bug tracking system,
1.110     hubertf  9495:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9496:        that, go to the web page
1.110     hubertf  9497:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87      wiz      9498:        which contains some instructions and a link to a form, where you
                   9499:        can submit packages.</p>
                   9500: <p>In the form of the problem report, the category should be
                   9501:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9502:        and version number, and the description field should contain a
                   9503:        short description of your package (contents of the COMMENT
                   9504:        variable or DESCR file are OK). The uuencoded package data should
                   9505:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9506: <p>If you want to submit several packages, please send a
                   9507:        separate PR for each one, it's easier for us to track things
                   9508:        that way.</p>
                   9509: <p>Alternatively, you can also import new packages into
                   9510:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.110     hubertf  9511:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9512:        for details.</p>
                   9513: </div>
                   9514: <div class="sect1" lang="en">
                   9515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9516: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9517: <p>Please note all package additions, updates, moves, and
1.93      rillig   9518:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9519:        important to keep this file up to date and conforming to the
                   9520:        existing format, because it will be used by scripts to
1.110     hubertf  9521:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9522:        sites. Additionally, check the
1.76      rillig   9523:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9524:        for the package you updated or removed, in case it was mentioned
                   9525:        there.</p>
                   9526: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9527:        bumped, the change should appear in
1.93      rillig   9528:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9529:        related or otherwise relevant. Mass bumps that result from a
                   9530:        dependency being updated should not be mentioned. In all other
                   9531:        cases it's the developer's decision.</p>
                   9532: <p>There is a make target that helps in creating proper
1.110     hubertf  9533:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9534:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9535:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9536:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9537:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9538:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9539:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9540:   For new packages, or package moves or removals, set the
                   9541:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9542:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9543:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75      rillig   9544:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9545:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9546: </div>
                   9547: <div class="sect1" lang="en">
                   9548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9549: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9550: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9551:   access to the pkgsrc repository. Please remember that cvs
                   9552:   imports files relative to the current working directory, and that
                   9553:   the pathname that you
1.110     hubertf  9554:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75      rillig   9555:   to place the files in the repository.  Newly created packages should be
                   9556:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9557:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9558: <pre class="programlisting">
1.100     rillig   9559: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9560: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9561: </pre>
1.87      wiz      9562: <p>Remember to move the directory from which you imported out of
1.75      rillig   9563:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9564:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9565:   package to the category's <code class="filename">Makefile</code>.</p>
                   9566: <p>The commit message of the initial import should include part of the
1.76      rillig   9567:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9568:   what the package is/does.</p>
                   9569: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9570:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9571:   and provides a consistent tag.</p>
1.75      rillig   9572: </div>
                   9573: <div class="sect1" lang="en">
                   9574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9575: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9576: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9577:   changes between old and new versions into the commit log when updating
1.87      wiz      9578:   a package. There are various reasons for this:</p>
1.75      rillig   9579: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9580: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9581:   or its information may be overwritten by newer information.</p></li>
                   9582: <li><p>Having the change information between old and new versions in our CVS
                   9583:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9584: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9585:   repository is very useful for people who read the pkgsrc-changes mailing
                   9586:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9587:   the package.</p></li>
1.75      rillig   9588: </ul></div>
1.87      wiz      9589: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9590:   has been released, it should not automatically be upgraded in the CVS
                   9591:   repository.  We prefer to be conservative in the packages that are
                   9592:   included in pkgsrc - development or beta packages are not really the
                   9593:   best thing for most places in which pkgsrc is used. Please use your
                   9594:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9595:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9596: </div>
                   9597: <div class="sect1" lang="en">
                   9598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122   ! reed     9599: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
        !          9600: <p>Renaming packages is not recommended.</p>
        !          9601: <p>When renaming packages, be sure to fix any references to old name
        !          9602:   in other Makefiles, options, buildlink files, etc.</p>
        !          9603: <p>Also When renaming a package, please define
        !          9604:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
        !          9605:   pattern(s) of the previous package name.
        !          9606:   This may be repeated for multiple renames.
        !          9607:   The new package would be an exact replacement.
        !          9608: </p>
        !          9609: <p>Note that &#8220;<span class="quote">successor</span>&#8221; in the
        !          9610:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
        !          9611:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
        !          9612:   not be an exact replacement but is a suggestion for the replaced
        !          9613:   functionality.</p>
        !          9614: </div>
        !          9615: <div class="sect1" lang="en">
        !          9616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !          9617: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
        !          9618: <p>It is preferred that packages are not renamed or moved, but if needed
        !          9619:   please follow these steps.
        !          9620: </p>
1.75      rillig   9621: <div class="orderedlist"><ol type="1">
                   9622: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9623: <li>
                   9624: <p>Remove all CVS dirs.</p>
1.87      wiz      9625: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9626: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9627: <p>and use that for further work.</p>
1.75      rillig   9628: </li>
                   9629: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9630: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9631: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.122   ! reed     9632: <li><p>In the modified package's Makefile, consider setting
        !          9633: <code class="varname">PREV_PKGPATH</code> to the previous category/package
        !          9634: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
        !          9635: for doing an update using pkgsrc building; for example, it can
        !          9636: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
        !          9637: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
        !          9638: new <code class="varname">PKGPATH</code> for that moved package.  Note that
        !          9639: it may have multiple matches, so the tool should also check on the
        !          9640: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
        !          9641: probably has no value unless <code class="varname">SUPERSEDES</code> is not
        !          9642: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.110     hubertf  9643: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9644: place.</p></li>
                   9645: <li>
                   9646: <p>Check if any package depends on it:
                   9647: </p>
                   9648: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9649: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9650: </li>
                   9651: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110     hubertf  9652: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9653: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9654: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9655: <li>
                   9656: <p>Commit the changed and removed files:</p>
                   9657: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9658: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9659: </li>
                   9660: </ol></div>
                   9661: </div>
                   9662: </div>
                   9663: <div class="chapter" lang="en">
                   9664: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9665: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9666: <p>This section contains the answers to questions that may
                   9667:        arise when you are writing a package. If you don't find your
                   9668:        question answered here, first have a look in the other chapters,
                   9669:        and if you still don't have the answer, ask on the
                   9670:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9671: <div class="qandaset">
                   9672: <dl>
1.106     rillig   9673: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9674:        MAKEFLAGS, .MAKEFLAGS and
                   9675:        MAKE_FLAGS?</a>
                   9676: </dt>
1.106     rillig   9677: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9678:        MAKE, GMAKE and
                   9679:        MAKE_PROGRAM?</a>
                   9680: </dt>
1.106     rillig   9681: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9682:        CC, PKG_CC and
                   9683:        PKGSRC_COMPILER?</a>
                   9684: </dt>
1.106     rillig   9685: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9686:        BUILDLINK_LDFLAGS,
                   9687:        BUILDLINK_LDADD and
                   9688:        BUILDLINK_LIBS?</a>
                   9689: </dt>
1.106     rillig   9690: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9691:        VARNAME=BUILDLINK_PREFIX.foo
                   9692:        say it's empty?</a>
                   9693: </dt>
1.106     rillig   9694: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9695:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9696:        don't understand the := inside
                   9697:        it.</a>
                   9698: </dt>
1.106     rillig   9699: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9700:        developers?</a>
                   9701: </dt>
1.106     rillig   9702: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9703:        documentation?</a>
                   9704: </dt>
1.106     rillig   9705: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9706: do?</a>
                   9707: </dt>
1.75      rillig   9708: </dl>
                   9709: <table border="0" summary="Q and A Set">
                   9710: <col align="left" width="1%">
                   9711: <tbody>
                   9712: <tr class="question">
                   9713: <td align="left" valign="top">
1.122   ! reed     9714: <a name="devfaq.makeflags"></a><a name="id1168230192683"></a><p><b>22.1.</b></p>
1.75      rillig   9715: </td>
                   9716: <td align="left" valign="top"><p>What is the difference between
                   9717:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9718:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9719: </tr>
                   9720: <tr class="answer">
1.91      rillig   9721: <td align="left" valign="top"></td>
1.75      rillig   9722: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110     hubertf  9723:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9724:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9725:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9726:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9727: </tr>
                   9728: <tr class="question">
                   9729: <td align="left" valign="top">
1.122   ! reed     9730: <a name="devfaq.make"></a><a name="id1168230192716"></a><p><b>22.2.</b></p>
1.75      rillig   9731: </td>
                   9732: <td align="left" valign="top"><p>What is the difference between
                   9733:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9734:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9735: </tr>
                   9736: <tr class="answer">
1.91      rillig   9737: <td align="left" valign="top"></td>
1.75      rillig   9738: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110     hubertf  9739:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9740:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9741:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9742:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9743:        Make program that is used for building the
                   9744:        package.</p></td>
                   9745: </tr>
                   9746: <tr class="question">
                   9747: <td align="left" valign="top">
1.122   ! reed     9748: <a name="devfaq.cc"></a><a name="id1168230192754"></a><p><b>22.3.</b></p>
1.75      rillig   9749: </td>
                   9750: <td align="left" valign="top"><p>What is the difference between
                   9751:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9752:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9753: </tr>
                   9754: <tr class="answer">
1.91      rillig   9755: <td align="left" valign="top"></td>
1.75      rillig   9756: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9757:        compiler, which can be configured by the pkgsrc user.
                   9758:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9759:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9760:        path to a compiler, but the type of compiler that should be
1.76      rillig   9761:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9762:        information about the latter variable.</p></td>
                   9763: </tr>
                   9764: <tr class="question">
                   9765: <td align="left" valign="top">
1.122   ! reed     9766: <a name="devfaq.bl3flags"></a><a name="id1168230192788"></a><p><b>22.4.</b></p>
1.75      rillig   9767: </td>
                   9768: <td align="left" valign="top"><p>What is the difference between
                   9769:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9770:        <code class="varname">BUILDLINK_LDADD</code> and
                   9771:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9772: </tr>
                   9773: <tr class="answer">
1.91      rillig   9774: <td align="left" valign="top"></td>
1.75      rillig   9775: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9776: </tr>
                   9777: <tr class="question">
                   9778: <td align="left" valign="top">
1.122   ! reed     9779: <a name="devfaq.bl3prefix"></a><a name="id1168230192806"></a><p><b>22.5.</b></p>
1.75      rillig   9780: </td>
1.110     hubertf  9781: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9782:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9783:        say it's empty?</p></td>
                   9784: </tr>
                   9785: <tr class="answer">
1.91      rillig   9786: <td align="left" valign="top"></td>
1.75      rillig   9787: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9788:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9789:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.110     hubertf  9790:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9791:        command.</p></td>
                   9792: </tr>
1.78      rillig   9793: <tr class="question">
                   9794: <td align="left" valign="top">
1.122   ! reed     9795: <a name="devfaq.master_sites"></a><a name="id1168230192833"></a><p><b>22.6.</b></p>
1.78      rillig   9796: </td>
                   9797: <td align="left" valign="top"><p>What does
                   9798:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9799:        don't understand the <code class="literal">:=</code> inside
                   9800:        it.</p></td>
                   9801: </tr>
                   9802: <tr class="answer">
1.91      rillig   9803: <td align="left" valign="top"></td>
1.78      rillig   9804: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9805:        assignment operator, like you might expect at first sight.
                   9806:        Instead, it is a degenerate form of
                   9807:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110     hubertf  9808:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9809:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9810:        case of <code class="varname">MASTER_SITE_*</code>,
                   9811:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9812:        <em class="replaceable"><code>new_string</code></em> is
                   9813:        <code class="literal">package/</code>. That's where the
                   9814:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9815:        together.</p></td>
                   9816: </tr>
                   9817: <tr class="question">
                   9818: <td align="left" valign="top">
1.122   ! reed     9819: <a name="devfaq.mailinglists"></a><a name="id1168230192900"></a><p><b>22.7.</b></p>
1.78      rillig   9820: </td>
                   9821: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9822:        developers?</p></td>
                   9823: </tr>
                   9824: <tr class="answer">
1.91      rillig   9825: <td align="left" valign="top"></td>
1.78      rillig   9826: <td align="left" valign="top"><div class="variablelist"><dl>
1.110     hubertf  9827: <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.78      rillig   9828: <dd><p>This is a list for technical discussions related
                   9829:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9830:        pkgsrc infrastructure, proposed new features, questions related
                   9831:        to porting pkgsrc to a new platform, advice for maintaining a
                   9832:        package, patches that affect many packages, help requests moved
                   9833:        from pkgsrc-users when an infrastructure bug is found,
                   9834:        etc.</p></dd>
1.110     hubertf  9835: <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.78      rillig   9836: <dd><p>All bug reports in category "pkg" sent with
1.110     hubertf  9837:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9838:        directly; use one of the other mailing
                   9839:        lists.</p></dd>
                   9840: </dl></div></td>
                   9841: </tr>
1.80      rillig   9842: <tr class="question">
                   9843: <td align="left" valign="top">
1.122   ! reed     9844: <a name="devfaq.documentation"></a><a name="id1168230192931"></a><p><b>22.8.</b></p>
1.80      rillig   9845: </td>
                   9846: <td align="left" valign="top"><p>Where is the pkgsrc
                   9847:        documentation?</p></td>
                   9848: </tr>
                   9849: <tr class="answer">
1.91      rillig   9850: <td align="left" valign="top"></td>
1.80      rillig   9851: <td align="left" valign="top">
                   9852: <p>There are many places where you can find
                   9853:        documentation about pkgsrc:</p>
                   9854: <div class="itemizedlist"><ul type="disc">
                   9855: <li><p>The pkgsrc guide (this document) is a collection
                   9856:        of chapters that explain large parts of pkgsrc, but some
                   9857:        chapters tend to be outdated. Which ones they are is hard to
                   9858:        say.</p></li>
1.110     hubertf  9859: <li><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.80      rillig   9860:        about certain features, announcements of new parts of the pkgsrc
                   9861:        infrastructure and sometimes even announcements that a certain
                   9862:        feature has been marked as obsolete. The benefit here is that
                   9863:        each message has a date appended to it.</p></li>
                   9864: <li><p>Many of the files in the
                   9865:        <code class="filename">mk/</code> directory start with a comment that
                   9866:        describes the purpose of the file and how it can be used by the
1.92      rillig   9867:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9868:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9869:        help</strong></span>.</p></li>
1.80      rillig   9870: <li><p>The CVS log messages are a rich source of
                   9871:        information, but they tend to be highly abbreviated, especially
                   9872:        for actions that occur often. Some contain a detailed
                   9873:        description of what has changed, but they are geared towards the
                   9874:        other pkgsrc developers, not towards an average pkgsrc user.
                   9875:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9876:        don't know what has been before, these messages may not be worth
                   9877:        too much to you.</p></li>
                   9878: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9879:        documented</span>&#8221;, that is the documentation exists only in the
                   9880:        mind of the developer who wrote the code. To get this
1.110     hubertf  9881:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9882:        to see who has written it and ask on the
                   9883:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9884:        find your questions later (see above). To be sure that the
                   9885:        developer in charge reads the mail, you may CC him or
                   9886:        her.</p></li>
                   9887: </ul></div>
                   9888: </td>
                   9889: </tr>
1.92      rillig   9890: <tr class="question">
                   9891: <td align="left" valign="top">
1.122   ! reed     9892: <a name="devfaq.too-much-time"></a><a name="id1168230192985"></a><p><b>22.9.</b></p>
1.92      rillig   9893: </td>
                   9894: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9895: do?</p></td>
                   9896: </tr>
                   9897: <tr class="answer">
                   9898: <td align="left" valign="top"></td>
                   9899: <td align="left" valign="top">
1.93      rillig   9900: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9901: anyway.</p>
                   9902: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9903: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   9904:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
                   9905:     will tell you about newer versions of installed packages that are
                   9906:     available, but not yet updated in pkgsrc.</p></li>
                   9907: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.114     jmcneill 9908:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9909:     cleanups and enhancements for pkgsrc that would be nice to
                   9910:     have.</p></li>
                   9911: <li><p>Review packages for which review was requested on
1.110     hubertf  9912:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   9913:     mailing list.</p></li>
                   9914: </ul></div>
                   9915: </td>
                   9916: </tr>
1.75      rillig   9917: </tbody>
                   9918: </table>
                   9919: </div>
                   9920: </div>
1.85      jmmv     9921: <div class="chapter" lang="en">
                   9922: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9923: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9924: <div class="toc">
                   9925: <p><b>Table of Contents</b></p>
                   9926: <dl>
1.106     rillig   9927: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9928: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9929: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9930: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9931: </dl>
                   9932: </div>
1.110     hubertf  9933: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9934: site</a>:</p>
                   9935: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9936:   environment, an intuitive and attractive desktop for users, and the
                   9937:   GNOME development platform, an extensive framework for building
                   9938:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9939: <p>pkgsrc provides a seamless way to automatically build and install
                   9940: a complete GNOME environment <span class="emphasis"><em>under many different
                   9941: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9942: the most advanced build and packaging systems for GNOME due to its
                   9943: included technologies buildlink3, the wrappers and tools framework and
                   9944: automatic configuration file management.  Lots of efforts are put into
                   9945: achieving a completely clean deinstallation of installed software
                   9946: components.</p>
1.110     hubertf  9947: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9948: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9949: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9950: pkgsrc as its preferred packaging system, contributing lots of
                   9951: portability fixes to make GNOME build and install under it.</p>
                   9952: <p>This chapter is aimed at pkgsrc developers and other people
                   9953: interested in helping our GNOME porting and packaging efforts.  It
                   9954: provides instructions on how to manage the existing packages and some
                   9955: important information regarding their internals.</p>
                   9956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9957: <h3 class="title">We need your help!</h3>
                   9958: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9959:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9960:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9961:   work</a> list!  There is still a long way to go to get a
                   9962:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9963:   achieve it!</p>
                   9964: </div>
                   9965: <div class="sect1" lang="en">
                   9966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9967: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9968: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9969: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9970: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9971:     the core GNOME desktop environment.  It only includes the necessary
                   9972:     bits to get it to boot correctly, although it may lack important
                   9973:     functionality for daily operation.  The idea behind this package is
                   9974:     to let end users build their own configurations on top of this one,
                   9975:     first installing this meta package to achieve a functional setup and
                   9976:     then adding individual applications.</p></li>
1.91      rillig   9977: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9978:     complete installation of the GNOME platform and desktop as defined
                   9979:     by the GNOME project; this is based on the components distributed in
                   9980:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9981:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9982:     official FTP server.  Developer-only tools found in those
                   9983:     directories are not installed unless required by some other
                   9984:     component to work properly.  Similarly, packages from the bindings
                   9985:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9986:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9987:     package "extends" <a href="ftp://ftp.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>
                   9988: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9989:     Installs all the tools required to build a GNOME component when
                   9990:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9991:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9992: </ul></div>
                   9993: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9994: sorted in a way that eases updates: a package may depend on other
                   9995: packages listed before it but not on any listed after it.  It is very
                   9996: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9997: change it to alphabetical sorting!</em></span></p>
                   9998: </div>
                   9999: <div class="sect1" lang="en">
                   10000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10001: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     10002: <p>Almost all GNOME applications are written in C and use a common
                   10003: set of tools as their build system.  Things get different with the new
                   10004: bindings to other languages (such as Python), but the following will
                   10005: give you a general idea on the minimum required tools:</p>
                   10006: <div class="itemizedlist"><ul type="disc">
                   10007: <li>
                   10008: <p>Almost all GNOME applications use the GNU Autotools as their
                   10009:     build system.  As a general rule you will need to tell this to your
                   10010:     package:</p>
1.100     rillig   10011: <pre class="programlisting">
                   10012: GNU_CONFIGURE=yes
1.85      jmmv     10013: USE_LIBTOOL=yes
1.100     rillig   10014: USE_TOOLS+=gmake
                   10015: </pre>
1.85      jmmv     10016: </li>
                   10017: <li>
                   10018: <p>If the package uses pkg-config to detect dependencies, add this
                   10019:     tool to the list of required utilities:</p>
                   10020: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   10021: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     10022:     the end of the build process to ensure that you did not miss to
                   10023:     specify any dependency in your package and that the version
                   10024:     requirements are all correct.</p>
                   10025: </li>
1.93      rillig   10026: <li><p>If the package uses intltool, be sure to add
                   10027:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     10028:     to handle dependencies and to force the package to use the latest
                   10029:     available version.</p></li>
                   10030: <li>
                   10031: <p>If the package uses gtk-doc (a documentation generation
                   10032:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   10033:     tool is rather big and the distfile should come with pregenerated
                   10034:     documentation anyway; if it does not, it is a bug that you ought to
                   10035:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   10036:     the default):</p>
                   10037: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   10038: <p>The default location of installed HTML files
                   10039:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   10040:     and should not be changed unless the package insists on installing
                   10041:     them somewhere else.  Otherwise programs as
1.110     hubertf  10042:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   10043:     do that with an entry similar to:</p>
                   10044: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     10045: </li>
                   10046: </ul></div>
                   10047: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10048: files under the installation prefix to maintain databases.  In this
                   10049: context, shared means that those exact same directories and files are
                   10050: used among several different packages, leading to conflicts in the
                   10051: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10052: handle the most common cases, so you have to forget about using
                   10053: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10054: omitting shared files from them.  If you find yourself doing those,
                   10055: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10056: <p>The following table lists the common situations that result in
                   10057: using shared directories or files.  For each of them, the appropriate
                   10058: solution is given.  After applying the solution be sure to
                   10059: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  10060: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     10061: <div class="table">
1.106     rillig   10062: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   10063: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     10064: <colgroup>
                   10065: <col>
                   10066: <col>
                   10067: </colgroup>
                   10068: <thead><tr>
                   10069: <th>If the package...</th>
                   10070: <th>Then...</th>
                   10071: </tr></thead>
                   10072: <tbody>
                   10073: <tr>
                   10074: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   10075: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     10076: </tr>
                   10077: <tr>
                   10078: <td>Installs icons under the
                   10079:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10080:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  10081: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     10082: </tr>
                   10083: <tr>
                   10084: <td>Installs files under
                   10085:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  10086: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     10087: </tr>
                   10088: <tr>
                   10089: <td>Installs <code class="filename">.desktop</code> files under
                   10090:         <code class="filename">share/applications</code> and these include MIME
                   10091:         information.</td>
1.110     hubertf  10092: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     10093: </tr>
                   10094: </tbody>
1.91      rillig   10095: </table></div>
1.85      jmmv     10096: </div>
1.91      rillig   10097: <br class="table-break">
1.85      jmmv     10098: </div>
                   10099: <div class="sect1" lang="en">
                   10100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10101: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     10102: <p>When seeing GNOME as a whole, there are two kinds of
                   10103: updates:</p>
                   10104: <div class="variablelist"><dl>
                   10105: <dt><span class="term">Major update</span></dt>
                   10106: <dd>
                   10107: <p>Given that there is still a very long way for GNOME 3 (if it
                   10108:       ever appears), we consider a major update one that goes from a
                   10109:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10110:       where <code class="literal">Y</code> is even and greater than
                   10111:       <code class="literal">X</code>.  These are hard to achieve because they
                   10112:       introduce lots of changes in the components' code and almost all
                   10113:       GNOME distfiles are updated to newer versions.  Some of them can
                   10114:       even break API and ABI compatibility with the previous major
                   10115:       version series.  As a result, the update needs to be done all at
                   10116:       once to minimize breakage.</p>
                   10117: <p>A major update typically consists of around 80 package
                   10118:       updates and the addition of some new ones.</p>
                   10119: </dd>
                   10120: <dt><span class="term">Minor update</span></dt>
                   10121: <dd>
                   10122: <p>We consider a minor update one that goes from a
                   10123:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10124:       one where <code class="literal">Y</code> is greater than
                   10125:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10126:       not update all GNOME components, can be done in an incremental way
                   10127:       and do not break API nor ABI compatibility.</p>
                   10128: <p>A minor update typically consists of around 50 package
                   10129:       updates, although the numbers here may vary a lot.</p>
                   10130: </dd>
                   10131: </dl></div>
                   10132: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10133: release (either major or minor), the following steps should be
                   10134: followed:</p>
                   10135: <div class="orderedlist"><ol type="1">
                   10136: <li>
                   10137: <p>Get a list of all the tarballs that form the new release by
                   10138:     using the following commands.  These will leave the full list of the
1.120     snj      10139:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     10140:     file:</p>
1.88      wiz      10141: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10142:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10143:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10144: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10145:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10146:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10147: </li>
                   10148: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10149:     bump their version to the release you are updating them to.  The
                   10150:     three meta packages should be always consistent with versioning.
                   10151:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10152:     in them.</p></li>
                   10153: <li>
                   10154: <p>For each meta package, update all its
                   10155:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10156:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10157:     newer version (even if found in the FTP) because the meta packages
                   10158:     are supposed to list the exact versions that form a specific GNOME
                   10159:     release.  Exceptions are permitted here if a newer version solves a
                   10160:     serious issue in the overall desktop experience; these typically
                   10161:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10162:     from the developers.</p>
                   10163: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10164:     should be updated to the latest version available (if found in
                   10165:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10166:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     10167: </li>
                   10168: <li>
                   10169: <p>Generate a patch from the modified meta packages and extract the
                   10170:     list of "new" lines.  This will provide you an outline on what
                   10171:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10172: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     10173: </li>
                   10174: <li><p>For major desktop updates it is recommended to zap all your
                   10175:     installed packages and start over from scratch at this point.</p></li>
                   10176: <li><p>Now comes the longest step by far: iterate over the contents
                   10177:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10178:     it in order.  For major desktop updates none of these should be
1.93      rillig   10179:     committed until the entire set is completed because there are chances
1.85      jmmv     10180:     of breaking not-yet-updated packages.</p></li>
                   10181: <li><p>Once the packages are up to date and working, commit them to
                   10182:     the tree one by one with appropriate log messages.  At the end,
                   10183:     commit the three meta package updates and all the corresponding
                   10184:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10185:     <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>
                   10186: </ol></div>
                   10187: </div>
                   10188: <div class="sect1" lang="en">
                   10189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10190: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10191: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10192: packages.  Please, it is very important that you always, always,
                   10193: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10194: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     10195: their attention on portability issues and to ensure that future versions
                   10196: can be built out-of-the box on NetBSD.  The less custom patches in
                   10197: pkgsrc, the easier further updates are.  Those developers in charge of
                   10198: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10199: <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.85      jmmv     10200: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10201: of them do.  Do not be short on your reports: always provide detailed
                   10202: explanations of the current failure, how it can be improved to achieve
                   10203: maximum portability and, if at all possible, provide a patch against CVS
                   10204: head.  The more verbose you are, the higher chances of your patch being
                   10205: accepted.</p>
                   10206: <p>Also, please avoid using preprocessor magic to fix portability
                   10207: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10208: GNOME to their operating system, the official GNOME sources are now
                   10209: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10210: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10211: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     10212: details.</p>
                   10213: </div>
                   10214: </div>
1.75      rillig   10215: </div>
                   10216: <div class="part" lang="en">
                   10217: <div class="titlepage"><div><div><h1 class="title">
                   10218: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10219: <div class="partintro" lang="en">
                   10220: <div></div>
                   10221: <p>This part of the guide deals with everything
                   10222:        from the infrastructure that is behind the interfaces described
                   10223:        in the developer's guide. A casual package maintainer should not
                   10224:        need anything from this part.</p>
                   10225: <div class="toc">
                   10226: <p><b>Table of Contents</b></p>
                   10227: <dl>
1.106     rillig   10228: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10229: <dd><dl>
1.106     rillig   10230: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10231: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10232: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10233: <dd><dl>
1.106     rillig   10234: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10235: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10236: </dl></dd>
1.106     rillig   10237: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10238: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10239: <dd><dl>
1.106     rillig   10240: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10241: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10242: </dl></dd>
1.106     rillig   10243: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10244: <dd><dl>
1.122   ! reed     10245: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
        !          10246: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10247: </dl></dd>
                   10248: </dl></dd>
1.106     rillig   10249: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10250: <dd><dl>
1.106     rillig   10251: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10252: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10253: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10254: <dd><dl>
1.106     rillig   10255: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10256: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10257: </dl></dd>
                   10258: </dl></dd>
1.106     rillig   10259: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10260: <dd><dl>
1.106     rillig   10261: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10262: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10263: </dl></dd>
                   10264: </dl>
                   10265: </div>
                   10266: </div>
                   10267: <div class="chapter" lang="en">
                   10268: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10269: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10270: <div class="toc">
                   10271: <p><b>Table of Contents</b></p>
                   10272: <dl>
1.106     rillig   10273: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10274: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10275: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10276: <dd><dl>
1.106     rillig   10277: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10278: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10279: </dl></dd>
1.106     rillig   10280: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10281: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10282: <dd><dl>
1.106     rillig   10283: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10284: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10285: </dl></dd>
1.106     rillig   10286: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10287: <dd><dl>
1.122   ! reed     10288: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
        !          10289: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10290: </dl></dd>
                   10291: </dl>
                   10292: </div>
                   10293: <p>The pkgsrc infrastructure consists of many small Makefile
                   10294:        fragments. Each such fragment needs a properly specified
                   10295:        interface. This chapter explains how such an interface looks
                   10296:        like.</p>
                   10297: <div class="sect1" lang="en">
                   10298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10299: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10300: <p>Whenever a variable is defined in the pkgsrc
                   10301:        infrastructure, the location and the way of definition provide
                   10302:        much information about the intended use of that variable.
                   10303:        Additionally, more documentation may be found in a header
                   10304:        comment or in this pkgsrc guide.</p>
                   10305: <p>A special file is
                   10306:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10307:        variables that are intended to be user-defined. They are either
                   10308:        defined using the <code class="literal">?=</code> operator or they are
                   10309:        left undefined because defining them to anything would
                   10310:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10311:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10312:        file.</p>
                   10313: <p>Outside this file, the following conventions apply:
                   10314:        Variables that are defined using the <code class="literal">?=</code>
                   10315:        operator may be overridden by a package.</p>
                   10316: <p>Variables that are defined using the <code class="literal">=</code>
                   10317:        operator may be used read-only at run-time.</p>
                   10318: <p>Variables whose name starts with an underscore must not be
                   10319:        accessed outside the pkgsrc infrastructure at all. They may
                   10320:        change without further notice.</p>
                   10321: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10322: <h3 class="title">Note</h3>
                   10323: <p>These conventions are currently not applied
                   10324:        consistently to the complete pkgsrc
                   10325:        infrastructure.</p>
                   10326: </div>
                   10327: </div>
                   10328: <div class="sect1" lang="en">
                   10329: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10330: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10331: <p>All variables that contain lists of things should default
                   10332:        to being empty. Two examples that do not follow this rule are
                   10333:        <code class="varname">USE_LANGUAGES</code> and
                   10334:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10335:        modified using the <code class="literal">+=</code> operator in package
                   10336:        <code class="filename">Makefile</code>s (or other files included by
                   10337:        them), since there is no guarantee whether the variable is
                   10338:        already set or not, and what its value is. In the case of
                   10339:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10340:        the default value and just define it as in the following
                   10341:        example.</p>
                   10342: <pre class="programlisting">
1.100     rillig   10343: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10344: </pre>
                   10345: <p>Because of the selection of this default value, the same
                   10346:        value appears in many package Makefiles. Similarly for
                   10347:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10348:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10349:        doesn't stand out. Nevertheless it is mentioned in many
                   10350:        files.</p>
                   10351: </div>
                   10352: <div class="sect1" lang="en">
                   10353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10354: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10355: <div class="sect2" lang="en">
                   10356: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10357: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10358: <p>Variable evaluation takes place either at load time or at
                   10359:        runtime, depending on the context in which they occur. The
                   10360:        contexts where variables are evaluated at load time are:</p>
                   10361: <div class="itemizedlist"><ul type="disc">
                   10362: <li><p>The right hand side of the <code class="literal">:=</code>
                   10363:        and <code class="literal">!=</code> operators,</p></li>
                   10364: <li><p>Make directives like <code class="literal">.if</code> or
                   10365:        <code class="literal">.for</code>,</p></li>
                   10366: <li><p>Dependency lines.</p></li>
                   10367: </ul></div>
                   10368: <p>A special exception are references to the iteration
                   10369:        variables of <code class="literal">.for</code> loops, which are expanded
                   10370:        inline, no matter in which context they appear.</p>
                   10371: <p>As the values of variables may change during load time,
                   10372:        care must be taken not to evaluate them by accident. Typical
                   10373:        examples for variables that should not be evaluated at load time
                   10374:        are <code class="varname">DEPENDS</code> and
                   10375:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10376:        clear, here is an example:</p>
                   10377: <pre class="programlisting">
1.100     rillig   10378: CONFIGURE_ARGS=         # none
                   10379: CFLAGS=                 -O
                   10380: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10381: 
1.100     rillig   10382: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10383: 
1.100     rillig   10384: CFLAGS+=                -Wall
1.75      rillig   10385:        </pre>
                   10386: <p>This code shows how the use of the <code class="literal">:=</code>
                   10387:        operator can quickly lead to unexpected results. The first
                   10388:        paragraph is fairly common code. The second paragraph evaluates
                   10389:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10390:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10391:        <code class="literal">-Wall</code> is appended to the
                   10392:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10393:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10394:        paragraphs from above typically occur in completely unrelated
                   10395:        files.</p>
                   10396: </div>
                   10397: <div class="sect2" lang="en">
                   10398: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10399: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10400: <p>After all the files have been loaded, the values of the
                   10401:        variables cannot be changed anymore. Variables that are used in
                   10402:        the shell commands are expanded at this point.</p>
                   10403: </div>
                   10404: </div>
                   10405: <div class="sect1" lang="en">
                   10406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10407: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10408: <p>There are many ways in which the definition and use of a
                   10409:        variable can be restricted in order to detect bugs and
                   10410:        violations of the (mostly unwritten) policies. See the
                   10411:        <code class="literal">pkglint</code> developer's documentation for further
                   10412:        details.</p>
                   10413: </div>
                   10414: <div class="sect1" lang="en">
                   10415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10416: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10417: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10418:        of the following classes. Cases where a file falls into more
                   10419:        than one class should be avoided as it often leads to subtle
                   10420:        bugs.</p>
                   10421: <div class="sect2" lang="en">
                   10422: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10423: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10424: <p>In a traditional imperative programming language some of
1.76      rillig   10425:        the <code class="filename">.mk</code> files could be described as
1.114     jmcneill 10426:        procedures. They take some input parameters and&mdash;after
                   10427:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10428:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10429:        care must be taken not to use parameter names that have already
                   10430:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10431:        bad choice for a parameter name.</p>
                   10432: <p>Procedures are completely evaluated at preprocessing time.
                   10433:        That is, when calling a procedure all input parameters must be
                   10434:        completely resolvable. For example,
                   10435:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10436:        parameter since it is very likely that further text will be
                   10437:        added after calling the procedure, which would effectively apply
                   10438:        the procedure to only a part of the variable. Also, references
                   10439:        to other variables wit will be modified after calling the
                   10440:        procedure.</p>
                   10441: <p>A procedure can declare its output parameters either as
                   10442:        suitable for use in preprocessing directives or as only
                   10443:        available at runtime. The latter alternative is for variables
                   10444:        that contain references to other runtime variables.</p>
                   10445: <p>Procedures shall be written such that it is possible to
                   10446:        call the procedure more than once. That is, the file must not
                   10447:        contain multiple-inclusion guards.</p>
                   10448: <p>Examples for procedures are
1.76      rillig   10449:        <code class="filename">mk/bsd.options.mk</code> and
                   10450:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10451:        that the parameters are evaluated at load time, they should be
                   10452:        assigned using the <code class="literal">:=</code> operator, which should
                   10453:        be used only for this purpose.</p>
                   10454: </div>
                   10455: <div class="sect2" lang="en">
                   10456: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10457: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10458: <p>Action files take some input parameters and may define
                   10459:        runtime variables. They shall not define loadtime variables.
                   10460:        There are action files that are included implicitly by the
                   10461:        pkgsrc infrastructure, while other must be included
                   10462:        explicitly.</p>
                   10463: <p>An example for action files is
1.76      rillig   10464:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10465: </div>
                   10466: </div>
1.81      rillig   10467: <div class="sect1" lang="en">
                   10468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10469: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10470: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10471:        a set of variable definitions, and include the file
                   10472:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10473:        Before that, they may also include various other
                   10474:        <code class="filename">*.mk</code> files if they need to query the
                   10475:        availability of certain features like the type of compiler or
                   10476:        the X11 implementation. Due to the heavy use of preprocessor
                   10477:        directives like <code class="literal">.if</code> and
                   10478:        <code class="literal">.for</code>, the order in which the files are loaded
                   10479:        matters.</p>
                   10480: <p>This section describes at which point the various files
                   10481:        are loaded and gives reasons for that order.</p>
                   10482: <div class="sect2" lang="en">
                   10483: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10484: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10485: </h3></div></div></div>
                   10486: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10487:        is to define some essential variables like
                   10488:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10489:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10490: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10491:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10492:        After that, those variables
1.81      rillig   10493:        that have not been overridden by the user are loaded from
                   10494:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10495: <p>After the user settings, the system settings and platform
                   10496:        settings are loaded, which may override the user
                   10497:        settings.</p>
                   10498: <p>Then, the tool definitions are loaded. The tool wrappers
                   10499:        are not yet in effect. This only happens when building a
                   10500:        package, so the proper variables must be used instead of the
                   10501:        direct tool names.</p>
                   10502: <p>As the last steps, some essential variables from the
                   10503:        wrapper and the package system flavor are loaded, as well as the
                   10504:        variables that have been cached in earlier phases of a package
                   10505:        build.</p>
                   10506: </div>
                   10507: <div class="sect2" lang="en">
                   10508: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10509: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10510: </h3></div></div></div>
1.81      rillig   10511: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10512: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10513:        loaded, which fill default values for those variables that have
1.93      rillig   10514:        not been defined by the package. These variables may later
1.81      rillig   10515:        be used even in unrelated files.</p>
                   10516: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10517:        provides the target <code class="literal">error-check</code> that is added
                   10518:        as a special dependency to all other targets that use
                   10519:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10520:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10521: <p>Then, the package-specific hacks from
                   10522:        <code class="filename">hacks.mk</code> are included.</p>
                   10523: <p>Then, various other files follow. Most of them don't have
                   10524:        any dependencies on what they need to have included before or
                   10525:        after them, though some do.</p>
                   10526: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10527:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10528:        restricts the use of these variables to all the files that have
                   10529:        been included before. Appearances in later files will be
                   10530:        silently ignored.</p>
                   10531: <p>Then, the files for the main targets are included, in the
                   10532:        order of later execution, though the actual order should not
                   10533:        matter.</p>
                   10534: <p>At last, some more files are included that don't set any
                   10535:        interesting variables but rather just define make targets to be
                   10536:        executed.</p>
                   10537: </div>
                   10538: </div>
1.75      rillig   10539: </div>
                   10540: <div class="chapter" lang="en">
                   10541: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10542: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10543: <div class="toc">
                   10544: <p><b>Table of Contents</b></p>
                   10545: <dl>
1.106     rillig   10546: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10547: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10548: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10549: <dd><dl>
1.106     rillig   10550: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10551: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10552: </dl></dd>
                   10553: </dl>
                   10554: </div>
                   10555: <p>The pkgsrc infrastructure consists of a large codebase,
                   10556:        and there are many corners where every little bit of a file is
                   10557:        well thought out, making pkgsrc likely to fail as soon as
                   10558:        anything is changed near those parts. To prevent most changes
                   10559:        from breaking anything, a suite of regression tests should go
                   10560:        along with every important part of the pkgsrc infrastructure.
                   10561:        This chapter describes how regression tests work in pkgsrc and
                   10562:        how you can add new tests.</p>
                   10563: <div class="sect1" lang="en">
                   10564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10565: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10566: <p></p>
                   10567: </div>
                   10568: <div class="sect1" lang="en">
                   10569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10570: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10571: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10572:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10573:        can simply run that command, which will run all tests in the
1.76      rillig   10574:        <code class="filename">regress</code> category.</p>
1.75      rillig   10575: </div>
                   10576: <div class="sect1" lang="en">
                   10577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10578: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10579: <p>Every directory in the <code class="filename">regress</code>
                   10580:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10581:        is considered a regression test. This file is a shell program
1.110     hubertf  10582:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10583:        The following functions can be overridden to suit your
                   10584:        needs.</p>
                   10585: <div class="sect2" lang="en">
                   10586: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10587: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10588: <p>These functions do not take any parameters. They are all
                   10589:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10590:        to check the exitcodes of any commands you run in the
                   10591:        test.</p>
                   10592: <div class="variablelist"><dl>
                   10593: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10594: <dd><p>This function prepares the environment for the
                   10595:        test. By default it does nothing.</p></dd>
                   10596: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10597: <dd><p>This function runs the actual test. By default,
                   10598:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10599:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10600:        error messages into the file
                   10601:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10602: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10603: <dd><p>This function is run after the test and is
                   10604:        typically used to compare the actual output from the one that is
                   10605:        expected. It can make use of the various helper functions from
                   10606:        the next section.</p></dd>
                   10607: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10608: <dd><p>This function cleans everything up after the
                   10609:        test has been run. By default it does nothing.</p></dd>
                   10610: </dl></div>
                   10611: </div>
                   10612: <div class="sect2" lang="en">
                   10613: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10614: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10615: <div class="variablelist"><dl>
                   10616: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10617: <dd><p>This function compares the exitcode of the
1.110     hubertf  10618:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10619:        If they differ, the test will fail.</p></dd>
                   10620: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10621: <dd><p>This function checks for each of its parameters
1.110     hubertf  10622:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10623:        extended regular expression. If it does not, the test will
                   10624:        fail.</p></dd>
                   10625: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10626: <dd><p>This function checks for each of its parameters
1.110     hubertf  10627:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10628:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10629:        If any of the regular expressions matches, the test will
                   10630:        fail.</p></dd>
                   10631: </dl></div>
                   10632: </div>
                   10633: </div>
                   10634: </div>
                   10635: <div class="chapter" lang="en">
                   10636: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10637: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10638: <div class="toc">
                   10639: <p><b>Table of Contents</b></p>
                   10640: <dl>
1.106     rillig   10641: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10642: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10643: </dl>
                   10644: </div>
                   10645: <p>The pkgsrc system has already been ported to many
                   10646:        operating systems, hardware architectures and compilers. This
                   10647:        chapter explains the necessary steps to make pkgsrc even more
                   10648:        portable.</p>
                   10649: <div class="sect1" lang="en">
                   10650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10651: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10652: <p>To port pkgsrc to a new operating system (called
                   10653:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10654:        following files:</p>
                   10655: <div class="variablelist"><dl>
1.93      rillig   10656: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10657: <dd><p>This file contains some basic definitions, for
                   10658:        example the name of the C
                   10659:        compiler.</p></dd>
1.76      rillig   10660: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10661: <dd><p>Insert code that defines the variables
                   10662:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10663:        <code class="varname">LOWER_OS_VERSION</code>,
                   10664:        <code class="varname">LOWER_VENDOR</code>,
                   10665:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10666:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10667:        appear in this file.</p></dd>
1.93      rillig   10668: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10669: <dd><p>This file contains the platform-specific
                   10670:        definitions that are used by pkgsrc. Start by copying one of the
                   10671:        other files and edit it to your
                   10672:        needs.</p></dd>
1.93      rillig   10673: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10674: <dd><p>This file contains a list of directories,
                   10675:        together with their permission bits and ownership. These
                   10676:        directories will be created automatically with every package
1.98      wiz      10677:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10678:        be removed.</p></dd>
1.93      rillig   10679: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10680: <dd><p>Just copy one of the pre-existing x11.dist files
                   10681:        to your
1.76      rillig   10682:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10683: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10684: <dd><p>On some operating systems, the tools that are
                   10685:        provided with the base system are not good enough for pkgsrc.
1.110     hubertf  10686:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75      rillig   10687:        narrow limit on the line length they can process. Therefore
                   10688:        pkgsrc brings its own tools, which can be enabled
                   10689:        here.</p></dd>
1.93      rillig   10690: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10691: <dd><p>This file defines the paths to all the tools
                   10692:        that are needed by one or the other package in pkgsrc, as well
                   10693:        as by pkgsrc itself. Find out where these tools are on your
                   10694:        platform and add them.</p></dd>
                   10695: </dl></div>
                   10696: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10697:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10698: </div>
                   10699: <div class="sect1" lang="en">
                   10700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10701: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10702: <p>TODO</p>
                   10703: </div>
                   10704: </div>
                   10705: </div>
                   10706: <div class="appendix" lang="en">
                   10707: <div class="titlepage"><div><div><h2 class="title">
                   10708: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10709: <div class="toc">
                   10710: <p><b>Table of Contents</b></p>
                   10711: <dl>
                   10712: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10713: <dd><dl>
                   10714: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10715: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10716: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.122   ! reed     10717: <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.75      rillig   10718: </dl></dd>
                   10719: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10720: </dl>
                   10721: </div>
                   10722: <p>We checked to find a piece of software that wasn't in the packages
                   10723:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10724:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10725:     present in the tree is beyond us, but it's useful for the purposes of
                   10726:     this exercise.</p>
                   10727: <div class="sect1" lang="en">
                   10728: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10729: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10730: <div class="sect2" lang="en">
                   10731: <div class="titlepage"><div><div><h3 class="title">
                   10732: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10733: <pre class="programlisting">
1.100     rillig   10734: # $NetBSD$
                   10735: #
1.1       grant    10736: 
1.100     rillig   10737: DISTNAME=       bison-1.25
                   10738: CATEGORIES=     devel
                   10739: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10740: 
1.100     rillig   10741: MAINTAINER=     thorpej@NetBSD.org
                   10742: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10743: COMMENT=        GNU yacc clone
1.1       grant    10744: 
1.100     rillig   10745: GNU_CONFIGURE=  yes
                   10746: INFO_FILES=     bison.info
1.1       grant    10747: 
1.100     rillig   10748: .include "../../mk/bsd.pkg.mk"
1.1       grant    10749: </pre>
1.75      rillig   10750: </div>
                   10751: <div class="sect2" lang="en">
                   10752: <div class="titlepage"><div><div><h3 class="title">
                   10753: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10754: <pre class="programlisting">
1.100     rillig   10755: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.110     hubertf  10756: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10757: of the NetBSD source tree is beyond me.
1.1       grant    10758: </pre>
1.75      rillig   10759: </div>
                   10760: <div class="sect2" lang="en">
                   10761: <div class="titlepage"><div><div><h3 class="title">
                   10762: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10763: <pre class="programlisting">
1.100     rillig   10764: @comment $NetBSD$
                   10765: bin/bison
                   10766: man/man1/bison.1.gz
                   10767: share/bison.simple
                   10768: share/bison.hairy
1.1       grant    10769: </pre>
1.75      rillig   10770: </div>
                   10771: <div class="sect2" lang="en">
                   10772: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10773: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10774: </h3></div></div></div>
1.75      rillig   10775: <p>The NetBSD package system comes with
1.91      rillig   10776:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10777:        which helps to check the contents of these
                   10778:        files. After installation it is quite easy to use, just change to the
                   10779:        directory of the package you wish to examine and execute
1.110     hubertf  10780:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10781: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10782: looks fine.</pre>
                   10783: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10784:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10785:        -Wall</strong></span> for a very thorough check.</p>
                   10786: </div>
                   10787: </div>
                   10788: <div class="sect1" lang="en">
                   10789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10790: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10791: <p>Create the directory where the package lives,
                   10792:       plus any auxiliary directories:</p>
                   10793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10794: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10795: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10796: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10797: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10798:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10799:       then continue with fetching the distfile:</p>
                   10800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10801: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10802: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10803: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10804: ftp: Error retrieving file: 500 Internal error
                   10805: 
                   10806: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10807: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10808: ftp: Error retrieving file: 500 Internal error
                   10809: 
                   10810: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10811: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10812: Successfully retrieved file.</pre>
                   10813: <p>Generate the checksum of the distfile into
1.76      rillig   10814:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10815: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10816: <p>Now compile:</p>
                   10817: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10818: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10819: ===&gt;  Extracting for bison-1.25
                   10820: ===&gt;  Patching for bison-1.25
                   10821: ===&gt;   Ignoring empty patch directory
                   10822: ===&gt;  Configuring for bison-1.25
                   10823: creating cache ./config.cache
                   10824: checking for gcc... cc
                   10825: checking whether we are using GNU C... yes
                   10826: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10827: checking how to run the C preprocessor... cc -E
                   10828: checking for minix/config.h... no
                   10829: checking for POSIXized ISC... no
                   10830: checking whether cross-compiling... no
                   10831: checking for ANSI C header files... yes
                   10832: checking for string.h... yes
                   10833: checking for stdlib.h... yes
                   10834: checking for memory.h... yes
                   10835: checking for working const... yes
                   10836: checking for working alloca.h... no
                   10837: checking for alloca... yes
                   10838: checking for strerror... yes
                   10839: updating cache ./config.cache
                   10840: creating ./config.status
                   10841: creating Makefile
                   10842: ===&gt;  Building for bison-1.25
                   10843: 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
                   10844: 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
                   10845: 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
                   10846: 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
                   10847: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10848: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10849: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getargs.c
                   10850: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g gram.c
                   10851: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lalr.c
                   10852: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lex.c
                   10853: 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
                   10854: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g nullable.c
                   10855: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g output.c
                   10856: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g print.c
                   10857: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reader.c
                   10858: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reduce.c
                   10859: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g symtab.c
                   10860: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10861: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10862: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10863: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10864: 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
                   10865: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10866: rm -f bison.s1
1.75      rillig   10867: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10868: <p>Everything seems OK, so install the files:</p>
                   10869: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10870: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10871: ===&gt;  Installing for bison-1.25
                   10872: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10873: rm -f /usr/pkg/bin/bison
                   10874: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10875: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10876: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10877: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10878: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10879: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10880: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10881: ===&gt;  Registering installation for bison-1.25</pre>
                   10882: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10883:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10884:       binary package, do this now:</p>
                   10885: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10886: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10887: ===&gt;  Building package for bison-1.25
                   10888: Creating package bison-1.25.tgz
                   10889: Registering depends:.
1.75      rillig   10890: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10891: <p>Now that you don't need the source and object files
                   10892:       any more, clean up:</p>
                   10893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10894: ===&gt;  Cleaning for bison-1.25</pre>
                   10895: </div>
                   10896: </div>
                   10897: <div class="appendix" lang="en">
                   10898: <div class="titlepage"><div><div><h2 class="title">
                   10899: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10900: <div class="toc">
                   10901: <p><b>Table of Contents</b></p>
                   10902: <dl>
                   10903: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10904: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10905: </dl>
                   10906: </div>
                   10907: <div class="sect1" lang="en">
                   10908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10909: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10911: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10912: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10913: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10914: =&gt; [172219 bytes]
                   10915: Connected to ftp.plig.net.
                   10916: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10917: 331 Guest login ok, send your complete e-mail address as password.
                   10918: 230-You are user #5 of 500 simultaneous users allowed.
                   10919: 230-
1.68      rillig   10920: 230-  ___ _             _ _
                   10921: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10922: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10923: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10924: 230-         |_|   |_|     |___|         |___|
                   10925: 230-
                   10926: 230-** Welcome to ftp.plig.org **
                   10927: 230-
                   10928: 230-Please note that all transfers from this FTP site are logged. If you
                   10929: 230-do not like this, please disconnect now.
                   10930: 230-
1.120     snj      10931: 230-This archive is available via
1.1       grant    10932: 230-
                   10933: 230-HTTP:  http://ftp.plig.org/
                   10934: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10935: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10936: 230-
                   10937: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10938: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10939: 230-
                   10940: 230-
                   10941: 230 Logged in anonymously.
                   10942: Remote system type is UNIX.
                   10943: Using binary mode to transfer files.
                   10944: 200 Type okay.
                   10945: 250 "/pub" is new cwd.
                   10946: 250-"/pub/figlet" is new cwd.
                   10947: 250-
                   10948: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10949: 250-
1.75      rillig   10950: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10951: 250-
                   10952: 250-The official FIGlet web page is:
1.75      rillig   10953: 250-   http://www.figlet.org/
1.1       grant    10954: 250-
                   10955: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10956: 250-contribute a font or something else, you can email us.
1.68      rillig   10957: 250
1.1       grant    10958: 250 "/pub/figlet/program" is new cwd.
                   10959: 250 "/pub/figlet/program/unix" is new cwd.
                   10960: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10961: 502 Unimplemented command.
                   10962: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10963: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10964: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10965: 226 Transfer completed.
                   10966: 172219 bytes received in 00:02 (75.99 KB/s)
                   10967: 221 Goodbye.
                   10968: =&gt; Checksum OK for figlet221.tar.gz.
                   10969: ===&gt; Extracting for figlet-2.2.1nb2
                   10970: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10971: ===&gt; Patching for figlet-2.2.1nb2
                   10972: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10973: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10974: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10975: ===&gt; Configuring for figlet-2.2.1nb2
                   10976: ===&gt; Building for figlet-2.2.1nb2
                   10977: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10978: chmod a+x figlet
                   10979: gcc -O2 -o chkfont chkfont.c
                   10980: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10981: <code class="prompt">#</code>
1.75      rillig   10982: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10983: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10984: ===&gt; Installing for figlet-2.2.1nb2
                   10985: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10986: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10987: mkdir -p /usr/pkg/share/figlet
                   10988: cp figlet /usr/pkg/bin
                   10989: cp chkfont /usr/pkg/bin
                   10990: chmod 555 figlist showfigfonts
                   10991: cp figlist /usr/pkg/bin
                   10992: cp showfigfonts /usr/pkg/bin
                   10993: cp fonts/*.flf /usr/pkg/share/figlet
                   10994: cp fonts/*.flc /usr/pkg/share/figlet
                   10995: cp figlet.6 /usr/pkg/man/man6
                   10996: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10997: <code class="prompt">#</code></pre>
                   10998: </div>
                   10999: <div class="sect1" lang="en">
                   11000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11001: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   11002: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11003: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11004: ===&gt; Packaging figlet-2.2.1nb2
                   11005: ===&gt; Building binary package for figlet-2.2.1nb2
                   11006: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11007: Using SrcDir value of /usr/pkg
1.68      rillig   11008: Registering depends:.
1.75      rillig   11009: <code class="prompt">#</code></pre>
                   11010: </div>
                   11011: </div>
                   11012: <div class="appendix" lang="en">
                   11013: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   11014: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   11015: <div class="toc">
                   11016: <p><b>Table of Contents</b></p>
                   11017: <dl>
1.122   ! reed     11018: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
        !          11019: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
        !          11020: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
        !          11021: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
        !          11022: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
        !          11023: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
        !          11024: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
        !          11025: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11026: source packages</a></span></dt>
                   11027: </dl>
                   11028: </div>
                   11029: <p>As in other big projects, the directory layout of pkgsrc
                   11030:        is quite complex for newbies. This chapter explains where you
                   11031:        find things on the FTP server. The base directory on
1.110     hubertf  11032:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   11033:        On other servers it may be different, but inside this directory,
                   11034:        everything should look the same, no matter on which server you
                   11035:        are. This directory contains some subdirectories, which are
                   11036:        explained below.</p>
1.76      rillig   11037: <div class="sect1" lang="en">
                   11038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11039: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109     rillig   11040: <p>This directory used to contain binary packages of the
                   11041:        package management tools for various platforms. For those
                   11042:        package collections that need them, they are now stored near the
1.110     hubertf  11043:        binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109     rillig   11044:        directory</a>.</p>
1.76      rillig   11045: </div>
                   11046: <div class="sect1" lang="en">
                   11047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11048: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11049: <p>The directory <code class="filename">distfiles</code> contains lots
                   11050:        of archive files from all pkgsrc packages, which are mirrored
                   11051:        here. The subdirectories are called after their package names
                   11052:        and are used when the distributed files have names that don't
                   11053:        explicitly contain a version number or are otherwise too generic
                   11054:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11055: </div>
                   11056: <div class="sect1" lang="en">
                   11057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11058: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   11059: <p>This directory is currently not in use.</p>
                   11060: </div>
                   11061: <div class="sect1" lang="en">
                   11062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11063: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11064: <p>This directory contains things that individual pkgsrc
                   11065:        developers find worth publishing.</p>
                   11066: </div>
                   11067: <div class="sect1" lang="en">
                   11068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   11069: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11070: <p>This directory contains binary packages for the various
                   11071:        platforms that are supported by pkgsrc.
                   11072:        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>
                   11073: <div class="itemizedlist"><ul type="disc">
1.108     rillig   11074: <li><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11075:        operating system for which the packages have been built. The
1.110     hubertf  11076:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11077:        command, so it may differ from the one you are used to
                   11078:        hear.</p></li>
1.108     rillig   11079: <li><p><code class="varname">ARCH</code> is the hardware
                   11080:        architecture of the platform for which the packages have been
1.110     hubertf  11081:        built. It also includes the <code class="varname">ABI</code> (Application
                   11082:        Binary Interface) for platforms that have several of
                   11083:        them.</p></li>
1.108     rillig   11084: <li><p><code class="varname">OSVERSION</code> is the version of
                   11085:        the operating system. For version numbers that change often (for
                   11086:        example NetBSD-current), the often-changing part should be
                   11087:        replaced with an <code class="literal">x</code>, for example
                   11088:        <code class="literal">4.99.x</code>.</p></li>
                   11089: <li><p><code class="varname">TAG</code> is either
                   11090:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11091:        for a stable branch, or <code class="literal">head</code> for packages
                   11092:        built from the HEAD branch. The latter should only be used when
                   11093:        the packages are updated on a regular basis. Otherwise the date
                   11094:        from checking out pkgsrc should be appended, for example
                   11095:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11096: </ul></div>
                   11097: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11098:        can quickly click through the directories on the
                   11099:        server and find the best binary packages for their machines. Since they
                   11100:        usually know the operating system and the hardware architecture, OPSYS
                   11101:        and ARCH are placed first. After these choices, they can select the
                   11102:        best combination of OSVERSION and TAG together, since it is usually the
                   11103:        case that packages stay compatible between different version of the
                   11104:        operating system.</p>
                   11105: <p>In each of these directories, there is a
                   11106:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11107:        <code class="filename">All</code> which contains all binary packages.
                   11108:        Besides that, there are various category directories that
                   11109:        contain symbolic links to the real binary packages.</p>
                   11110: </div>
                   11111: <div class="sect1" lang="en">
                   11112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   11113: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   11114: <p>Here are the reports from bulk builds, for those who want
                   11115:        to fix packages that didn't build on some of the platforms. The
1.122   ! reed     11116:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   11117: </div>
                   11118: <div class="sect1" lang="en">
                   11119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11120: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93      rillig   11121: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11122: source packages</h2></div></div></div>
                   11123: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   11124:        that is the files that define how to create binary packages from
                   11125:        source archives.</p>
                   11126: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11127:        snapshot of the CVS repository, which is updated regularly. The
                   11128:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11129:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   11130: <p>In the directories for the quarterly branches, there is an
                   11131:        additional file called
                   11132:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   11133:        which contains the state of pkgsrc when it was branched.</p>
                   11134: </div>
1.75      rillig   11135: </div>
                   11136: <div class="appendix" lang="en">
                   11137: <div class="titlepage"><div><div><h2 class="title">
                   11138: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11139: <div class="toc">
                   11140: <p><b>Table of Contents</b></p>
                   11141: <dl>
1.79      rillig   11142: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   11143: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11144: </dl>
                   11145: </div>
1.79      rillig   11146: <p>This section contains information on editing the pkgsrc
                   11147:        guide itself.</p>
1.75      rillig   11148: <div class="sect1" lang="en">
                   11149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11150: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11151: <p>The pkgsrc guide's source code is stored in
                   11152:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11153:        are created from it:</p>
                   11154: <div class="itemizedlist"><ul type="disc">
                   11155: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11156: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110     hubertf  11157: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11158: <li><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.79      rillig   11159:        The PDF version of the pkgsrc guide.</p></li>
1.110     hubertf  11160: <li><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.79      rillig   11161:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11162: </ul></div>
                   11163: </div>
                   11164: <div class="sect1" lang="en">
                   11165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11166: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11167: <p>The procedure to edit the pkgsrc guide is:</p>
                   11168: <div class="procedure"><ol type="1">
                   11169: <li><p>Make sure you have the packages needed to
1.83      wiz      11170:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   11171:        documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
                   11172:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79      rillig   11173:        PostScript and PDF versions. You will need both packages
                   11174:        installed, to make sure documentation is consistent across all
                   11175:        formats.</p></li>
1.110     hubertf  11176: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11177:        right directory. All further steps will take place
                   11178:        here.</p></li>
                   11179: <li><p>Edit the XML file(s) in
                   11180:        <code class="filename">files/</code>.</p></li>
1.110     hubertf  11181: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11182:        guide for valid XML and to build the final output files. If you
                   11183:        get any errors at this stage, you can just edit the files, as
                   11184:        there are only symbolic links in the working directory, pointing
                   11185:        to the files in <code class="filename">files/</code>.</p></li>
1.110     hubertf  11186: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11187:        commit)</strong></span></p></li>
1.110     hubertf  11188: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11189:        regenerate the output files with the proper RCS
                   11190:        Ids.</p></li>
1.91      rillig   11191: <li>
1.110     hubertf  11192: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11193:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11194:        <code class="filename">htdocs</code>.</p>
                   11195: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11196: <h3 class="title">Note</h3>
                   11197: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11198:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11199:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11200:        directory.</p>
                   11201: </div>
                   11202: </li>
1.79      rillig   11203: </ol></div>
1.75      rillig   11204: </div>
                   11205: </div>
                   11206: </div></body>
1.1       grant    11207: </html>

CVSweb <webmaster@jp.NetBSD.org>