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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.2       rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
                     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>
                     21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
                     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
                     27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
                     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.4       rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6       rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.1       dsieger    35: <div><div class="abstract">
                     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>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     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>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                     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>
                     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>
                     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>
                     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>
                    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.9     ! rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   118: <dd><dl>
1.4       rillig    119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
                    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.1       dsieger   122: </dl></dd>
1.4       rillig    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.1       dsieger   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.6       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.1       dsieger   133: <dd><dl>
1.6       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>
                    148: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
                    149: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    150: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    151: </dl></dd>
                    152: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    153: <dd><dl>
                    154: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    155: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    156: </dl></dd>
                    157: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    158: <dd><dl>
                    159: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    160: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    161: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    162: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    163: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    164: <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>
                    165: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
                    166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    168: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
1.1       dsieger   169: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.6       rillig    170: <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>
                    171: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    172: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    173: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    174: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    175: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    176: <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.1       dsieger   177: </dl></dd>
                    178: </dl></dd>
                    179: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    180: <dd><dl>
1.6       rillig    181: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   182: <dd><dl>
1.6       rillig    183: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   184: <dd><dl>
1.6       rillig    185: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    186: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1       dsieger   187: </dl></dd>
1.6       rillig    188: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    189: <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>
                    190: </dl></dd>
                    191: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    192: <dd><dl>
                    193: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    194: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
                    195: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    196: <dd><dl>
                    197: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    198: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    200: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    201: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    202: </dl></dd>
                    203: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    204: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    205: <dd><dl>
                    206: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    207: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    208: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    209: </dl></dd>
                    210: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    211: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
                    212: </dl></dd>
                    213: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                    214: <dd><dl>
                    215: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
                    216: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    217: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    218: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    219: <dd><dl>
                    220: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    221: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    222: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    223: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    224: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    225: </dl></dd>
                    226: </dl></dd>
                    227: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    228: <dd><dl>
                    229: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
                    230: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    231: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                    232: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    233: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
                    234: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    235: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    236: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    237: </dl></dd>
                    238: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    239: <dd><dl>
                    240: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
                    241: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    242: <dd><dl>
                    243: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    244: <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>
                    245: </dl></dd>
                    246: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    247: <dd><dl>
                    248: <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>
                    249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    250: </dl></dd>
                    251: </dl></dd>
                    252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    253: <dd><dl>
                    254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    255: <dd><dl>
                    256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    258: </dl></dd>
                    259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    265: </dl></dd>
                    266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    267: <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>
                    268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    272: <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>
                    273: </dl></dd>
                    274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    275: <dd><dl>
                    276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    277: <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>
                    278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    280: </dl></dd>
                    281: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    282: <dd><dl>
                    283: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    290: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    291: </dl></dd>
                    292: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    295: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    296: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    298: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    299: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    304: </dl></dd>
                    305: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    306: <dd><dl>
                    307: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    308: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    309: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    310: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    311: </dl></dd>
                    312: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    315: <dd><dl>
                    316: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
                    317: <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>
                    318: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    319: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    320: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    321: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    322: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    323: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    324: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    325: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    326: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    327: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    328: </dl></dd>
                    329: <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>
                    330: <dd><dl>
                    331: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    332: <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>
                    333: </dl></dd>
                    334: <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>
                    335: <dd><dl>
                    336: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    337: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    338: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    339: </dl></dd>
                    340: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    341: <dd><dl>
                    342: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    343: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    344: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                    345: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    346: </dl></dd>
                    347: <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>
                    348: <dd><dl>
                    349: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    350: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
                    351: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                    352: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    353: </dl></dd>
                    354: <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>
                    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    357: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    358: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    359: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    360: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    361: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    362: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    364: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig    365: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    367: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    368: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    369: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    370: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    371: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    372: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    373: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   374:     emulation</a></span></dt>
1.6       rillig    375: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    376: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   377: </dl></dd>
1.6       rillig    378: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   379: </dl></dd>
1.6       rillig    380: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    381: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   382: <dd><dl>
1.6       rillig    383: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    384: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    385: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    386: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    387: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                    388: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                    389: </dl></dd>
                    390: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    391: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    392: <dd><dl>
                    393: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    394: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    395: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    396: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   397: </dl></dd>
                    398: </dl></dd>
                    399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    400: <dd><dl>
1.6       rillig    401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   402: <dd><dl>
1.6       rillig    403: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    404: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    405: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   406: <dd><dl>
1.6       rillig    407: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    408: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   409: </dl></dd>
1.6       rillig    410: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    411: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   412: <dd><dl>
1.6       rillig    413: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    414: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   415: </dl></dd>
1.6       rillig    416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   417: <dd><dl>
1.6       rillig    418: <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>
                    419: <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.1       dsieger   420: </dl></dd>
                    421: </dl></dd>
1.6       rillig    422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   423: <dd><dl>
1.6       rillig    424: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    425: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    426: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   427: <dd><dl>
1.6       rillig    428: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    429: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   430: </dl></dd>
                    431: </dl></dd>
1.6       rillig    432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   433: <dd><dl>
1.6       rillig    434: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    435: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   436: </dl></dd>
                    437: </dl></dd>
                    438: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    439: <dd><dl>
                    440: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    441: <dd><dl>
                    442: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    443: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    444: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                    445: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                    446: </dl></dd>
                    447: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    448: </dl></dd>
                    449: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    450: <dd><dl>
                    451: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    452: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    453: </dl></dd>
                    454: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    455: <dd><dl>
                    456: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                    457: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    458: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                    459: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3       rillig    460: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.8       rillig    461: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    462: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.1       dsieger   463: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                    464: source packages</a></span></dt>
                    465: </dl></dd>
                    466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    467: <dd><dl>
                    468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    470: </dl></dd>
                    471: </dl>
                    472: </div>
                    473: <div class="list-of-tables">
                    474: <p><b>List of Tables</b></p>
                    475: <dl>
                    476: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    477: </dt>
1.6       rillig    478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   479: </dt>
1.6       rillig    480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   481: </dt>
                    482: </dl>
                    483: </div>
                    484: <div class="chapter" lang="en">
                    485: <div class="titlepage"><div><div><h2 class="title">
                    486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    487: <div class="toc">
                    488: <p><b>Table of Contents</b></p>
                    489: <dl>
                    490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    491: <dd><dl>
                    492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    494: </dl></dd>
                    495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    497: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    499: </dl>
                    500: </div>
                    501: <div class="sect1" lang="en">
                    502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    504: <p>There is a lot of software freely available for Unix-based
                    505: systems, which is usually available in form of the source code. Before
                    506: such software can be used, it needs to be configured to the local
                    507: system, compiled and installed, and this is exactly what The NetBSD
                    508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    509: to handle binary packages, so that not every user has to build the
                    510: packages for himself, which is a time-costly task.</p>
                    511: <p>pkgsrc currently contains several thousand packages,
                    512:       including:</p>
                    513: <div class="itemizedlist"><ul type="disc">
                    514: <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
                    515:          web server</p></li>
                    516: <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
                    517:          web browser</p></li>
                    518: <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
                    519:          Desktop Environment</p></li>
                    520: <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
                    521:          Desktop Environment</p></li>
                    522: </ul></div>
                    523: <p>...just to name a few.</p>
                    524: <p>pkgsrc has built-in support for handling varying dependencies,
                    525:       such as pthreads and X11, and extended features such as IPv6 support on
                    526:       a range of platforms.</p>
                    527: <div class="sect2" lang="en">
                    528: <div class="titlepage"><div><div><h3 class="title">
                    529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    530: <p>
                    531: pkgsrc provides the following key features:
                    532: </p>
                    533: <div class="itemizedlist"><ul type="disc">
                    534: <li><p>Easy building of software from source as well as the creation
                    535:   and installation of binary packages. The source and latest
                    536:   patches are retrieved from a master or mirror download site, checksum
                    537:   verified, then built on your system. Support for binary-only
                    538:   distributions is available for both native platforms and NetBSD
                    539:   emulated platforms.</p></li>
                    540: <li><p>All packages are installed in a consistent directory tree,
                    541:   including binaries, libraries, man pages and other
                    542:   documentation.</p></li>
                    543: <li><p>Package dependencies, including when performing package updates,
                    544:   are handled automatically. The configuration files of various
                    545:   packages are handled automatically during updates, so local changes
                    546:   are preserved.</p></li>
                    547: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    548:   consists of highly portable code. This allows the greatest speed of
                    549:   development when porting to new a platform. This portability also
                    550:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    551:   platforms</em></span>.</p></li>
                    552: <li><p>The installation prefix, acceptable software licenses,
                    553:   international encryption requirements and build-time options for a
                    554:   large number of packages are all set in a simple, central
                    555:   configuration file.</p></li>
                    556: <li><p>The entire source (not including the distribution files) is
                    557:   freely available under a BSD license, so you may extend and adapt
                    558:   pkgsrc to your needs. Support for local packages and patches is
                    559:   available right out of the box, so you can configure it specifically
                    560:   for your environment.</p></li>
                    561: </ul></div>
                    562: <p>The following principles are basic to pkgsrc:</p>
                    563: <div class="itemizedlist"><ul type="disc">
                    564: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.6       rillig    565: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   566: them and to complain about them rather than to just install the package
                    567: and hope that it works. There are numerous checks in pkgsrc that try to
                    568: 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
                    569: of shell scripts), and post-installation checks (installed files,
                    570: references to shared libraries, script interpreters).</p></li>
                    571: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.6       rillig    572: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   573: pkgsrc has been ported to many operating systems. Care is taken that
                    574: packages behave the same on all platforms.</p></li>
                    575: </ul></div>
                    576: </div>
                    577: <div class="sect2" lang="en">
                    578: <div class="titlepage"><div><div><h3 class="title">
                    579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    580: <p>pkgsrc consists of both a source distribution and a binary
                    581: distribution for these operating systems. After retrieving the required
                    582: source or binaries, you can be up and running with pkgsrc in just
                    583: minutes!</p>
                    584: <p>pkgsrc was derived from FreeBSD's ports system, and
                    585:       initially developed for NetBSD only. Since then, pkgsrc has
                    586:       grown a lot, and now supports the following platforms:</p>
                    587: <div class="table">
                    588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    590: <colgroup>
                    591: <col>
                    592: <col>
                    593: </colgroup>
                    594: <thead><tr>
                    595: <th>Platform</th>
                    596: <th>Date Support Added</th>
                    597: </tr></thead>
                    598: <tbody>
                    599: <tr>
                    600: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
                    601: <td align="center">Aug 1997</td>
                    602: </tr>
                    603: <tr>
                    604: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
                    605: <td align="center">Mar 1999</td>
                    606: </tr>
                    607: <tr>
                    608: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
                    609: <td align="center">Jun 1999</td>
                    610: </tr>
                    611: <tr>
                    612: <td>
                    613:           <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    614:           (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
                    615:         </td>
                    616: <td align="center">Oct 2001</td>
                    617: </tr>
                    618: <tr>
                    619: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
                    620: <td align="center">Nov 2002</td>
                    621: </tr>
                    622: <tr>
                    623: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
                    624: <td align="center">Nov 2002</td>
                    625: </tr>
                    626: <tr>
                    627: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
                    628: <td align="center">Dec 2002</td>
                    629: </tr>
                    630: <tr>
                    631: <td>BSD/OS</td>
                    632: <td align="center">Dec 2003</td>
                    633: </tr>
                    634: <tr>
                    635: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
                    636: <td align="center">Dec 2003</td>
                    637: </tr>
                    638: <tr>
                    639: <td>
                    640:           <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
                    641:           (Microsoft Windows Services for Unix)
                    642:         </td>
                    643: <td align="center">Mar 2004</td>
                    644: </tr>
                    645: <tr>
                    646: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
                    647: <td align="center">Oct 2004</td>
                    648: </tr>
                    649: <tr>
                    650: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
                    651: <td align="center">Nov 2004</td>
                    652: </tr>
                    653: <tr>
                    654: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
                    655: <td align="center">Apr 2007</td>
                    656: </tr>
                    657: </tbody>
                    658: </table></div>
                    659: </div>
                    660: <br class="table-break">
                    661: </div>
                    662: </div>
                    663: <div class="sect1" lang="en">
                    664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    665: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    666: <p>This document is divided into three parts. The first,
                    667:        <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
                    668:        describes how one can use one of the packages in the Package
                    669:        Collection, either by installing a precompiled binary package,
                    670:        or by building one's own copy using the NetBSD package system.
                    671:        The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
                    672:        package so it can be easily built by other NetBSD users without
                    673:        knowing about the package's building details. The third part,
                    674:        <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
                    675:        is intended for those who want to understand how pkgsrc is
                    676:        implemented.</p>
                    677: <p>This document is available in various formats:
                    678:        <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
                    679: </div>
                    680: <div class="sect1" lang="en">
                    681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    682: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    683: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    684:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    685:       terminology used within this document.</p>
                    686: <div class="variablelist"><dl>
                    687: <dt><span class="term">Package</span></dt>
                    688: <dd><p>A set of files and building instructions
                    689:            that describe what's necessary
                    690:            to build a certain piece of software using
                    691:             pkgsrc. Packages are traditionally stored under
                    692:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    693: <dt><span class="term">The NetBSD package system</span></dt>
                    694: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    695:          is part of the NetBSD operating system and can be bootstrapped
                    696:          to run on non-NetBSD operating systems as well.  It handles
                    697:          building (compiling), installing, and removing of
                    698:          packages.</p></dd>
                    699: <dt><span class="term">Distfile</span></dt>
                    700: <dd><p>This term describes the file or files that are
                    701:            provided by the author of the piece of software to
                    702:            distribute his work. All the changes necessary to build on
                    703:            NetBSD are reflected in the corresponding package. Usually
                    704:            the distfile is in the form of a compressed tar-archive,
                    705:            but other types are possible, too. Distfiles are usually
                    706:            stored below
                    707:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    708: <dt><span class="term">Port</span></dt>
                    709: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    710:            for what we call a package.
                    711:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    712:            architecture.</p></dd>
                    713: <dt><span class="term">Precompiled/binary package</span></dt>
                    714: <dd>
                    715: <p>A set of binaries built with pkgsrc from a distfile
                    716:            and stuffed together in a single <code class="filename">.tgz</code>
                    717:            file so it can be installed on machines of the same
                    718:            machine architecture without the need to
                    719:            recompile. Packages are usually generated in
                    720:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
                    721:            an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
                    722: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    723:            especially in the context of precompiled packages.</p>
                    724: </dd>
                    725: <dt><span class="term">Program</span></dt>
                    726: <dd><p>The piece of software to be installed which will be
                    727:          constructed from all the files in the distfile by the
                    728:          actions defined in the corresponding package.</p></dd>
                    729: </dl></div>
                    730: <div class="sect2" lang="en">
                    731: <div class="titlepage"><div><div><h3 class="title">
                    732: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
                    733: <div class="variablelist"><dl>
                    734: <dt><span class="term">pkgsrc users</span></dt>
                    735: <dd>
                    736: <p>The
                    737:        pkgsrc users are people who use the packages provided by pkgsrc.
                    738:        Typically they are system administrators. The people using the
                    739:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    740:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    741: <p>There are two kinds of pkgsrc users: Some only want to
                    742:        install pre-built binary packages. Others build the pkgsrc
                    743:        packages from source, either for installing them directly or for
                    744:        building binary packages themselves. For pkgsrc users <a 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
                    745:        documentation.</p>
                    746: </dd>
                    747: <dt><span class="term">package maintainers</span></dt>
                    748: <dd><p>A
                    749:        package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
                    750: <dt><span class="term">infrastructure developers</span></dt>
                    751: <dd><p>These people are involved in all those files
                    752:        that live in the <code class="filename">mk/</code> directory and below.
                    753:        Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
                    754:        too.</p></dd>
                    755: </dl></div>
                    756: </div>
                    757: </div>
                    758: <div class="sect1" lang="en">
                    759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    760: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    761: <p>When giving examples for commands, shell prompts are used to
                    762:       show if the command should/can be issued as root, or if
                    763:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    764:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    765:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    766: </div>
                    767: </div>
                    768: <div class="part" lang="en">
                    769: <div class="titlepage"><div><div><h1 class="title">
                    770: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    771: <div class="toc">
                    772: <p><b>Table of Contents</b></p>
                    773: <dl>
                    774: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    775: <dd><dl>
                    776: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    777: <dd><dl>
                    778: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    779: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    780: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                    781: </dl></dd>
                    782: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    783: <dd><dl>
                    784: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    785: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    786: </dl></dd>
                    787: </dl></dd>
                    788: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    789: <dd><dl>
                    790: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    791: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    792: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    793: <dd><dl>
                    794: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    795: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    796: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    797: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    798: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    799: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    800: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                    801: </dl></dd>
                    802: </dl></dd>
                    803: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    804: <dd><dl>
                    805: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    806: <dd><dl>
                    807: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    808: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    809: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    810: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    811: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    812: <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>
                    813: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    814: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    815: </dl></dd>
                    816: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    817: <dd><dl>
                    818: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    819: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    820: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    821: </dl></dd>
                    822: </dl></dd>
                    823: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    824: <dd><dl>
                    825: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    826: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9     ! rillig    827: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    828: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   829: <dd><dl>
1.4       rillig    830: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
                    831: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    832: <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.1       dsieger   833: </dl></dd>
1.4       rillig    834: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    835: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   836: </dl></dd>
                    837: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    838: <dd><dl>
                    839: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    840: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    841: </dl></dd>
                    842: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    843: builds)</a></span></dt>
1.1       dsieger   844: <dd><dl>
1.6       rillig    845: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    846: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    847: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    848: <dd><dl>
                    849: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    850: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    851: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    852: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    853: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    854: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    855: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    856: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    857: </dl></dd>
                    858: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
                    859: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
                    860: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    861: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    862: </dl></dd>
                    863: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    864: <dd><dl>
                    865: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    866: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    867: </dl></dd>
                    868: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    869: <dd><dl>
                    870: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    871: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    872: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    873: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    874: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    875: <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>
                    876: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
                    877: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                    878: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    879: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
1.1       dsieger   880: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.6       rillig    881: <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>
                    882: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    883: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    884: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    885: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    886: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    887: <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.1       dsieger   888: </dl></dd>
                    889: </dl>
                    890: </div>
                    891: <div class="chapter" lang="en">
                    892: <div class="titlepage"><div><div><h2 class="title">
                    893: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    894: <div class="toc">
                    895: <p><b>Table of Contents</b></p>
                    896: <dl>
                    897: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    898: <dd><dl>
                    899: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    900: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    901: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                    902: </dl></dd>
                    903: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    904: <dd><dl>
                    905: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    906: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    907: </dl></dd>
                    908: </dl>
                    909: </div>
                    910: <p>Before you download and extract the files, you need to decide
                    911: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    912: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    913: free to install the sources and binary packages wherever you want in
                    914: your filesystem, provided that the pathname does not contain white-space
                    915: or other characters that are interpreted specially by the shell and some
                    916: other programs. A safe bet is to use only letters, digits, underscores
                    917: and dashes.</p>
                    918: <div class="sect1" lang="en">
                    919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    920: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    921: <p>Before you download any pkgsrc files, you should decide
                    922:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    923:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    924:        quarterly basis from the current branch and only gets modified
                    925:        for security updates. The names of the stable branches are built
                    926:        from the year and the quarter, for example
                    927:        <code class="literal">2007Q1</code>.</p>
                    928: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    929:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    930:        or via CVS. All three ways are described here.</p>
                    931: <div class="sect2" lang="en">
                    932: <div class="titlepage"><div><div><h3 class="title">
                    933: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    934: <p>The primary download location for all pkgsrc files is
                    935:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
                    936:        number of subdirectories for different purposes, which are
                    937:        described in detail in <a 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>
                    938: <p>The tar file for the current branch is in the directory
                    939:        <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
                    940:        It is autogenerated daily.</p>
                    941: <p>The tar file for the stable branch 2007Q1 is in the
                    942:        directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
                    943: <p>After downloading the tar file, change to the directory
                    944:        where you want to have pkgsrc. This is usually
                    945:        <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
                    946:        pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
                    947: </div>
                    948: <div class="sect2" lang="en">
                    949: <div class="titlepage"><div><div><h3 class="title">
                    950: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    951: <p>As an alternative to the tar file, you can get pkgsrc via
                    952:        the Software Update Protocol, SUP. To do so, make sure your
                    953:        supfile has a line
                    954: 
                    955: </p>
                    956: <pre class="programlisting">
                    957: release=pkgsrc
                    958: </pre>
                    959: <p>
                    960: 
                    961:        in it, see the examples in
                    962:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    963:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
                    964:        run <span><strong class="command">sup -v
                    965:        <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
                    966: </div>
                    967: <div class="sect2" lang="en">
                    968: <div class="titlepage"><div><div><h3 class="title">
                    969: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
                    970: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
                    971:        installed. To do an initial (full) checkout of pkgsrc, you first
                    972:        have to set some environment variables. For the C-Shell,
                    973:        type:</p>
                    974: <pre class="screen">
                    975:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    976:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
                    977: </pre>
                    978: <p>Or, the same for the bourne shell:</p>
                    979: <pre class="screen">
                    980:     <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    981:     <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
                    982:     <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
                    983: </pre>
1.2       rillig    984: <p>By default, cvs doesn't do things like most people would
                    985:        expect it to do, and this is unlikely to change. But there is a
                    986:        way to convince cvs, by creating a file called
                    987:        <code class="filename">.cvsrc</code> in your home directory and saving
                    988:        the following lines to it. This file will save you lots of
                    989:        headache and some bug reports, so we strongly recommend it. You
                    990:        can find an explanation of this file in the CVS
                    991:        documentation.</p>
                    992: <pre class="programlisting">
                    993: # recommended CVS configuration file from the pkgsrc guide
                    994: checkout -P
1.4       rillig    995: update -dP
1.2       rillig    996: release -d
1.4       rillig    997: diff -upN
1.2       rillig    998: cvs -q -z3
                    999: rdiff -u
                   1000: </pre>
1.1       dsieger  1001: <p>Then, you change to the directory where you want to have
                   1002:        your copy of pkgsrc. In most cases this is
                   1003:        <code class="filename">/usr</code>. In that directory you run the
                   1004:        checkout command, which is <span><strong class="command">cvs -q checkout -P
                   1005:        pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
                   1006:        checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
                   1007:        branch. This command will create a directory called
                   1008:        <code class="filename">pkgsrc</code> with all the pkgsrc files in
                   1009:        it.</p>
                   1010: </div>
                   1011: </div>
                   1012: <div class="sect1" lang="en">
                   1013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1014: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1015: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1016:        (which also works if you have first installed it via a tar
                   1017:        file). It saves bandwidth and hard disk activity, compared to
                   1018:        downloading the tar file again.</p>
                   1019: <div class="sect2" lang="en">
                   1020: <div class="titlepage"><div><div><h3 class="title">
                   1021: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1022: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1023: <h3 class="title">Warning</h3>
                   1024: <p>When updating from a tar file, you first need to
                   1025:        completely remove the old pkgsrc directory. Otherwise those
                   1026:        files that have been removed from pkgsrc in the mean time will
                   1027:        not be removed on your local disk, resulting in inconsistencies.
                   1028:        When removing the old files, any changes that you have done to
                   1029:        the pkgsrc files will be lost after updating. Therefore updating
                   1030:        via CVS is strongly recommended.</p>
                   1031: </div>
                   1032: <p>Note that by default the distfiles and the binary packages
                   1033:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1034:        before updating. You can also configure pkgsrc to use other than
                   1035:        the default directories by setting the
                   1036:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
                   1037:        variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
                   1038: <p>To update pkgsrc from a tar file, download the tar file as
                   1039:        explained above. Then, make sure that you have not made any
                   1040:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1041:        directory and extract the new tar file. Done.</p>
                   1042: </div>
                   1043: <div class="sect2" lang="en">
                   1044: <div class="titlepage"><div><div><h3 class="title">
                   1045: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1046: <p>To update pkgsrc via CVS, make sure the environment
                   1047:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
                   1048:        change to the pkgsrc directory and run <span><strong class="command">cvs -q update
                   1049:        -dP</strong></span>.</p>
                   1050: <div class="sect3" lang="en">
                   1051: <div class="titlepage"><div><div><h4 class="title">
                   1052: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1053: <p>When updating pkgsrc, the CVS program keeps track of the
                   1054:        branch you selected. But if you, for whatever reason, want to
                   1055:        switch from the stable branch to the current one, you can do it
                   1056:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1057:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1058:        back to the stable branch, add the
                   1059:        &#8220;<span class="quote">-rpkgsrc-2007Q1</span>&#8221; option.</p>
                   1060: </div>
                   1061: <div class="sect3" lang="en">
                   1062: <div class="titlepage"><div><div><h4 class="title">
                   1063: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1064: <p>When you update pkgsrc, the CVS program will only touch
                   1065:        those files that are registered in the CVS repository. That
                   1066:        means that any packages that you created on your own will stay
                   1067:        unmodified. If you change files that are managed by CVS, later
                   1068:        updates will try to merge your changes with those that have been
                   1069:        done by others. See the CVS manual, chapter
                   1070:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1071: </div>
                   1072: </div>
                   1073: </div>
                   1074: </div>
                   1075: <div class="chapter" lang="en">
                   1076: <div class="titlepage"><div><div><h2 class="title">
                   1077: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1078: <div class="toc">
                   1079: <p><b>Table of Contents</b></p>
                   1080: <dl>
                   1081: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1082: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1083: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1084: <dd><dl>
                   1085: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1086: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1087: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1088: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1089: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1090: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1091: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                   1092: </dl></dd>
                   1093: </dl>
                   1094: </div>
                   1095: <div class="sect1" lang="en">
                   1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1097: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.9     ! rillig   1098: <p>See <a href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1099: </div>
                   1100: <div class="sect1" lang="en">
                   1101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1102: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1104: <pre class="screen">
                   1105: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1108:     </pre>
                   1109: <p>See <a 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
                   1110:     pkgsrc before bootstrapping. The given
                   1111:     <span><strong class="command">bootstrap</strong></span> command will use the defaults of
                   1112:     <code class="filename">/usr/pkg</code> for the
                   1113:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1114:     and <code class="filename">/var/db/pkg</code> for the package database
                   1115:     directory where pkgsrc will do its internal bookkeeping.
                   1116:     However, these can also be set using command-line
                   1117:     arguments.</p>
                   1118: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1119: <h3 class="title">Note</h3>
                   1120: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
                   1121:       Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
                   1122:       For examples in this guide, use <span><strong class="command">bmake</strong></span>
                   1123:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
                   1124: </div>
                   1125: </div>
                   1126: <div class="sect1" lang="en">
                   1127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1128: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1129: <p>Here are some platform-specific notes you should be aware of.</p>
                   1130: <div class="sect2" lang="en">
                   1131: <div class="titlepage"><div><div><h3 class="title">
                   1132: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
                   1133: <p>Darwin 5.x and up are supported. There are two methods of using
                   1134:        pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1135:          image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
                   1136:          partition</a>.</p>
                   1137: <p>Before you start, you will need to download and install the Mac OS X Developer
                   1138:       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1139:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
                   1140:       from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
                   1141:       if you intend to build packages that use the X11 Window System.</p>
                   1142: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1143:       that you can format as UFS or HFSX, it is recommended to use that instead of
                   1144:       the disk image. It'll be somewhat faster and will mount automatically
                   1145:       at boot time, where you must manually mount a disk image.</p>
                   1146: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1147: <h3 class="title">Note</h3>
                   1148: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
                   1149:          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>
                   1150: </div>
                   1151: <div class="sect3" lang="en">
                   1152: <div class="titlepage"><div><div><h4 class="title">
                   1153: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
                   1154: <p>Create the disk image:</p>
                   1155: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1156: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
                   1157: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
                   1158: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
                   1159: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1160: <h3 class="title">Note</h3>
1.9     ! rillig   1161: <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.1       dsieger  1162: </div>
                   1163: <p>Allow suid:</p>
                   1164: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5       weinem   1165: <p>Changing the build directory:</p>
                   1166: <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>
                   1167: <pre class="programlisting">
                   1168:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1169:        </pre>
1.1       dsieger  1170: </div>
                   1171: <div class="sect3" lang="en">
                   1172: <div class="titlepage"><div><div><h4 class="title">
                   1173: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
                   1174: <p>By default, <code class="filename">/usr</code> will be on your root file
                   1175:        system, normally HFS+. It is possible to use the default
                   1176:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1177:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
                   1178:        or HFSX file system. Obviously, another symlink is required if you want to
                   1179:        place the package database directory outside the
                   1180:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
                   1181: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1182: <p>If you created your partitions at the time of installing Mac OS X
                   1183:        and formatted the target partition as UFS or HFSX, it should automatically
                   1184:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
                   1185:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
                   1186:        to ensure that the partition map correctly reflects
                   1187:        &#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>
                   1188: <p>The problem is that none of the disk tools will let you touch a
                   1189:        disk that is booted from. You can unmount the partition, but even if
                   1190:        you newfs it, the partition type will be incorrect and the
                   1191:        automounter won't mount it. It can be mounted manually, but it won't
                   1192:        appear in Finder.</p>
                   1193: <p>You'll need to boot off of the OS X Installation (User) CD.  When
                   1194:        the Installation program starts, go up to the menu and select Disk
                   1195:        Utility.  Now, you will be able to select the partition you want
                   1196:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1197:        installer which will reboot your machine. The new UFS or HFSX file system
                   1198:        will appear in Finder.</p>
                   1199: <p>Be aware that the permissions on the new file system will be writable
                   1200:        by root only.</p>
                   1201: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
                   1202:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
                   1203: </div>
                   1204: </div>
                   1205: <div class="sect2" lang="en">
                   1206: <div class="titlepage"><div><div><h3 class="title">
                   1207: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
                   1208: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1209:       other versions may work.</p>
                   1210: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1211:       with the FreeBSD userland tools. There are several steps:</p>
                   1212: <div class="orderedlist"><ol type="1">
                   1213: <li><p>FreeBSD stores its ports pkg database in
                   1214:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1215:          recommended that you choose a different location (e.g.
                   1216:          <code class="filename">/usr/pkgdb</code>) by
                   1217:          using the --pkgdbdir option to the bootstrap script.</p></li>
                   1218: <li>
                   1219: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1220:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1221: <pre class="screen">
                   1222: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1223: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1224: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1225: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1226: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1227:          </pre>
                   1228: </li>
1.4       rillig   1229: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1230:          <code class="filename">/etc/mk.conf.example</code> file
                   1231:          when you use the bootstrap script.</p></li>
                   1232: </ol></div>
                   1233: </div>
                   1234: <div class="sect2" lang="en">
                   1235: <div class="titlepage"><div><div><h3 class="title">
                   1236: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
                   1237: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1238:       providing a Unix-like environment with a tighter kernel integration than
                   1239:       available with Cygwin.  It is part of the Windows Services for Unix
                   1240:       package, available for free for any licensed copy of Windows 2000, XP
                   1241:       (not including XP Home), or 2003.  SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
                   1242: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1243:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1244:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1245: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1246:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
                   1247:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
                   1248: <div class="sect3" lang="en">
                   1249: <div class="titlepage"><div><div><h4 class="title">
                   1250: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
                   1251: <p>At an absolute minimum, the following packages must be installed from
                   1252:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
                   1253: <div class="itemizedlist"><ul type="disc">
                   1254: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1255: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1256: <li><p>Remote Connectivity</p></li>
                   1257: <li><p>Interix SDK</p></li>
                   1258: </ul></div>
                   1259: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1260:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1261:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1262:        pkgsrc (or from a binary package).</p>
                   1263: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1264:        not need to be installed, but Remote Connectivity itself should be
                   1265:        installed in order to have a working inetd.</p>
                   1266: <p>During installation you may be asked whether to enable setuid
                   1267:        behavior for Interix programs, and whether to make pathnames default to
                   1268:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1269:        enabled.  (Without case-sensitivity, a large number of packages including
                   1270:        perl will not build.)</p>
                   1271: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1272:        works (via the Data Execution Prevention feature).  In order to use
                   1273:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1274:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1275:        must be installed.  Hotfixes are available from Microsoft through a
                   1276:        support contract; however, a NetBSD developer has made most Interix
                   1277:        hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
                   1278: <p>In addition to the hotfix noted above, it may be necessary to
                   1279:        disable Data Execution Prevention entirely to make Interix functional.
                   1280:        This may happen only with certain types of CPUs; the cause is not fully
                   1281:        understood at this time.  If gcc or other applications still segfault
                   1282:        repeatedly after installing one of the hotfixes note above, the
                   1283:        following option can be added to the appropriate "boot.ini" line on the
                   1284:        Windows boot drive:  /NoExecute=AlwaysOff
                   1285:        (WARNING, this will disable DEP completely, which may be a security
                   1286:        risk if applications are often run as a user in the Administrators
                   1287:        group!)</p>
                   1288: </div>
                   1289: <div class="sect3" lang="en">
                   1290: <div class="titlepage"><div><div><h4 class="title">
                   1291: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
                   1292: <p>If SFU is already installed and you wish to alter these settings to work
                   1293:        with pkgsrc, note the following things.</p>
                   1294: <div class="itemizedlist"><ul type="disc">
                   1295: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
                   1296:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1297:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
                   1298: <li>
                   1299: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1300:            change the following registry key:</p>
                   1301: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1302: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1303: </li>
                   1304: <li>
                   1305: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1306:            following registry key:</p>
                   1307: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1308: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1309: </li>
                   1310: </ul></div>
                   1311: </div>
                   1312: <div class="sect3" lang="en">
                   1313: <div class="titlepage"><div><div><h4 class="title">
                   1314: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
                   1315: <p>The package manager (either the pkgsrc "su" user, or the user
                   1316:        running "pkg_add") must be a member of the local Administrators
                   1317:        group.  Such a user must also be used to run the bootstrap.  This is
                   1318:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1319: <p>The package manager should use a umask of 002.  "make install" will
                   1320:        automatically complain if this is not the case.  This ensures that
                   1321:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1322: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1323:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1324:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1325:        the same time as the pkgsrc packages, ensure that you use the proper
                   1326:        pkg_* tools for each type of binary package.</p>
                   1327: <p>The TERM setting used for DOS-type console windows (including those
                   1328:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1329:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1330:        entry provides adequate emulation in most cases:</p>
                   1331: <pre class="programlisting">
                   1332: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1333:        </pre>
                   1334: </div>
                   1335: <div class="sect3" lang="en">
                   1336: <div class="titlepage"><div><div><h4 class="title">
                   1337: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
                   1338: <p>Though Interix suffices as a familiar and flexible substitute
                   1339:        for a full Unix-like platform, it has some drawbacks that should
                   1340:        be noted for those desiring to make the most of Interix.</p>
                   1341: <div class="itemizedlist"><ul type="disc">
                   1342: <li>
                   1343: <p><span class="strong"><strong>X11:</strong></span></p>
                   1344: <p>Interix comes with the standard set of X11R6 client libraries,
                   1345:          and can run X11 based applications, but it does
                   1346:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
                   1347:          <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1348:          <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
                   1349:          (available in a trimmed version for Interix from Interop Systems as the
                   1350:          <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
                   1351:          and the free X11 server included with
                   1352:          <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
                   1353: </li>
                   1354: <li>
                   1355: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1356: <p>Because Interix runs in a completely different NT subsystem from
                   1357:          Win32 applications, it does not currently support various X11
                   1358:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1359:          Most interactive applications to a local X server will run
                   1360:          reasonably fast, but full motion video and other graphics
                   1361:          intensive applications may require a faster-than-expected CPU.</p>
                   1362: </li>
                   1363: <li>
                   1364: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1365: <p>Interix has no native support for audio output.  For audio
                   1366:          support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
                   1367:          audio system on Interix.  Unlike on most platforms, the
                   1368:          <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
                   1369:          <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
                   1370:          server component.  To output audio via an Interix host, the
                   1371:          <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
                   1372:          must also be installed.</p>
                   1373: </li>
                   1374: <li>
                   1375: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1376: <p>Direct device access is not currently supported in Interix, so it
                   1377:          is not currently possible to access CD/DVD drives, USB devices,
                   1378:          or SCSI devices through non-filesystem means.  Among other things,
                   1379:          this makes it impossible to use Interix directly for CD/DVD
                   1380:          burning.</p>
                   1381: </li>
                   1382: <li>
                   1383: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1384: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1385:          drives are also not directly accessible in Interix.  However,
                   1386:          support is in work to make tape drive access possible by using
                   1387:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1388:          esound server).</p>
                   1389: </li>
                   1390: </ul></div>
                   1391: </div>
                   1392: <div class="sect3" lang="en">
                   1393: <div class="titlepage"><div><div><h4 class="title">
                   1394: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
                   1395: <p>It is not necessary, in general, to have a "root" user on the
                   1396:        Windows system; any member of the local Administrators group will
                   1397:        suffice.  However, some packages currently assume that the user
                   1398:        named "root" is the privileged user.  To accommodate these, you
                   1399:        may create such a user; make sure it is in the local group
                   1400:        Administrators (or your language equivalent).</p>
                   1401: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
                   1402:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1403:        time being, install packages as the local Administrator (or
                   1404:        your language equivalent), or run the following command after
                   1405:        installing a package to work around the issue:</p>
                   1406: <pre class="screen">
                   1407: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1408:        </pre>
                   1409: </div>
                   1410: </div>
                   1411: <div class="sect2" lang="en">
                   1412: <div class="titlepage"><div><div><h3 class="title">
                   1413: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
                   1414: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1415:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1416:       according to your preference.  If you do not have a license for the MIPSpro
                   1417:       compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
                   1418: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
                   1419:       version of IRIX providing support for <a 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 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>,
                   1420:       etc.</p>
                   1421: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1422:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1423:        you start out using "abi=n32", that's what all your packages will be built
                   1424:        with.</p>
                   1425: <p>Therefore, please make sure that you have no conflicting
                   1426:       <code class="varname">CFLAGS</code> in your environment or the
1.4       rillig   1427:       <a href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1428:       try to link n32 object files with lib64 or vice versa.  Check your
                   1429:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1430: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1431:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1432:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1433:       link over a network-mounted file system.</p>
                   1434: <p>The bootstrapping process should set all the right options for programs such
                   1435:       as imake(1), but you may want to set some options depending on your local
                   1436:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1437:       course, your compiler's man pages for details.</p>
                   1438: <p>If you are using SGI's MIPSPro compiler, please set
                   1439: 
                   1440:       </p>
                   1441: <pre class="programlisting">
                   1442: PKGSRC_COMPILER=        mipspro
                   1443:       </pre>
                   1444: <p>
                   1445: 
1.4       rillig   1446:       in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1447:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1448:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1449:       default.</p>
                   1450: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1451:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1452:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1453:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1454:       '--preserve-path' flag.</p>
                   1455: </div>
                   1456: <div class="sect2" lang="en">
                   1457: <div class="titlepage"><div><div><h3 class="title">
                   1458: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
                   1459: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1460:       either libtermcap or libcurses (libncurses).  Installing the
                   1461:       distributions libncurses-dev package (or equivalent) should fix
                   1462:       the problem.</p>
                   1463: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1464:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1465:       i386 have been tested.</p>
                   1466: <p>To bootstrap using icc, assuming the default icc installation
                   1467:       directory:</p>
                   1468: <pre class="programlisting">
                   1469: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1470: ac_cv___attribute__=yes ./bootstrap
                   1471:       </pre>
                   1472: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1473: <h3 class="title">Note</h3>
                   1474: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1475: </div>
                   1476: <p>icc supports __attribute__, but the GNU configure test uses a nested
                   1477:       function, which icc does not support. #undef'ing __attribute__ has the
                   1478:       unfortunate side-effect of breaking many of the Linux header files, which
                   1479:       cannot be compiled properly without __attribute__. The test must be
                   1480:       overridden so that __attribute__ is assumed supported by the
                   1481:       compiler.</p>
                   1482: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.4       rillig   1483:       in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1484: <pre class="programlisting">
                   1485: PKGSRC_COMPILER=        icc
                   1486:       </pre>
                   1487: <p>The default installation directory for icc is
                   1488:       <code class="filename">/opt/intel_cc_80</code>, which
                   1489:       is also the pkgsrc default. If you have installed it into a different
                   1490:       directory, set <code class="varname">ICCBASE</code> in
1.4       rillig   1491:       <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1492: <pre class="programlisting">
                   1493: ICCBASE=                /opt/icc
                   1494:       </pre>
                   1495: <p>pkgsrc uses the static linking method of the runtime libraries
                   1496:       provided by icc, so binaries can be run on other systems which do not
                   1497:       have the shared libraries installed.</p>
                   1498: <p>Libtool, however, extracts a list of libraries from the
                   1499:       <a 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
                   1500:       records it, throwing away the -Bstatic and -Bdynamic options
                   1501:       interspersed between the libraries.  This means that
                   1502:       libtool-linked C++ shared libraries will have a runtime
                   1503:       dependency on the icc libraries until this is fixed in
                   1504:       libtool.</p>
                   1505: </div>
                   1506: <div class="sect2" lang="en">
                   1507: <div class="titlepage"><div><div><h3 class="title">
                   1508: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
                   1509: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1510: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1511:       with the OpenBSD userland tools. There are several steps:</p>
                   1512: <div class="orderedlist"><ol type="1">
                   1513: <li><p>OpenBSD stores its ports pkg database in
                   1514:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1515:          recommended that you choose a different location (e.g.
                   1516:          <code class="filename">/usr/pkgdb</code>) by
                   1517:          using the --pkgdbdir option to the bootstrap script.</p></li>
                   1518: <li>
                   1519: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1520:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1521: <pre class="screen">
                   1522: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1523: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1524: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1525: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1526: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1527:          </pre>
                   1528: </li>
                   1529: <li>
1.4       rillig   1530: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1531:          <code class="filename">/etc/mk.conf.example</code> file
                   1532:          when you use the bootstrap script. OpenBSD's make program uses
1.4       rillig   1533:          <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1534:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1535:          of the file with:</p>
                   1536: <pre class="programlisting">
                   1537: .ifdef BSD_PKG_MK
                   1538: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1539: .else
                   1540: # OpenBSD stuff
                   1541: .endif
                   1542:          </pre>
                   1543: </li>
                   1544: </ol></div>
                   1545: </div>
                   1546: <div class="sect2" lang="en">
                   1547: <div class="titlepage"><div><div><h3 class="title">
                   1548: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
                   1549: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
                   1550:       You will need a working C compiler. Both gcc 2.95.3 and
                   1551:       Sun WorkShop 5 have been tested.</p>
                   1552: <p>The following packages are required on Solaris 8 for the bootstrap
                   1553:       process and to build packages.</p>
                   1554: <div class="itemizedlist"><ul type="disc">
                   1555: <li><p>SUNWsprot</p></li>
                   1556: <li><p>SUNWarc</p></li>
                   1557: <li><p>SUNWbtool</p></li>
                   1558: <li><p>SUNWtoo</p></li>
                   1559: <li><p>SUNWlibm</p></li>
                   1560: </ul></div>
                   1561: <p>Please note that the use of GNU binutils on Solaris is
                   1562:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1563: <p>Whichever compiler you use, please ensure the compiler tools and
                   1564:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1565:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1566:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
                   1567: <div class="sect3" lang="en">
                   1568: <div class="titlepage"><div><div><h4 class="title">
                   1569: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
                   1570: <p>It makes life much simpler if you only use the same gcc consistently
                   1571:        for building all packages.</p>
                   1572: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1573:        then either build gcc from
                   1574:        <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
                   1575:        package, then remove gcc used during bootstrapping.</p>
                   1576: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
                   1577: </div>
                   1578: <div class="sect3" lang="en">
                   1579: <div class="titlepage"><div><div><h4 class="title">
                   1580: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
                   1581: <p>You will need at least the following packages installed (from WorkShop
                   1582:        5.0)</p>
                   1583: <div class="itemizedlist"><ul type="disc">
                   1584: <li><p>SPROcc
                   1585:          - Sun WorkShop Compiler C 5.0</p></li>
                   1586: <li><p>SPROcpl
                   1587:          - Sun WorkShop Compiler C++ 5.0</p></li>
                   1588: <li><p>SPROild
                   1589:          - Sun WorkShop Incremental Linker</p></li>
                   1590: <li><p>SPROlang
                   1591:          - Sun WorkShop Compilers common components</p></li>
                   1592: </ul></div>
                   1593: <p>You should set the following variables in your
1.4       rillig   1594:        <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1595: <pre class="programlisting">
                   1596: CC=     cc
                   1597: CXX=    CC
                   1598: CPP=    cc -E
                   1599: CXXCPP= CC -E
                   1600: </pre>
                   1601: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1602: <h3 class="title">Note</h3>
                   1603: <p>The <code class="varname">CPP</code> setting might break some
                   1604:        packages that use the C preprocessor for processing things other
                   1605:        than C source code.</p>
                   1606: </div>
                   1607: </div>
                   1608: <div class="sect3" lang="en">
                   1609: <div class="titlepage"><div><div><h4 class="title">
                   1610: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
                   1611: <p>To build 64-bit packages, you just need to have the
1.4       rillig   1612:        following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1613: <pre class="programlisting">
                   1614: PKGSRC_COMPILER=        sunpro
                   1615: ABI=                    64
                   1616: </pre>
                   1617: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1618: <h3 class="title">Note</h3>
                   1619: <p>This setting has been tested for the SPARC
                   1620:        architecture. Intel and AMD machines need some more
                   1621:        work.</p>
                   1622: </div>
                   1623: </div>
                   1624: <div class="sect3" lang="en">
                   1625: <div class="titlepage"><div><div><h4 class="title">
                   1626: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
                   1627: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
                   1628:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1629:       The workaround is to use another shell for the configure
                   1630:       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.4       rillig   1631:       to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1632: <pre class="programlisting">
                   1633: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1634: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1635:       </pre>
                   1636: <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>
                   1637: </div>
                   1638: </div>
                   1639: </div>
                   1640: </div>
                   1641: <div class="chapter" lang="en">
                   1642: <div class="titlepage"><div><div><h2 class="title">
                   1643: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1644: <div class="toc">
                   1645: <p><b>Table of Contents</b></p>
                   1646: <dl>
                   1647: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1648: <dd><dl>
                   1649: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1650: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1651: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1652: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1653: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1654: <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>
                   1655: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1656: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1657: </dl></dd>
                   1658: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1659: <dd><dl>
                   1660: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1661: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1662: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1663: </dl></dd>
                   1664: </dl>
                   1665: </div>
                   1666: <p>Basically, there are two ways of using pkgsrc. The first
                   1667: is to only install the package tools and to use binary packages
                   1668: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1669: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1670: of pkgsrc, too. Then you are able to build your own packages,
                   1671: and you can still use binary packages from someone else.</p>
                   1672: <div class="sect1" lang="en">
                   1673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1674: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.9     ! rillig   1675: <p>On the <a href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
        !          1676:   server and its mirrors, there are collections of binary packages,
        !          1677:   ready to be installed. These binary packages have been built using the
        !          1678:   default settings for the directories, that is:</p>
        !          1679: <div class="itemizedlist"><ul type="disc">
        !          1680: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
        !          1681: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
        !          1682: <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>
        !          1683: </ul></div>
        !          1684: <p>If you cannot use these directories for whatever reasons (maybe
        !          1685:   because you're not root), you cannot use these binary packages, but
        !          1686:   have to build the packages yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.1       dsieger  1687: <div class="sect2" lang="en">
                   1688: <div class="titlepage"><div><div><h3 class="title">
                   1689: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1690: <p>To install binary packages, you first need to know from where
                   1691:     to get them. The first place where you should look is on the main
                   1692:     pkgsrc FTP server in the directory <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
                   1693: <p>This directory contains binary packages for multiple
                   1694:     platforms. First, select your operating system. (Ignore the
                   1695:     directories with version numbers attached to it, they just exist for
                   1696:     legacy reasons.) Then, select your hardware architecture, and in the
1.9     ! rillig   1697:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
        !          1698: <p>In this directory, you often find a file called
        !          1699:     <code class="filename">bootstrap.tar.gz</code> which contains the package
        !          1700:     management tools. If the file is missing, it is likely that your
        !          1701:     operating system already provides those tools. Download the file and
        !          1702:     extract it in the <code class="filename">/</code> directory. It will create
        !          1703:     the directories <code class="filename">/usr/pkg</code> (containing the tools
        !          1704:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
        !          1705:     (the database of installed packages).</p>
1.1       dsieger  1706: </div>
                   1707: <div class="sect2" lang="en">
                   1708: <div class="titlepage"><div><div><h3 class="title">
                   1709: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9     ! rillig   1710: <p>In the directory from the last section, there is a
        !          1711:     subdirectory called <code class="filename">All</code>, which contains all the
        !          1712:     binary packages that are available for the platform, excluding those
        !          1713:     that may not be distributed via FTP or CDROM (depending on which
        !          1714:     medium you are using), and the ones that have vulnerabilities and
        !          1715:     therefore are considered insecure to install without thinking
        !          1716:     before.</p>
        !          1717: <p>To install packages directly from an FTP or HTTP server, run
        !          1718:     the following commands in a Bourne-compatible shell (be sure to
        !          1719:     <span><strong class="command">su</strong></span> to root first):</p>
        !          1720: <pre class="screen">
        !          1721: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
        !          1722: <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>
        !          1723: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
        !          1724: </pre>
        !          1725: <p>Instead of URLs, you can also use local paths, for example if
        !          1726:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
        !          1727:     repository. If you want to install packages from multiple sources,
        !          1728:     you can separate them by a semicolon in
        !          1729:     <code class="varname">PKG_PATH</code>.</p>
        !          1730: <p>After these preparations, installing a package is very
        !          1731:     easy:</p>
        !          1732: <pre class="screen">
        !          1733: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
        !          1734: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
        !          1735: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
        !          1736: </pre>
1.1       dsieger  1737: <p>Note that any prerequisite packages needed to run the
                   1738:     package in question will be installed, too, assuming they are
                   1739:     present where you install from.</p>
1.9     ! rillig   1740: <p>As mentioned above, packages for which vulnerabilities get
        !          1741:     known are not stored in the <code class="filename">All</code> subdirectory.
        !          1742:     They don't get deleted since that could be very frustrating if many
        !          1743:     other packages depend on it. Instead, they are moved to the
        !          1744:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
        !          1745:     this directory to the <code class="varname">PKG_PATH</code> variable. 
        !          1746:     However, you should run <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> regularly, especially
        !          1747:     after installing new packages, and verify that the vulnerabilities
        !          1748:     are acceptable for your configuration.</p>
1.1       dsieger  1749: <p>After you've installed packages, be sure to have
                   1750:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1751:     <code class="varname">PATH</code> so you can actually start the just
                   1752:     installed program.</p>
                   1753: </div>
                   1754: <div class="sect2" lang="en">
                   1755: <div class="titlepage"><div><div><h3 class="title">
                   1756: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1757: <p>To deinstall a package, it does not matter whether it was
                   1758:     installed from source code or from a binary package. The
                   1759:     <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
                   1760:     To delete a package, you can just run <span><strong class="command">pkg_delete
                   1761:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1762:     name can be given with or without version number. Wildcards can
                   1763:     also be used to deinstall a set of packages, for example
                   1764:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1765:     so that the shell does not expand them before
                   1766:     <code class="literal">pkg_delete</code> sees them.</p>
                   1767: <p>The <code class="option">-r</code> option is very powerful: it
                   1768:     removes all the packages that require the package in question
                   1769:     and then removes the package itself. For example:
                   1770: 
                   1771:     </p>
                   1772: <pre class="screen">
                   1773: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1774:     </pre>
                   1775: <p>
                   1776: 
                   1777:     will remove jpeg and all the packages that used it; this allows
                   1778:     upgrading the jpeg package.</p>
                   1779: </div>
                   1780: <div class="sect2" lang="en">
                   1781: <div class="titlepage"><div><div><h3 class="title">
                   1782: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
                   1783: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
                   1784:     installed packages or binary package files.</p>
                   1785: </div>
                   1786: <div class="sect2" lang="en">
                   1787: <div class="titlepage"><div><div><h3 class="title">
                   1788: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1789: <p>
                   1790:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1791:       known security vulnerabilities to packages which are (or have been)
                   1792:       included in pkgsrc.  The list is available from the NetBSD
                   1793:       FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
                   1794:     </p>
                   1795: <p>
                   1796:       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>,
                   1797:       this list can be downloaded
                   1798:       automatically, and a security audit of all packages installed on a system
                   1799:       can take place.
                   1800:     </p>
                   1801: <p>
                   1802:       There are two components to
                   1803:       <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
                   1804:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1805:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1806:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1807:       installed packages are vulnerable.  If a package is vulnerable, you
                   1808:       will see output similar to the following:
                   1809:     </p>
                   1810: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1811:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1812: <p>
                   1813:       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
                   1814:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
                   1815:       file daily, and include a package audit in the daily security script.
                   1816:       Details on this are located in the <a 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>
                   1817:       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>.
                   1818:     </p>
                   1819: </div>
                   1820: <div class="sect2" lang="en">
                   1821: <div class="titlepage"><div><div><h3 class="title">
                   1822: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1823: <p>
                   1824:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
                   1825:       <span><strong class="command">lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
                   1826:       argument to check if your packages are up-to-date, e.g.
                   1827:     </p>
                   1828: <pre class="screen">
                   1829: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1830: ...
                   1831: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1832:     </pre>
                   1833: <p>You can then use <span><strong class="command">make update</strong></span> to update the
                   1834:     package on your system and rebuild any dependencies.
                   1835:     </p>
                   1836: </div>
                   1837: <div class="sect2" lang="en">
                   1838: <div class="titlepage"><div><div><h3 class="title">
                   1839: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
                   1840: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
                   1841:     administrative functions on the package system.</p>
                   1842: </div>
                   1843: <div class="sect2" lang="en">
                   1844: <div class="titlepage"><div><div><h3 class="title">
                   1845: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1846: <p>Please pay very careful attention to the warnings
                   1847:     expressed in the <a 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
                   1848:     inherent dangers of installing binary packages which you did
                   1849:     not create yourself, and the security holes that can be
                   1850:     introduced onto your system by indiscriminate adding of such
                   1851:     files.</p>
                   1852: <p>The same warning of course applies to every package you
                   1853:     install from source when you haven't completely read and
                   1854:     understood the source code of the package, the compiler that
                   1855:     is used to build the package and all the other tools that are
                   1856:     involved.</p>
                   1857: </div>
                   1858: </div>
                   1859: <div class="sect1" lang="en">
                   1860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1861: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1862: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1863:   directory now contains a set of packages, organized into
                   1864:   categories. You can browse the online index of packages, or run
                   1865:   <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
                   1866:   directory to build local <code class="filename">README.html</code> files for
                   1867:   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>
                   1868: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1869:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1870:   should do so by setting <code class="varname">LOCALBASE</code> in
1.4       rillig   1871:   <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1872:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1873:   system (inside a chroot is an exception). </p>
                   1874: <p>The rest of this chapter assumes that the package is already
                   1875:   in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
                   1876:   instructions how to create your own packages.</p>
                   1877: <div class="sect2" lang="en">
                   1878: <div class="titlepage"><div><div><h3 class="title">
                   1879: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1880: <p>To build packages from source, you need a working C
                   1881:     compiler. On NetBSD, you need to install the
                   1882:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1883:     sets. If you want to build X11-related packages, the
                   1884:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1885:     sets are required, too.</p>
                   1886: </div>
                   1887: <div class="sect2" lang="en">
                   1888: <div class="titlepage"><div><div><h3 class="title">
                   1889: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1890: <p>The first step for building a package is downloading the
                   1891:     distfiles (i.e. the unmodified source). If they have not yet been
                   1892:     downloaded, pkgsrc will fetch them automatically.</p>
                   1893: <p>If you have all files that you need in the
                   1894:     <code class="filename">distfiles</code> directory,
                   1895:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1896:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1897:     </p>
                   1898: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1899: <p>
1.4       rillig   1900:     to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1901: <p>By default a list of distribution sites will be randomly
                   1902:     intermixed to prevent huge load on servers which holding popular
                   1903:     packages (for example, SourceForge.net mirrors). Thus, every
                   1904:     time when you need to fetch yet another distfile all the mirrors
                   1905:     will be tried in new (random) order. You can turn this feature
                   1906:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1907:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1908: <p>You can overwrite some of the major distribution sites to
                   1909:     fit to sites that are close to your own.  By setting one or two
                   1910:     variables you can modify the order in which the master sites are
                   1911:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1912:     delimited list of domain suffixes.
                   1913:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1914:     contains a whitespace delimited list of regular expressions.  It
                   1915:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1916:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1917:     some examples.  This may save some of your bandwidth and
                   1918:     time.</p>
                   1919: <p>You can change these settings either in your shell's environment, or,
                   1920:     if you want to keep the settings, by editing the
1.4       rillig   1921:     <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1922:     and adding the definitions there.</p>
                   1923: <p>
                   1924:       If a package depends on many other packages (such as
                   1925:       <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
                   1926:       alternate between periods of
                   1927:       downloading source, and compiling. To ensure you have all the source
                   1928:       downloaded initially you can run the command:
                   1929:       </p>
                   1930: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1931: <p>
                   1932:       which will output and run a set of shell commands to fetch the
                   1933:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1934:       also choose to download the files manually.
                   1935:     </p>
                   1936: </div>
                   1937: <div class="sect2" lang="en">
                   1938: <div class="titlepage"><div><div><h3 class="title">
                   1939: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1940: <p>
                   1941:       Once the software has downloaded, any patches will be applied, then it
                   1942:       will be compiled for you. This may take some time depending on your
                   1943:       computer, and how many other packages the software depends on and their
                   1944:       compile time.
                   1945:     </p>
                   1946: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1947: <h3 class="title">Note</h3>
                   1948: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
                   1949:     use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
                   1950:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
                   1951: </div>
                   1952: <p>For example, type</p>
                   1953: <pre class="screen">
                   1954: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1955: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1956:     </pre>
                   1957: <p>at the shell prompt to build the various components of the
                   1958:     package.</p>
                   1959: <p>The next stage is to actually install the newly compiled
                   1960:     program onto your system. Do this by entering:
                   1961: 
                   1962:     </p>
                   1963: <pre class="screen">
                   1964: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1965:     </pre>
                   1966: <p>
                   1967: 
                   1968:     while you are still in the directory for whatever package you
                   1969:     are installing.</p>
                   1970: <p>Installing the package on your system may require you to
                   1971:     be root.  However, pkgsrc has a
                   1972:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1973:     to only become root for the actual installation step.</p>
                   1974: <p>That's it, the software should now be installed and setup for use.
                   1975:     You can now enter:
                   1976: 
                   1977:     </p>
                   1978: <pre class="screen">
                   1979: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1980:     </pre>
                   1981: <p>
                   1982: 
                   1983:     to remove the compiled files in the work directory, as you shouldn't need
                   1984:     them any more. If other packages were also added to your system
                   1985:     (dependencies) to allow your program to compile, you can tidy these up
                   1986:     also with the command:</p>
                   1987: <pre class="screen">
                   1988: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1989:     </pre>
                   1990: <p>Taking the figlet utility as an example, we can install it on our
                   1991:     system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
                   1992: <p>The program is installed under the default root of the
                   1993:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1994:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1995:     variable in your environment, and it will use that value as the
                   1996:     root of your packages tree. So, to use
                   1997:     <code class="filename">/usr/local</code>, set
                   1998:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1999:     Please note that you should use a directory which is dedicated to
                   2000:     packages and not shared with other programs (i.e., do not try and
                   2001:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2002:     to add any of your own files or directories (such as
                   2003:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2004:     <code class="filename">pkgsrc/</code>) below the
                   2005:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2006:     conflicts between programs and other files installed by the
                   2007:     package system and whatever else may have been installed
                   2008:     there.</p>
1.4       rillig   2009: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  2010:     alter some configuration options at build time.  Have a look at
                   2011:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2012:     of what will be set there by default.  Environment variables such
                   2013:     as <code class="varname">LOCALBASE</code> can be set in
1.4       rillig   2014:     <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  2015:     set them each time you want to use pkgsrc.</p>
                   2016: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2017:     covers</span>&#8221; to see what is going on when a package is building
                   2018:     or being installed. This may be for debugging purposes, or out of
                   2019:     simple curiosity. A number of utility values have been added to
                   2020:     help with this.</p>
                   2021: <div class="orderedlist"><ol type="1">
                   2022: <li>
                   2023: <p>If you invoke the <a 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
                   2024:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2025:        information will be displayed. For example,</p>
                   2026: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   2027: <p>will show all the commands that are invoked, up to and
                   2028:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
                   2029: </li>
                   2030: <li>
                   2031: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2032:        definition, then the <code class="varname">VARNAME</code> definition
                   2033:        should be used, in conjunction with the show-var
                   2034:        target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2035:        variable <code class="varname">LOCALBASE</code>:</p>
                   2036: <pre class="screen">
                   2037: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   2038: /usr/pkg
                   2039: <code class="prompt">%</code>
                   2040:        </pre>
                   2041: </li>
                   2042: </ol></div>
                   2043: <p>If you want to install a binary package that you've either
                   2044:     created yourself (see next section), that you put into
                   2045:     pkgsrc/packages manually or that is located on a remote FTP
                   2046:     server, you can use the "bin-install" target. This target will
                   2047:     install a binary package - if available - via <a 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>,
                   2048:     else do a <span><strong class="command">make package</strong></span>.  The list of remote FTP
                   2049:     sites searched is kept in the variable
                   2050:     <code class="varname">BINPKG_SITES</code>, which defaults to
                   2051:     ftp.NetBSD.org. Any flags that should be added to <a 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>
                   2052:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2053:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2054:     details.</p>
                   2055: <p>A final word of warning: If you set up a system that has a
                   2056:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2057:     set that before any packages are installed, as you cannot use
                   2058:     several directories for the same purpose. Doing so will result in
                   2059:     pkgsrc not being able to properly detect your installed packages,
                   2060:     and fail miserably. Note also that precompiled binary packages are
                   2061:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2062:     <code class="filename">/usr/pkg</code>, and that you should
                   2063:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2064:     <code class="varname">LOCALBASE</code>.</p>
                   2065: </div>
                   2066: </div>
                   2067: </div>
                   2068: <div class="chapter" lang="en">
                   2069: <div class="titlepage"><div><div><h2 class="title">
                   2070: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2071: <div class="toc">
                   2072: <p><b>Table of Contents</b></p>
                   2073: <dl>
                   2074: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2075: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9     ! rillig   2076: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2077: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2078: <dd><dl>
1.4       rillig   2079: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
                   2080: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2081: <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.1       dsieger  2082: </dl></dd>
1.4       rillig   2083: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2084: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2085: </dl>
                   2086: </div>
1.4       rillig   2087: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2088: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2089: that file depends on the installation. On NetBSD, when you use
                   2090: <a 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
                   2091: <code class="filename">/etc/</code>. In all other cases the default location is
                   2092: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2093: bootstrap program to install the binary packages.</p>
                   2094: <p>During the bootstrap, an example configuration file is created. To
                   2095: use that, you have to create the directory
                   2096: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2097: there.</p>
                   2098: <p>The format of the configuration file is that of the usual
                   2099: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2100: is done by setting variables in this file. Note that you can define all
                   2101: kinds of variables, and no special error checking (for example for
                   2102: spelling mistakes) takes place, so you have to try it out to see if it
                   2103: works.</p>
                   2104: <div class="sect1" lang="en">
                   2105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2106: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2107: <p>In this section, you can find some variables that apply to all
                   2108:     pkgsrc packages. A complete list of the variables that can be
                   2109:     configured by the user is available in
                   2110:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2111:     comments that describe each variable's intent.</p>
                   2112: <div class="itemizedlist"><ul type="disc">
                   2113: <li><p><code class="varname">LOCALBASE</code>: Where
                   2114:            packages will be installed. The default is
                   2115:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2116:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2117: <li><p><code class="varname">CROSSBASE</code>: Where
                   2118:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2119:            installed. The default is
                   2120:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
                   2121: <li><p><code class="varname">X11BASE</code>: Where
                   2122:            X11 is installed on the system. The default is
                   2123:            <code class="filename">/usr/X11R6</code>.</p></li>
                   2124: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2125:            downloaded copies of the original source distributions used
                   2126:            for building pkgsrc packages. The default is
                   2127:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
                   2128: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2129:            database about installed packages is stored.  The default is
                   2130:            <code class="filename">/var/db/pkg</code>.</p></li>
                   2131: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2132:            If set, override the packages'
                   2133:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2134: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2135:            Backup location(s) for distribution files and patch files
                   2136:            if not found locally or in
                   2137:            <code class="filename">${MASTER_SITES}</code> or
                   2138:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2139:            The defaults are
                   2140:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
                   2141:            and
                   2142:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
                   2143: <li><p><code class="varname">BINPKG_SITES</code>:
                   2144:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2145:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2146:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2147:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
                   2148: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2149:            List of acceptable licenses. Whenever you try to build a package
                   2150:            whose license is not in this list, you will get an error message
                   2151:            that includes instructions on how to change this variable.</p></li>
                   2152: </ul></div>
                   2153: </div>
                   2154: <div class="sect1" lang="en">
                   2155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2156: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2157: <p>XXX
                   2158:       </p>
                   2159: <div class="itemizedlist"><ul type="disc">
                   2160: <li><p><code class="varname">PACKAGES</code>: The top level
                   2161:            directory for the binary packages. The default is
                   2162:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
                   2163: <li><p><code class="varname">WRKOBJDIR</code>:
                   2164:            The top level directory where, if defined, the separate
                   2165:            working directories will get created, and symbolically
                   2166:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2167:            This is useful for building packages on several
                   2168:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2169:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2170:            is local to every architecture. (It should be noted that
                   2171:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.6       rillig   2172:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2173:            root of the pkgsrc tree. It is possible to have many
                   2174:            pkgsrc tree instances.)</p></li>
                   2175: <li><p><code class="varname">LOCALPATCHES</code>:
                   2176:            Directory for local patches that aren't part of pkgsrc.
1.6       rillig   2177:            See <a href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2178:            information.</p></li>
                   2179: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.4       rillig   2180:            the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2181:            BSD-style Makefile. If this is not set,
                   2182:            <code class="varname">MAKECONF</code> is set to
                   2183:            <code class="filename">/dev/null</code> to avoid picking up
                   2184:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
                   2185: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2186:            By default, dependencies are only installed, and no binary
                   2187:            package is created for them. You can set this variable to
                   2188:            <code class="literal">package</code> to automatically create binary
                   2189:            packages after installing dependencies.</p></li>
                   2190: </ul></div>
                   2191: </div>
                   2192: <div class="sect1" lang="en">
                   2193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9     ! rillig   2194: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.4       rillig   2195: <p>A growing number of packages support installation into a
                   2196:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2197:     to be built, before the actual filesystem is touched. DESTDIR
                   2198:     support exists in two variations:</p>
                   2199: <div class="itemizedlist"><ul type="disc">
                   2200: <li><p>Basic DESTDIR support means that the package
                   2201:       installation and packaging is still run as
                   2202:       root.</p></li>
                   2203: <li><p>Full DESTDIR support can run the complete build,
                   2204:       installation and packaging as normal user. Root privileges are
                   2205:       only needed to add packages.</p></li>
                   2206: </ul></div>
                   2207: <p>To use the DESTDIR support, set either
                   2208:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2209:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2210:     get the full support with fallback to basic
                   2211:     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
                   2212:     newer). It might become the default DESTDIR support later.</p>
                   2213: <p>DESTDIR support changes the behaviour of various targets
                   2214:     slightly. To install a package after building it, use
                   2215:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2216:     <code class="literal">install</code> don't do that any
                   2217:     longer. <code class="literal">package-install</code> can be used as
                   2218:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2219:     will ask for the root password to install the package and fail,
                   2220:     <code class="literal">package-install</code> will ask again.</p>
                   2221: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2222:     clean</code></strong> needs to be run as root.</p>
                   2223: </div>
                   2224: <div class="sect1" lang="en">
                   2225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2226: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1       dsieger  2227: <div class="sect2" lang="en">
                   2228: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2229: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2230: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2231:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2232: <div class="variablelist"><dl>
                   2233: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2234: <dd>
                   2235: <p>This is a list of values specifying the chain of
                   2236:          compilers to invoke when building packages.  Valid values
                   2237:          are:</p>
                   2238: <div class="itemizedlist"><ul type="disc">
                   2239: <li><p><code class="varname">distcc</code>:
                   2240:            distributed C/C++ (chainable)</p></li>
                   2241: <li><p><code class="varname">ccache</code>:
                   2242:            compiler cache (chainable)</p></li>
                   2243: <li><p><code class="varname">gcc</code>:
                   2244:            GNU C/C++ Compiler</p></li>
                   2245: <li><p><code class="varname">mipspro</code>:
                   2246:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2247: <li><p><code class="varname">mipspro</code>:
                   2248:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2249: <li><p><code class="varname">sunpro</code>:
                   2250:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2251: </ul></div>
                   2252: <p>The default is
                   2253:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2254:          <code class="varname">ccache</code> and/or
                   2255:          <code class="varname">distcc</code> with an appropriate
                   2256:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2257:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
                   2258:          variable should always be terminated with a value for
                   2259:          a real compiler.  Note that only one real compiler
                   2260:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2261:          is not allowed).</p>
                   2262: </dd>
                   2263: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2264: <dd><p>This specifies the minimum version of GCC to use
                   2265:          when building packages.  If the system GCC doesn't
                   2266:          satisfy this requirement, then pkgsrc will build and
                   2267:          install one of the GCC packages to use instead.</p></dd>
                   2268: </dl></div>
                   2269: </div>
                   2270: <div class="sect2" lang="en">
                   2271: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2272: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2273: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2274:        please make sure to use the <code class="literal">+=</code> operator
                   2275:        instead of the <code class="literal">=</code> operator:</p>
                   2276: <pre class="programlisting">
                   2277: CFLAGS+=        -your -flags
                   2278: </pre>
                   2279: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2280:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2281:        to add their own flags.  Also, you may want to take a look at
                   2282:        the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
                   2283:        you're interested in optimization for the current CPU.</p>
                   2284: </div>
                   2285: <div class="sect2" lang="en">
                   2286: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2287: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2288: <p>If you want to pass flags to the linker, both in the configure
                   2289: step and the build step, you can do this in two ways.  Either set
                   2290: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2291: between the two is that <code class="varname">LIBS</code> will be appended to
                   2292: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2293: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2294: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2295: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2296: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2297: settings, use the <code class="literal">+=</code> operator:</p>
                   2298: <pre class="programlisting">
                   2299: LDFLAGS+=        -your -linkerflags
                   2300: </pre>
                   2301: </div>
                   2302: </div>
                   2303: <div class="sect1" lang="en">
                   2304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2305: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2306: <p>XXX
                   2307:       </p>
                   2308: <div class="itemizedlist"><ul type="disc">
                   2309: <li>
                   2310: <p><code class="varname">PKG_DEVELOPER</code>:
                   2311:            Run some sanity checks that package developers want:
                   2312:            </p>
                   2313: <div class="itemizedlist"><ul type="circle">
                   2314: <li><p>make sure patches apply with zero
                   2315:              fuzz</p></li>
                   2316: <li><p>run check-shlibs to see that all
                   2317:              binaries will find their shared libs.</p></li>
                   2318: </ul></div>
                   2319: <p>
                   2320:        </p>
                   2321: </li>
                   2322: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2323:        of debugging output which is displayed whilst making and
                   2324:        installing the package.  The default value for this is 0,
                   2325:        which will not display the commands as they are executed
                   2326:        (normal, default, quiet operation); the value 1 will display
                   2327:        all shell commands before their invocation, and the value 2
                   2328:        will display both the shell commands before their invocation,
                   2329:        and their actual execution progress with <span><strong class="command">set
                   2330:        -x</strong></span> will be displayed.</p></li>
                   2331: </ul></div>
                   2332: <p>
                   2333:     </p>
                   2334: </div>
                   2335: <div class="sect1" lang="en">
                   2336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2337: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2338: <p>Some packages have build time options, usually to select
                   2339:     between different dependencies, enable optional support for big
                   2340:     dependencies or enable experimental features.</p>
                   2341: <p>To see which options, if any, a package supports, and which
                   2342:     options are mutually exclusive, run <span><strong class="command">make
                   2343:     show-options</strong></span>, for example:</p>
                   2344: <pre class="programlisting">
                   2345:     The following options are supported by this package:
                   2346:         ssl      Enable SSL support.
                   2347:     Exactly one of the following gecko options is required:
                   2348:         firefox  Use firefox as gecko rendering engine.
                   2349:         mozilla  Use mozilla as gecko rendering engine.
                   2350:     At most one of the following database options may be selected:
                   2351:         mysql    Enable support for MySQL database.
                   2352:         pgsql    Enable support for PostgreSQL database.
                   2353: 
                   2354:     These options are enabled by default: firefox
                   2355:     These options are currently enabled: mozilla ssl
                   2356: </pre>
                   2357: <p>The following variables can be defined in
1.4       rillig   2358:     <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2359:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2360:     which can be used to select or disable options for all packages
                   2361:     that support them, and
                   2362:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2363:     which can be used to select or disable options specifically for
                   2364:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2365:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2366:     are disabled. A few examples:</p>
                   2367: <pre class="screen">
1.4       rillig   2368: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" <a href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger  2369: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2370: PKG_OPTIONS.kdebase=    debug -sasl
                   2371: PKG_OPTIONS.apache=     suexec </pre>
                   2372: <p>The following settings are consulted in the order given, and
                   2373:     the last setting that selects or disables an option is
                   2374:     used:</p>
                   2375: <div class="orderedlist"><ol type="1">
                   2376: <li><p>the default options as suggested by the package
                   2377:       maintainer</p></li>
                   2378: <li><p>the options implied by the settings of legacy
                   2379:       variables (see below)</p></li>
                   2380: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2381: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2382: </ol></div>
                   2383: <p>For groups of mutually exclusive options, the last option
                   2384:     selected is used, all others are automatically disabled.  If an
                   2385:     option of the group is explicitly disabled, the previously
                   2386:     selected option, if any, is used.  It is an error if no option
                   2387:     from a required group of options is selected, and building the
                   2388:     package will fail.</p>
                   2389: <p>Before the options framework was introduced, build options
                   2390:     were selected by setting a variable (often named
                   2391:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.4       rillig   2392:     <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2393:     transition to the options framework for the user, these legacy
                   2394:     variables are converted to the appropriate options setting
                   2395:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2396:     automatically.  A warning is issued to prompt the user to update
1.4       rillig   2397:     <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2398:     directly.  Support for the legacy variables will be removed
                   2399:     eventually.</p>
                   2400: </div>
                   2401: </div>
                   2402: <div class="chapter" lang="en">
                   2403: <div class="titlepage"><div><div><h2 class="title">
                   2404: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2405: <div class="toc">
                   2406: <p><b>Table of Contents</b></p>
                   2407: <dl>
                   2408: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2409: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2410: </dl>
                   2411: </div>
                   2412: <div class="sect1" lang="en">
                   2413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2414: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2415: <p>Once you have built and installed a package, you can create
                   2416:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
                   2417:     another system with <a 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
                   2418:     the same package on a group of hosts and wasting CPU time. It also
                   2419:     provides a simple means for others to install your package, should
                   2420:     you distribute it.</p>
                   2421: <p>To create a binary package, change into the appropriate
                   2422:     directory in pkgsrc, and run <span><strong class="command">make
                   2423:     package</strong></span>:</p>
                   2424: <pre class="screen">
                   2425: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2426: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2427:     </pre>
                   2428: <p>This will build and install your package (if not already done),
                   2429:     and then build a binary package from what was installed. You can
                   2430:     then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
                   2431:     it. Binary packages are created by default in
                   2432:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
                   2433:     gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
                   2434:     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.6       rillig   2435: <p>See <a href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1       dsieger  2436:     such a binary package.</p>
                   2437: </div>
                   2438: <div class="sect1" lang="en">
                   2439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2440: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.6       rillig   2441: <p>See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
                   2442: </div>
                   2443: </div>
                   2444: <div class="chapter" lang="en">
                   2445: <div class="titlepage"><div><div><h2 class="title">
                   2446: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2447: builds)</h2></div></div></div>
                   2448: <div class="toc">
                   2449: <p><b>Table of Contents</b></p>
                   2450: <dl>
                   2451: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2452: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2453: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2454: <dd><dl>
                   2455: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2456: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2457: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2458: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2459: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2460: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2461: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2462: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2463: </dl></dd>
                   2464: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
                   2465: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
                   2466: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2467: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2468: </dl>
                   2469: </div>
                   2470: <p>When you have multiple machines that should run the same packages,
                   2471: it is wasted time if they all build their packages themselves from
                   2472: source. There are two ways of getting a set of binary packages: The old
                   2473: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2474: system. This chapter describes how to set them up so that the packages
                   2475: are most likely to be usable later.</p>
                   2476: <div class="sect1" lang="en">
                   2477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2478: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2479: <p>Since a bulk build takes several days or even weeks to finish, you
                   2480: should think about the setup before you start everything. Pay attention
                   2481: to at least the following points:</p>
                   2482: <div class="itemizedlist"><ul type="disc">
                   2483: <li>
                   2484: <p>If you want to upload the binary packages to
                   2485: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2486: packages:</p>
                   2487: <div class="itemizedlist"><ul type="circle">
                   2488: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2489: by a NetBSD developer on a trusted machine (that is, where you and only
                   2490: you have root access).</p></li>
                   2491: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2492: the stable branches (like 2007Q1), so that users browsing the available
                   2493: collections can see at a glance how old the packages
                   2494: are.</p></li>
                   2495: <li><p>The packages must be built as root, since some packages
                   2496: require set-uid binaries at runtime, and creating those packages as
                   2497: unprivileged user doesn't work well at the moment.</p></li>
                   2498: </ul></div>
                   2499: </li>
                   2500: <li><p>Make sure that the bulk build cannot break anything in
                   2501: your system. Most bulk builds run as root, so they should be run at least
                   2502: in a chroot environment or something even more restrictive, depending on
                   2503: what the operating system provides. There have been numerous cases where
                   2504: certain packages tried to install files outside the
                   2505: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2506: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2507: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2508: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2509: that you don't need any package during the build.</p></li>
                   2510: </ul></div>
                   2511: </div>
                   2512: <div class="sect1" lang="en">
                   2513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2514: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2515: <p>A complete bulk build requires lots of disk space. Some of the
                   2516: disk space can be read-only, some other must be writable. Some can be on
                   2517: remote filesystems (such as NFS) and some should be local. Some can be
                   2518: temporary filesystems, others must survive a sudden reboot.</p>
                   2519: <div class="itemizedlist"><ul type="disc">
                   2520: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2521: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2522: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2523: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2524: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2525: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2526: </ul></div>
1.1       dsieger  2527: </div>
                   2528: <div class="sect1" lang="en">
                   2529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2530: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
                   2531: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2532: <h3 class="title">Warning</h3>
                   2533: <p>The rest of this section is rather old. Don't rely on it
                   2534: too much.</p>
                   2535: </div>
1.1       dsieger  2536: <div class="sect2" lang="en">
                   2537: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2538: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1       dsieger  2539: <div class="sect3" lang="en">
                   2540: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2541: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2542: </h4></div></div></div>
                   2543: <p>The <code class="filename">build.conf</code> file is the main
                   2544:        configuration file for bulk builds. You can configure how your
                   2545:        copy of pkgsrc is kept up to date, how the distfiles are
                   2546:        downloaded, how the packages are built and how the report is
                   2547:        generated. You can find an annotated example file in
                   2548:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2549:        it, copy <code class="filename">build.conf-example</code> to
                   2550:        <code class="filename">build.conf</code> and edit it, following the
                   2551:        comments in that file.</p>
                   2552: </div>
                   2553: <div class="sect3" lang="en">
                   2554: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2555: <a name="binary.mk.conf"></a>7.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4       rillig   2556: </h4></div></div></div>
                   2557: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2558:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2559:        details of the default settings. You will want to ensure that
                   2560:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2561:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4       rillig   2562:        completely bypasses the license check.</p>
1.1       dsieger  2563: <pre class="programlisting">
                   2564: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2565: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2566: BSDSRCDIR=      /usr/src
                   2567: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2568: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2569: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2570: PKG_DEVELOPER?= yes
                   2571: _ACCEPTABLE=    yes
                   2572: </pre>
                   2573: <p>Some options that are especially useful for bulk builds
                   2574:        can be found at the top lines of the file
                   2575:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2576:        options of these are briefly described here.</p>
                   2577: <div class="itemizedlist"><ul type="disc">
                   2578: <li><p>If you are on a slow machine, you may want to
                   2579:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2580:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
                   2581: <li><p>If you are doing bulk builds from a read-only
                   2582:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2583:          to the directory where all log files are created. Otherwise the
                   2584:          log files are created in the pkgsrc directory.</p></li>
                   2585: <li><p>Another important variable is
                   2586:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2587:          should be always available while building other
                   2588:          packages.</p></li>
                   2589: </ul></div>
                   2590: <p>Some other options are scattered in the pkgsrc
                   2591:        infrastructure:</p>
                   2592: <div class="itemizedlist"><ul type="disc">
                   2593: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2594:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2595:          builds is creating binary packages, no matter if they are
                   2596:          vulnerable or not. When uploading the packages to a public
                   2597:          server, the vulnerable packages will be put into a directory of
                   2598:          their own. Leaving this variable unset would prevent the bulk
                   2599:          build system from even trying to build them, so possible
                   2600:          building errors would not show up.</p></li>
                   2601: <li><p><code class="varname">CHECK_FILES</code>
                   2602:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
                   2603:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2604:          matches the <code class="filename">PLIST</code>.</p></li>
                   2605: <li><p><code class="varname">CHECK_INTERPRETER</code>
                   2606:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
                   2607:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2608:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2609:          interpreter.</p></li>
                   2610: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2611:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2612:          package's self-test before installing it. Note that some
                   2613:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2614:          numbers, so you need to assure that the machine on which you
                   2615:          are doing the bulk builds is not completely idle. Otherwise
                   2616:          some test programs will seem to hang, while they are just
                   2617:          waiting for new random data to be
                   2618:          available.</p></li>
                   2619: </ul></div>
                   2620: </div>
                   2621: <div class="sect3" lang="en">
                   2622: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2623: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2624: </h4></div></div></div>
                   2625: <p>It is possible to configure the bulk build to perform
                   2626:        certain site-specific tasks at the end of the pre-build
                   2627:        stage.  If the file
                   2628:        <code class="filename">pre-build.local</code> exists in
                   2629:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
                   2630:        (as a <a 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
                   2631:        stage.  An example use of
                   2632:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2633: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2634:        &gt; misc/openoffice/$BROKENF</pre>
                   2635: <p>to prevent the system from trying to build a particular package
                   2636:        which requires nearly 3 GB of disk space.</p>
                   2637: </div>
                   2638: </div>
                   2639: <div class="sect2" lang="en">
                   2640: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2641: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2642: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2643:       deleted at the start of bulk builds, make sure your login
                   2644:       shell is placed somewhere else. Either drop it into
                   2645:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2646:       shell in the passwd file), or (re-)install it via
                   2647:       <a 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
                   2648:       you can login after a reboot (remember that your current
                   2649:       process won't die if the package is removed, you just can't
                   2650:       start any new instances of the shell any more).  Also, if you
                   2651:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2652:       version of ssh for some reason, be sure to install ssh before
                   2653:       starting it from <code class="filename">rc.local</code>:</p>
                   2654: <pre class="programlisting">
                   2655: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2656: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2657:   /usr/pkg/etc/rc.d/sshd
                   2658: fi
                   2659: </pre>
                   2660: <p>Not doing so will result in you being not able to log in
                   2661:       via ssh after the bulk build is finished or if the machine
                   2662:       gets rebooted or crashes. You have been warned! :)</p>
                   2663: </div>
                   2664: <div class="sect2" lang="en">
                   2665: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2666: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2667: <p>Make sure you don't need any of the packages still
                   2668:       installed.</p>
                   2669: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2670: <h3 class="title">Warning</h3>
                   2671: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2672:        configuration files and some more files from
                   2673:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2674:        possibly other locations will be removed! So don't run a bulk
                   2675:        build with privileges that might harm your
                   2676:        system.</em></span></p>
                   2677: </div>
                   2678: <p>Be sure to remove all other things that might
                   2679:       interfere with builds, like some libs installed in
                   2680:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2681: <pre class="screen">
                   2682: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2683: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2684:       </pre>
                   2685: <p>If for some reason your last build didn't complete (power
                   2686:       failure, system panic, ...), you can continue it by
                   2687:       running:</p>
                   2688: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2689: <p>At the end of the bulk build, you will get a summary via mail,
                   2690:       and find build logs in the directory specified by
                   2691:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2692:       file.</p>
                   2693: </div>
                   2694: <div class="sect2" lang="en">
                   2695: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2696: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2697: <p>The bulk builds consist of three steps:</p>
                   2698: <div class="variablelist"><dl>
                   2699: <dt><span class="term">1. pre-build</span></dt>
                   2700: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2701:            cleans out any broken distfiles, and removes all
                   2702:            packages installed.</p></dd>
                   2703: <dt><span class="term">2. the bulk build</span></dt>
                   2704: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2705:            an optimised order in which packages will be
                   2706:            built. Packages that don't require other packages will
                   2707:            be built first, and packages with many dependencies will
                   2708:            be built later.</p></dd>
                   2709: <dt><span class="term">3. post-build</span></dt>
                   2710: <dd><p>Generates a report that's placed in the directory
                   2711:            specified in the <code class="filename">build.conf</code> file
                   2712:            named <code class="filename">broken.html</code>, a short version
                   2713:            of that report will also be mailed to the build's
                   2714:            admin.</p></dd>
                   2715: </dl></div>
                   2716: <p>During the build, a list of broken packages will be compiled
                   2717:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2718:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2719:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2720:       of broken builds can be found in the package's
                   2721:       directory. These files are used by the bulk-targets to mark
                   2722:       broken builds to not waste time trying to rebuild them, and
                   2723:       they can be used to debug these broken package builds
                   2724:       later.</p>
                   2725: </div>
                   2726: <div class="sect2" lang="en">
                   2727: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2728: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2729: <p>Currently, roughly the following requirements are valid for
                   2730:       NetBSD 2.0/i386:</p>
                   2731: <div class="itemizedlist"><ul type="disc">
                   2732: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2733: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2734: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2735: </ul></div>
                   2736: <p>Note that all pkgs will be de-installed as soon as they are
                   2737:       turned into a binary package, and that sources are removed,
                   2738:       so there is no excessively huge demand to disk
                   2739:       space. Afterwards, if the package is needed again, it will
                   2740:       be installed via <a 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
                   2741:       there are no cycles wasted by recompiling.</p>
                   2742: </div>
                   2743: <div class="sect2" lang="en">
                   2744: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2745: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2746: <p>If you don't want all the packages nuked from a machine
                   2747:       (rendering it useless for anything but pkg compiling), there
                   2748:       is the possibility of doing the package bulk build inside a
                   2749:       chroot environment.</p>
                   2750: <p>The first step is to set up a chroot sandbox,
                   2751:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2752:       using null mounts, or manually.</p>
                   2753: <p>There is a shell script called
                   2754:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2755:       up the sandbox environment using null mounts. It will also
                   2756:       create a script called <code class="filename">sandbox</code> in the
                   2757:       root of the sandbox environment, which will allow the null
                   2758:       mounts to be activated using the <span><strong class="command">sandbox
                   2759:       mount</strong></span> command and deactivated using the
                   2760:       <span><strong class="command">sandbox umount</strong></span> command.</p>
                   2761: <p>To set up a sandbox environment by hand, after extracting all
                   2762:       the sets from a NetBSD installation or doing a <span><strong class="command">make
                   2763:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2764:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2765:       are present and properly configured:</p>
                   2766: <div class="procedure"><ol type="1">
                   2767: <li>
                   2768: <p>Kernel</p>
                   2769: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2770: </li>
                   2771: <li>
                   2772: <p><code class="filename">/dev/*</code></p>
                   2773: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2774: </li>
                   2775: <li>
                   2776: <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>
                   2777: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2778: </li>
                   2779: <li>
                   2780: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2781: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2782: </li>
                   2783: <li>
                   2784: <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>
                   2785: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2786: </li>
                   2787: <li>
                   2788: <p><code class="filename">/usr/src</code> (system sources,
1.6       rillig   2789:          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.1       dsieger  2790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2791:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2792: </li>
                   2793: <li>
                   2794: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2795: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2796: </li>
                   2797: <li>
                   2798: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2800: </li>
                   2801: <li>
                   2802: <p>Checkout pkgsrc via cvs into
                   2803:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2804: <pre class="screen">
                   2805: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2806: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2807:          </pre>
                   2808: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2809:          you do development in, as this will likely cause problems!</p>
                   2810: </li>
                   2811: <li><p>Make
                   2812:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2813:          <code class="filename">.../distfiles</code> point somewhere
                   2814:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.6       rillig   2815: <li><p>Edit <a href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a 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.1       dsieger  2816: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
                   2817: </ol></div>
                   2818: <p>When the chroot sandbox is set up, you can start
                   2819:       the build with the following steps:</p>
                   2820: <pre class="screen">
                   2821: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2822: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2823:       </pre>
                   2824: <p>This will just jump inside the sandbox and start building.  At
                   2825:        the end of the build, mail will be sent with the results of
                   2826:        the build. Created binary pkgs will be in
                   2827:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2828:       (wherever that points/mounts to/from).</p>
                   2829: </div>
                   2830: <div class="sect2" lang="en">
                   2831: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2832: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2833: <p>In addition to building a complete set of all packages in
                   2834:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2835:       may be used to build a subset of the packages contained in
                   2836:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.4       rillig   2837:       in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1       dsieger  2838: <div class="itemizedlist"><ul type="disc">
                   2839: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2840: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2841: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2842: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2843: </ul></div>
                   2844: <p>will define the set of packages which should be built.
                   2845:       The bulk build code will also include any packages which are
                   2846:       needed as dependencies for the explicitly listed packages.</p>
                   2847: <p>One use of this is to do a bulk build with
                   2848:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2849:       periodically to have a complete set of the binary packages
                   2850:       needed for your site available without the overhead of
                   2851:       building extra packages that are not needed.</p>
                   2852: </div>
                   2853: <div class="sect2" lang="en">
                   2854: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2855: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2856: <p>This section describes how pkgsrc developers can upload binary
                   2857:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2858: <p>If you would like to automatically create checksum files for the
                   2859:       binary packages you intend to upload, remember to set
                   2860:       <code class="varname">MKSUMS=yes</code> in your
                   2861:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2862: <p>If you would like to PGP sign the checksum files (highly
                   2863:       recommended!), remember to set
                   2864:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2865:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2866:       your GPG password to sign the files before uploading everything.</p>
                   2867: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2868:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2869:       file, i.e. adjust it to something like one of the following:</p>
                   2870: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2871: <p>Please use appropriate values for "packages-200xQy",
                   2872:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2873:       is different from your local login, write your login directly
                   2874:       into the variable, e.g. my local account is "feyrer", but for my
                   2875:       login "hubertf", I use:</p>
                   2876: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
                   2877: <p>A separate <code class="filename">upload</code> directory is used
                   2878:       here to allow "closing" the directory during upload. To do
                   2879:       so, run the following command on ftp.NetBSD.org next:</p>
                   2880: <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>
                   2881: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2882:       only appropriate for packages for the NetBSD operating
                   2883:       system. Binary packages for other operating systems should go
                   2884:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2885: <p>Before uploading the binary pkgs, ssh authentication needs
                   2886:       to be set up. This example shows how to set up temporary keys
                   2887:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2888:       (assuming that no keys should be present there usually):</p>
                   2889: <pre class="screen">
                   2890: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2891: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2892: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
                   2893: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2894:       </pre>
                   2895: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2896:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2897:       file on ftp.NetBSD.org. You can remove the key after the
                   2898:       upload is done!</p>
                   2899: <p>Next, test if your ssh connection really works:</p>
                   2900: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2901: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2902: <p>Now after all this works, you can exit the sandbox and start
                   2903:       the upload:</p>
                   2904: <pre class="screen">
                   2905: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2906: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2907: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2908:       </pre>
                   2909: <p>The upload process may take quite some time. Use <a 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
                   2910:       <a 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
                   2911:       upload. The upload script will take care of not uploading
                   2912:       restricted packages and putting vulnerable packages into the
                   2913:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2914: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2915: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2916:       Gdd:x! </pre>
                   2917: <p>Use whatever is needed to remove the key you've entered
                   2918:       before! Last, move the uploaded packages out of the
                   2919:       <code class="filename">upload</code> directory to have them accessible
                   2920:       to everyone:</p>
                   2921: <pre class="screen">
                   2922: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
                   2923: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2924: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
                   2925: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2926:       </pre>
                   2927: </div>
                   2928: </div>
                   2929: <div class="sect1" lang="en">
                   2930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2931: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
                   2932: <div class="sect2" lang="en">
                   2933: <div class="titlepage"><div><div><h3 class="title">
                   2934: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
                   2935: <p>TODO; see <a href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
                   2936: more information.</p>
                   2937: </div>
                   2938: </div>
                   2939: <div class="sect1" lang="en">
                   2940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2941: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2942: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2943:     create a CD-ROM set of the resulting binary packages to assist
                   2944:     in installing packages on other machines.  The
                   2945:     <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
                   2946:     a simple tool for creating the ISO 9660 images.
                   2947:     <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
                   2948:     way that keeps all the dependencies for a given package on the same
                   2949:     CD as that package.</p>
                   2950: <div class="sect2" lang="en">
                   2951: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2952: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2953: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2954:       man page. The following short example assumes that the binary
                   2955:       packages are left in
                   2956:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2957:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2958:       hold the ISO 9660 images.</p>
                   2959: <pre class="screen">
                   2960: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2961: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2962: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2963:       </pre>
                   2964: <p>If you wish to include a common set of files
                   2965:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2966:       etc.) on each CD in the collection, then you need to create a
                   2967:       directory which contains these files. e.g.</p>
                   2968: <pre class="screen">
                   2969: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2970: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2971: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2972: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2973: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2974: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2975: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2976:       </pre>
                   2977: <p>Now create the images:</p>
                   2978: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   2979: <p>Each image will contain <code class="filename">README</code>,
                   2980:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2981:       in their root directories.</p>
                   2982: </div>
                   2983: </div>
                   2984: </div>
                   2985: <div class="chapter" lang="en">
                   2986: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   2987: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2988: <div class="toc">
                   2989: <p><b>Table of Contents</b></p>
                   2990: <dl>
1.6       rillig   2991: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2992: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1       dsieger  2993: </dl>
                   2994: </div>
                   2995: <p>The files that are installed by pkgsrc are organized in a way that
                   2996: is similar to what you find in the <code class="filename">/usr</code> directory
                   2997: of the base system. But some details are different. This is because
                   2998: pkgsrc initially came from FreeBSD and had adopted its file system
                   2999: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3000: which operating system you are using pkgsrc with, you can expect the
                   3001: same layout for pkgsrc.</p>
                   3002: <p>There are mainly four root directories for pkgsrc, which are all
                   3003: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3004: When pkgsrc has been installed as root, the default locations
                   3005: are:</p>
                   3006: <pre class="programlisting">
                   3007: LOCALBASE=              /usr/pkg
                   3008: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3009: VARBASE=                /var
                   3010: PKG_DBDIR=              /var/db/pkg
                   3011: </pre>
                   3012: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3013: user), the default locations are:</p>
                   3014: <pre class="programlisting">
                   3015: LOCALBASE=              ${HOME}/pkg
                   3016: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3017: VARBASE=                ${HOME}/pkg/var
                   3018: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3019: </pre>
                   3020: <p>What these four directories are for, and what they look like is
                   3021: explained below.</p>
                   3022: <div class="itemizedlist"><ul type="disc">
                   3023: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3024: <code class="filename">/usr</code> directory in the base system. It is the
                   3025: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3026: the well-known subdirectories like <code class="filename">bin</code>,
                   3027: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3028: <code class="filename">share</code> and
                   3029: <code class="filename">sbin</code>.</p></li>
                   3030: <li><p><code class="varname">VARBASE</code> corresponds to
                   3031: <code class="filename">/var</code> in the base system. Some programs (especially
                   3032: games, network daemons) need write access to it during normal
                   3033: operation.</p></li>
                   3034: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3035: <code class="filename">/etc</code> in the base system. It contains configuration
1.4       rillig   3036: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  3037: itself.</p></li>
                   3038: </ul></div>
                   3039: <div class="sect1" lang="en">
                   3040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3041: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3042: </h2></div></div></div>
                   3043: <p>The following directories exist in a typical pkgsrc installation
                   3044: in <code class="filename">${LOCALBASE}</code>.</p>
                   3045: <div class="variablelist"><dl>
                   3046: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3047: <dd><p>Contains executable programs that are intended to be
                   3048: directly used by the end user.</p></dd>
                   3049: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3050: <dd><p>Contains files for the emulation layers of various other
                   3051: operating systems, especially for
                   3052: NetBSD.</p></dd>
                   3053: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3054: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3055: <dd><p>Contains
                   3056: the configuration files.</p></dd>
                   3057: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3058: <dd><p>Contains headers for the C and C++ programming
                   3059: languages.</p></dd>
                   3060: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3061: <dd><p>Contains GNU info files of various
                   3062: packages.</p></dd>
                   3063: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3064: <dd><p>Contains shared and static
                   3065: libraries.</p></dd>
                   3066: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3067: <dd><p>Contains data files that don't change after
                   3068: installation. Other data files belong into
                   3069: <code class="filename">${VARBASE}</code>.</p></dd>
                   3070: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3071: <dd><p>Contains programs that are not intended to be used by
                   3072: end users, such as helper programs or network
                   3073: daemons.</p></dd>
                   3074: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3075: <dd><p>Contains programs that are intended to be executed as
                   3076: CGI scripts by a web server.</p></dd>
                   3077: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3078: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3079: <dd><p>Contains brief
                   3080: documentation in form of manual pages.</p></dd>
                   3081: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3082: <dd><p>Contains programs that are intended to be used only by
                   3083: the super-user.</p></dd>
                   3084: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3085: <dd><p>Contains platform-independent data files that don't
                   3086: change after installation.</p></dd>
                   3087: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3088: <dd><p>Contains documentation files provided by the
                   3089: packages.</p></dd>
                   3090: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3091: <dd><p>Contains example files provided by the packages. Among
                   3092: others, the original configuration files are saved here and copied to
                   3093: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3094: installation.</p></dd>
                   3095: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3096: <dd><p>Contains the original files for rc.d
                   3097: scripts.</p></dd>
                   3098: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3099: <code class="filename">${VARBASE}</code>)</span></dt>
                   3100: <dd><p>Contains files
                   3101: that may be modified after
                   3102: installation.</p></dd>
                   3103: </dl></div>
                   3104: </div>
                   3105: <div class="sect1" lang="en">
                   3106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3107: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3108: </h2></div></div></div>
                   3109: <div class="variablelist"><dl>
                   3110: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3111: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3112: <dd><p>Contains
                   3113: information about the currently installed
                   3114: packages.</p></dd>
                   3115: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3116: <dd><p>Contains highscore
                   3117: files.</p></dd>
                   3118: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3119: <dd><p>Contains log files.</p></dd>
                   3120: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3121: <dd><p>Contains informational files about daemons that are
                   3122: currently running.</p></dd>
                   3123: </dl></div>
                   3124: </div>
                   3125: </div>
                   3126: <div class="chapter" lang="en">
                   3127: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3128: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3129: <div class="toc">
                   3130: <p><b>Table of Contents</b></p>
                   3131: <dl>
1.6       rillig   3132: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3133: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3134: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3135: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3136: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3137: <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>
                   3138: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
                   3139: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
                   3140: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   3141: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
1.1       dsieger  3142: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.6       rillig   3143: <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>
                   3144: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3145: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3146: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   3147: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   3148: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   3149: <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.1       dsieger  3150: </dl>
                   3151: </div>
                   3152: <p>This section contains hints, tips &amp; tricks on special things in
                   3153: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3154: it contains items for both pkgsrc users and developers.</p>
                   3155: <div class="sect1" lang="en">
                   3156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3157: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3158: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3159: <div class="itemizedlist"><ul type="disc">
1.4       rillig   3160: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  3161:          This is a general purpose list for most issues regarding
                   3162:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3163:          for pkgsrc configuration, unexpected build failures, using
                   3164:          particular packages, upgrading pkgsrc installations,
                   3165:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3166:          proposals for changes that impact the pkgsrc user community,
                   3167:          e.g. major infrastructure changes, new features, package
                   3168:          removals, etc., may also be posted.</p></li>
1.4       rillig   3169: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  3170:          A list where the results of pkgsrc bulk builds are sent and
                   3171:          discussed.</p></li>
1.4       rillig   3172: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  3173:          This list is for those who are interested in getting a
                   3174:          commit message for every change committed to pkgsrc. It is
                   3175:          also available in digest form, meaning one daily message
                   3176:          containing all commit messages for changes to the package
                   3177:          source tree in that 24 hour period.</p></li>
                   3178: </ul></div>
                   3179: <p>To subscribe, do:</p>
                   3180: <pre class="programlisting">
                   3181: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3182: </pre>
                   3183: <p>Archives for all these mailing lists are available from
                   3184: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
                   3185: </div>
                   3186: <div class="sect1" lang="en">
                   3187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3188: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3189: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3190: pkgviews User's guide in
                   3191: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3192: </div>
                   3193: <div class="sect1" lang="en">
                   3194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3195: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3196: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3197: a number of useful utilities for both users and developers of pkgsrc.  This
                   3198: section attempts only to make the reader aware of the utilities and when
                   3199: they might be useful, and not to duplicate the documentation that comes
                   3200: with each package.</p>
                   3201: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
                   3202: <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>:
                   3203:       Symlinks for use by buildlink.</p></li></ul></div>
                   3204: <p>OS tool augmentation (automatically installed when needed):</p>
                   3205: <div class="itemizedlist"><ul type="disc">
                   3206: <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>:
                   3207:       Calculates various kinds of checksums (including SHA1).</p></li>
                   3208: <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>:
                   3209:       Compatibility library for pkgsrc tools.</p></li>
                   3210: <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
                   3211:       non-BSD systems due to lack of native mtree.</p></li>
                   3212: <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>:
                   3213:       Up-to-date replacement for
                   3214:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3215:       systems where pkg_install is not present.</p></li>
                   3216: </ul></div>
                   3217: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3218: <div class="itemizedlist"><ul type="disc">
                   3219: <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>:
                   3220:       Create a binary package from an
                   3221:       already-installed package.  Used by <span><strong class="command">make replace</strong></span> to
                   3222:       save the old package.</p></li>
                   3223: <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>:
                   3224:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3225:       from multiple locations. It currently supports the following
                   3226:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
                   3227: <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
                   3228:       packages someplace else (enabled by default).</p></li>
                   3229: <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 the
                   3230:       best compiler flags to optimise code for your current CPU and
                   3231:       compiler.</p></li>
                   3232: </ul></div>
                   3233: <p>Utilities for keeping track of installed packages, being up to date,
                   3234: etc:</p>
                   3235: <div class="itemizedlist"><ul type="disc">
                   3236: <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
                   3237:       packages whose installed versions do not match the latest pkgsrc
                   3238:       entries.</p></li>
                   3239: <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
                   3240:       dependency graphs of packages, to aid in choosing a strategy for
                   3241:       updating.</p></li>
                   3242: <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
                   3243:       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>
                   3244: <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
                   3245:       pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
                   3246:       does various checks on the complete pkgsrc system.</p></li>
                   3247: <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
                   3248:       packages you have installed.</p></li>
                   3249: </ul></div>
                   3250: <p>Utilities for people maintaining or creating individual packages:</p>
                   3251: <div class="itemizedlist"><ul type="disc">
                   3252: <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
                   3253:       making and maintaining patches for a package (includes pkgdiff,
                   3254:       pkgvi, mkpatches, etc.).</p></li>
                   3255: <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>,
                   3256:       <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
                   3257:       converting to pkgsrc.</p></li>
                   3258: <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
                   3259:       pkgsrc to a Solaris package.</p></li>
                   3260: </ul></div>
                   3261: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3262: utilities)</p>
                   3263: <div class="itemizedlist"><ul type="disc">
                   3264: <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
                   3265:       packages in a chrooted area.</p></li>
                   3266: <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
                   3267:       kernel version for chrooted cross builds.</p></li>
                   3268: </ul></div>
                   3269: </div>
                   3270: <div class="sect1" lang="en">
                   3271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3272: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3273: <p>If you want to use pkgsrc as non-root user, you can set some
                   3274: variables to make pkgsrc work under these conditions.  At the very least,
                   3275: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3276: will turn on unprivileged mode and set multiple related variables to allow
                   3277: installation of packages as non-root.</p>
                   3278: <p>In case the defaults are not enough, you may want to tune some other
                   3279: variables used.  For example, if the automatic user/group detection leads
                   3280: to incorrect values (or not the ones you would like to use), you can change
                   3281: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3282: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3283: <p>As regards bootstrapping, please note that the
                   3284: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
                   3285: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
                   3286: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3287: installation targets.  These directories can be overridden by the
                   3288: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3289: that allow finer tuning of the tree layout.</p>
                   3290: </div>
                   3291: <div class="sect1" lang="en">
                   3292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3293: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3294: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3295: enable this feature by adding the option
                   3296: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.4       rillig   3297: <a href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3298: distfile is found, pkgsrc will try to resume it.</p>
                   3299: <p>You can also
                   3300: use a different program than the default <a 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
                   3301: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3302: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3303: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3304: values.</p>
                   3305: <p>For example, if you want to use
                   3306: <code class="filename">wget</code> to resume downloads, you'll have to use something
                   3307: like:</p>
                   3308: <pre class="programlisting">
                   3309: FETCH_CMD=             wget
                   3310: FETCH_BEFORE_ARGS=     --passive-ftp
                   3311: FETCH_RESUME_ARGS=     -c
                   3312: FETCH_OUTPUT_ARGS=     -O
                   3313: </pre>
                   3314: </div>
                   3315: <div class="sect1" lang="en">
                   3316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3317: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   3318: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3319: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3320: you will have to add the following line into
1.4       rillig   3321: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3322: <pre class="programlisting">
1.4       rillig   3323: X11_TYPE=modular
1.1       dsieger  3324: </pre>
                   3325: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3326: <h3 class="title">Note</h3>
1.4       rillig   3327: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3328: </p>
1.1       dsieger  3329: </div>
                   3330: </div>
                   3331: <div class="sect1" lang="en">
                   3332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3333: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3334: <p>If you are sitting behind a firewall which does not allow direct
                   3335: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3336: relevant proxy hosts.  This is done using an environment variable in the
                   3337: form of a URL, e.g. in Amdahl, the machine
                   3338: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3339: port 80 as the proxy port number.  So the proxy environment variables
                   3340: are:</p>
                   3341: <pre class="programlisting">
                   3342: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3343: http_proxy=http://orpheus.amdahl.com:80/
                   3344: </pre>
                   3345: </div>
                   3346: <div class="sect1" lang="en">
                   3347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3348: <a name="passive-ftp"></a>9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1       dsieger  3349: <p>This depends on which utility is used to retrieve distfiles.  From
                   3350: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3351: the first available command from the following list:</p>
                   3352: <div class="itemizedlist"><ul type="disc">
                   3353: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3354: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
                   3355: </ul></div>
                   3356: <p>On a default NetBSD installation, this will be
                   3357: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3358: connections first, and falls back to active connections if the server
                   3359: refuses to do passive.  For the other tools, add the following to your
1.4       rillig   3360: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3361: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3362: <p>Having that option present will prevent
                   3363: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3364: transfers.</p>
                   3365: </div>
                   3366: <div class="sect1" lang="en">
                   3367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3368: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3369: <p>You would like to download all the distfiles in a single batch
                   3370: from work or university, where you can't run a <span><strong class="command">make
                   3371: fetch</strong></span>.  There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
                   3372: but downloading the entire directory may not be appropriate.</p>
                   3373: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
                   3374: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3375: resulting list to your machine at work/school and use it there.  If you
                   3376: don't have a NetBSD-compatible <a 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
                   3377: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3378: URL:</p>
                   3379: <p>At home:</p>
                   3380: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3381: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3382: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3383: <p>At work:</p>
                   3384: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3385: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3386: home.</p>
                   3387: <p>If you have a machine running NetBSD, and you want to get
                   3388: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3389: machine architecture), you can do so by using the above-mentioned
                   3390: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
                   3391: directly by running:</p>
                   3392: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3393: <p>If you even decide to ignore
                   3394: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3395: by running:</p>
                   3396: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3397: </div>
                   3398: <div class="sect1" lang="en">
                   3399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3400: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.1       dsieger  3401: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
                   3402: <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>
                   3403: package, you get the error from make that it doesn't know how to make
                   3404: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
                   3405: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3406: the NetBSD base distribution on your machine.  It is recommended to do
                   3407: that to format man pages.</p>
                   3408: <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
                   3409: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.4       rillig   3410: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3411: </div>
                   3412: <div class="sect1" lang="en">
                   3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3414: <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.1       dsieger  3415: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3416: when you installed your NetBSD machine.  Please get and install it, by
                   3417: extracting it in <code class="filename">/</code>:</p>
                   3418: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3419: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3420: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
                   3421: the one that corresponds to your release (determine via <span><strong class="command">uname
                   3422: -r</strong></span>).</p>
                   3423: </div>
                   3424: <div class="sect1" lang="en">
                   3425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3426: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3427: <p>When installing packages as non-root user and using the just-in-time
                   3428: <a 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
                   3429: password for each required package installed.  To avoid this, the sudo
                   3430: package can be used, which does password caching over a limited time.  To
                   3431: use it, install sudo (either as binary package or from
                   3432: <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.4       rillig   3433: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3434: <span class="emphasis"><em>after</em></span> the definition of the
                   3435: <code class="varname">LOCALBASE</code> variable:</p>
                   3436: <pre class="programlisting">
                   3437: .if exists(${LOCALBASE}/bin/sudo)
                   3438: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3439: .endif
                   3440: </pre>
                   3441: </div>
                   3442: <div class="sect1" lang="en">
                   3443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3444: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3445: <p>As the system administrator, you can choose where configuration files
                   3446: are installed.  The default settings make all these files go into
                   3447: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3448: be suboptimal depending on your expectations (e.g., a read-only,
                   3449: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3450: configuration of the provided packages).</p>
                   3451: <p>In order to change the defaults, you can modify the
                   3452: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.4       rillig   3453: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3454: directory; some common examples include <code class="filename">/etc</code> or
                   3455: <code class="filename">/etc/pkg</code>.</p>
                   3456: <p>Furthermore, you can change this value on a per-package basis by
                   3457: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3458: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3459: package you would like to modify, that is, the contents of
                   3460: <code class="varname">PKGBASE</code>.</p>
                   3461: <p>Note that after changing these settings, you must rebuild and
                   3462: reinstall any affected packages.</p>
                   3463: </div>
                   3464: <div class="sect1" lang="en">
                   3465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3466: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3467: <p>Please be aware that there can often be bugs in third-party software,
                   3468: and some of these bugs can leave a machine vulnerable to exploitation by
                   3469: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3470: maintains a database of known-exploits to packages which have at one time
                   3471: been included in pkgsrc.  The database can be downloaded automatically, and
                   3472: a security audit of all packages installed on a system can take place.  To
                   3473: do this, install the <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> package.  It has two
                   3474: components:</p>
                   3475: <div class="orderedlist"><ol type="1">
                   3476: <li>
                   3477: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
                   3478:     download a list of the security vulnerabilities information.  This list
                   3479:     is kept up to date by the NetBSD security officer and the NetBSD
                   3480:     packages team, and is distributed from the NetBSD ftp server:</p>
                   3481: <p><a 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>
                   3482: </li>
                   3483: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
                   3484:     current machine, checking each vulnerability which is known.  If a
                   3485:     vulnerable package is installed, it will be shown by output to stdout,
                   3486:     including a description of the type of vulnerability, and a URL
                   3487:     containing more information.</p></li>
                   3488: </ol></div>
                   3489: <p>Use of the <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>
                   3490: package is strongly recommended!  After
                   3491: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3492: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3493: audit-packages</code></strong>.</p>
                   3494: <p>If this package is installed, pkgsrc builds will use it to
                   3495: perform a security check before building any package.  See <a 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
                   3496: check.</p>
                   3497: </div>
                   3498: <div class="sect1" lang="en">
                   3499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3500: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  3501: <p>When you add your own preferences to the
                   3502:        <code class="varname">CFLAGS</code> variable in your
1.4       rillig   3503:        <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3504:        environment variables to the <code class="filename">./configure</code>
                   3505:        scripts and to <a 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
                   3506:        <code class="varname">CFLAGS</code> from the environment variable by
                   3507:        overriding them in the <code class="filename">Makefile</code>s of their
                   3508:        package.</p>
                   3509: <p>Currently there is no solution to this problem. If you
                   3510:        really need the package to use your <code class="varname">CFLAGS</code>
                   3511:        you should run <span><strong class="command">make patch</strong></span> in the package
                   3512:        directory and then inspect any <code class="filename">Makefile</code> and
                   3513:        <code class="filename">Makefile.in</code> for whether they define
                   3514:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3515:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3516:        programmers write so bad code that it only works for the
                   3517:        specific combination of <code class="varname">CFLAGS</code> they have
                   3518:        chosen.</p>
                   3519: </div>
                   3520: <div class="sect1" lang="en">
                   3521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3522: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.1       dsieger  3523: <div class="procedure"><ol type="1">
                   3524: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3525:        case that occurs often is that people only update pkgsrc in
                   3526:        parts, because of performance reasons. Since pkgsrc is one large
                   3527:        system, not a collection of many small systems, there are
                   3528:        sometimes changes that only work when the whole pkgsrc tree is
                   3529:        updated.</p></li>
                   3530: <li><p>Make sure that you don't have any CVS conflicts.
                   3531:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3532:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3533:        files.</p></li>
                   3534: <li><p>Make sure that you don't have old copies of the packages
                   3535:        extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
                   3536:        verify this.</p></li>
                   3537: <li><p>If the problem still exists, write a mail to the
                   3538:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3539: </ol></div>
                   3540: </div>
                   3541: <div class="sect1" lang="en">
                   3542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3543: <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.1       dsieger  3544: <p>You have modified a file from pkgsrc, and someone else has
                   3545: modified that same file afterwards in the CVS repository. Both changes
                   3546: are in the same region of the file, so when you updated pkgsrc, the
                   3547: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3548: file. Because of these markers, the file is no longer a valid
                   3549: <code class="filename">Makefile</code>.</p>
                   3550: <p>Have a look at that file, and if you don't need your local changes
                   3551: anymore, you can remove that file and run <span><strong class="command">cvs -q update
                   3552: -dP</strong></span> in that directory to download the current version.</p>
                   3553: </div>
                   3554: </div>
                   3555: </div>
                   3556: <div class="part" lang="en">
                   3557: <div class="titlepage"><div><div><h1 class="title">
                   3558: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
                   3559: <div class="partintro" lang="en">
                   3560: <div></div>
                   3561: <p>This part of the book deals with creating and
                   3562:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3563:        guide on creating a new package. The remaining chapters are more
                   3564:        like a reference manual for pkgsrc.</p>
                   3565: <div class="toc">
                   3566: <p><b>Table of Contents</b></p>
                   3567: <dl>
1.6       rillig   3568: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3569: <dd><dl>
1.6       rillig   3570: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3571: <dd><dl>
1.6       rillig   3572: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3573: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1       dsieger  3574: </dl></dd>
1.6       rillig   3575: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3576: <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>
                   3577: </dl></dd>
                   3578: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3579: <dd><dl>
                   3580: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3581: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
                   3582: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3583: <dd><dl>
                   3584: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3585: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3586: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3587: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3588: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3589: </dl></dd>
                   3590: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3591: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3592: <dd><dl>
                   3593: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3594: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3595: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3596: </dl></dd>
                   3597: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3598: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
                   3599: </dl></dd>
                   3600: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3601: <dd><dl>
                   3602: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
                   3603: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3604: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3605: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3606: <dd><dl>
                   3607: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3608: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3609: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3610: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3611: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3612: </dl></dd>
                   3613: </dl></dd>
                   3614: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3615: <dd><dl>
                   3616: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
                   3617: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3618: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   3619: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3620: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
                   3621: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3622: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3623: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3624: </dl></dd>
                   3625: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3626: <dd><dl>
                   3627: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
                   3628: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3629: <dd><dl>
                   3630: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3631: <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>
                   3632: </dl></dd>
                   3633: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3634: <dd><dl>
                   3635: <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>
                   3636: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3637: </dl></dd>
                   3638: </dl></dd>
                   3639: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3640: <dd><dl>
                   3641: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3642: <dd><dl>
                   3643: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3644: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3645: </dl></dd>
                   3646: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3647: <dd><dl>
                   3648: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3649: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3650: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3651: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3652: </dl></dd>
                   3653: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3654: <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>
                   3655: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3656: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3657: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3658: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3659: <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>
                   3660: </dl></dd>
                   3661: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3662: <dd><dl>
                   3663: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3664: <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>
                   3665: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3666: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3667: </dl></dd>
                   3668: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3669: <dd><dl>
                   3670: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3671: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3672: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3673: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
                   3674: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3675: <dd><dl>
                   3676: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3677: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3678: </dl></dd>
                   3679: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3680: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3681: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3682: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3683: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3684: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3685: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3687: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3688: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3689: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3690: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3691: </dl></dd>
                   3692: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3693: <dd><dl>
                   3694: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3695: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3696: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3697: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3698: </dl></dd>
                   3699: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3700: <dd><dl>
                   3701: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3702: <dd><dl>
                   3703: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
                   3704: <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>
                   3705: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3706: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3707: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3708: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3709: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3710: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3711: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3712: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3713: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3714: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3715: </dl></dd>
                   3716: <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>
                   3717: <dd><dl>
                   3718: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3719: <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>
                   3720: </dl></dd>
                   3721: <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>
                   3722: <dd><dl>
                   3723: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3724: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3725: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3726: </dl></dd>
                   3727: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3728: <dd><dl>
                   3729: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3730: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3731: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3732: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3733: </dl></dd>
                   3734: <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>
                   3735: <dd><dl>
                   3736: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3737: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
                   3738: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3739: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3740: </dl></dd>
                   3741: <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>
                   3742: <dd><dl>
                   3743: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3745: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3746: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3747: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3748: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3749: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3750: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3751: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig   3752: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   3753: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3754: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3755: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3756: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3757: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3758: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3759: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3761:     emulation</a></span></dt>
1.6       rillig   3762: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3763: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3764: </dl></dd>
1.6       rillig   3765: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3766: </dl></dd>
1.6       rillig   3767: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3768: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3769: <dd><dl>
1.6       rillig   3770: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3771: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3772: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3773: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3774: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   3775: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                   3776: </dl></dd>
                   3777: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3778: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3779: <dd><dl>
                   3780: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3781: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3782: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3783: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3784: </dl></dd>
                   3785: </dl>
                   3786: </div>
                   3787: </div>
                   3788: <div class="chapter" lang="en">
                   3789: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3790: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3791: <div class="toc">
                   3792: <p><b>Table of Contents</b></p>
                   3793: <dl>
1.6       rillig   3794: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3795: <dd><dl>
1.6       rillig   3796: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3797: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1       dsieger  3798: </dl></dd>
1.6       rillig   3799: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3800: <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.1       dsieger  3801: </dl>
                   3802: </div>
                   3803: <p>When you find a package that is not yet in pkgsrc, you
                   3804: most likely have a URL from where you can download the source
                   3805: code. Starting with this URL, creating a package involves only a
                   3806: few steps.</p>
                   3807: <div class="procedure"><ol type="1">
                   3808: <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>
                   3809: <li><p>Then, choose one of the top-level directories as the
                   3810: category in which you want to place your package. You can also create a
                   3811: directory of your own (maybe called <code class="filename">local</code>). In that
                   3812: category directory, create another directory for your package and change
                   3813: into it.</p></li>
                   3814: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
                   3815: you for a URL. Enter the URL of the distribution file (in most cases a
                   3816: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3817: of your package are created automatically. The distribution file is
                   3818: extracted automatically to fill in some details in the
                   3819: <code class="filename">Makefile</code> that would otherwise have to be done
                   3820: manually.</p></li>
                   3821: <li>
                   3822: <p>Examine the extracted files to determine the dependencies of
                   3823: your package. Ideally, this is mentioned in some
                   3824: <code class="filename">README</code> file, but things may differ. For each of
                   3825: these dependencies, look where it exists in pkgsrc, and if there is a
                   3826: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3827: line to your package <code class="filename">Makefile</code> which includes that
                   3828: file just before the last line. If the
                   3829: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3830: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3831: version of the dependency and where it can be found in pkgsrc. This line
                   3832: should be placed in the third paragraph. If the dependency is only
                   3833: needed for building the package, but not when using it, use
                   3834: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3835: Your package may then look like this:</p>
                   3836: <pre class="programlisting">
                   3837: [...]
                   3838: 
                   3839: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3840: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3841: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3842: 
                   3843: [...]
                   3844: 
                   3845: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3846: .include "../../devel/glib2/buildlink3.mk"
                   3847: .include "../../mk/bsd.pkg.mk"
                   3848: </pre>
                   3849: </li>
                   3850: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
                   3851: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
                   3852: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
                   3853: --explain</strong></span> or <span><strong class="command">pkglint
                   3854: -e</strong></span>, which outputs additional
                   3855: explanations.</p></li>
                   3856: <li><p>In many cases the package is not yet ready to build. You can
1.6       rillig   3857: find instructions for the most common cases in the next section, <a 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.1       dsieger  3858: over there, you can hopefully continue here.</p></li>
                   3859: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
                   3860: directory from the extracted files. Besides these files, a lot of cache
                   3861: files and other system information has been saved in the working
                   3862: directory, which may become wrong after you edited the
                   3863: <code class="filename">Makefile</code>.</p></li>
                   3864: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
1.6       rillig   3865: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.1       dsieger  3866: <li><p>When the package builds fine, the next step is to install
                   3867: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
                   3868: everything works.</p></li>
                   3869: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3870: contains a list of the files that are installed by the package, is
                   3871: nearly empty. Run <span><strong class="command">bmake print-PLIST
                   3872: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3873: the file using your preferred text editor to see if the list of
                   3874: files looks plausible.</p></li>
                   3875: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
                   3876: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   3877: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
                   3878: has been registered in the database of installed files, but with an
                   3879: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
                   3880: and <span><strong class="command">bmake install</strong></span> again. Now the package is
                   3881: registered with the list of files from
                   3882: <code class="filename">PLIST</code>.</p></li>
                   3883: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
                   3884: package from the set of installed files.</p></li>
                   3885: </ol></div>
                   3886: <div class="sect1" lang="en">
                   3887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3888: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1       dsieger  3889: <div class="sect2" lang="en">
                   3890: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3891: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3892: <p>Simple Perl modules are handled automatically by
                   3893: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
                   3894: </div>
                   3895: <div class="sect2" lang="en">
                   3896: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3897: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  3898: <p>KDE applications should always include
                   3899: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3900: settings that are typical of KDE packages.</p>
                   3901: </div>
                   3902: </div>
                   3903: <div class="sect1" lang="en">
                   3904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3905: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1       dsieger  3906: <div class="sect2" lang="en">
                   3907: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3908: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1       dsieger  3909: <div class="sect3" lang="en">
                   3910: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3911: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3912: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   3913: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   3914: pkgsrc. As the description says it has to do with the web, the obvious
                   3915: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   3916: <pre class="programlisting">
                   3917: <code class="prompt">$</code> mkdir www/nvu
                   3918: <code class="prompt">$</code> cd www/nvu
                   3919: </pre>
                   3920: <p>The web site says that the sources are available as a tar file, so
                   3921: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
                   3922: <pre class="programlisting">
                   3923: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3924: </pre>
                   3925: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3926: below the <code class="varname">DISTNAME</code> line, as the package name should
                   3927: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   3928: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3929: <code class="varname">COMMENT</code> fields. Then the package
                   3930: <code class="filename">Makefile</code> looked like that:</p>
                   3931: <pre class="programlisting">
                   3932: # $NetBSD$
                   3933: #
                   3934: 
                   3935: DISTNAME=       nvu-1.0-sources
                   3936: PKGNAME=        nvu-1.0
                   3937: CATEGORIES=     www
                   3938: MASTER_SITES=   http://cvs.nvu.com/download/
                   3939: EXTRACT_SUFX=   .tar.bz2
                   3940: 
                   3941: MAINTAINER=     rillig@NetBSD.org
                   3942: HOMEPAGE=       http://cvs.nvu.com/
                   3943: COMMENT=        Web Authoring System
                   3944: 
                   3945: # url2pkg-marker (please do not remove this line.)
                   3946: .include "../../mk/bsd.pkg.mk"
                   3947: </pre>
                   3948: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3949: source archive:</p>
                   3950: <pre class="programlisting">
                   3951: url2pkg&gt; Running "make makesum" ...
                   3952: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3953: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3954: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3955: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3956: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3957: url2pkg&gt; Running "make extract" ...
                   3958: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3959: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3960: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3961: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3962: ===&gt; Installing dependencies for nvu-1.0
                   3963: ===&gt; Overriding tools for nvu-1.0
                   3964: ===&gt; Extracting for nvu-1.0
                   3965: url2pkg&gt; Adjusting the Makefile.
                   3966: 
                   3967: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   3968: 
                   3969: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   3970: </pre>
                   3971: </div>
                   3972: <div class="sect3" lang="en">
                   3973: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3974: <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.1       dsieger  3975: <p>Now that the package has been extracted, let's see what's inside
                   3976: it. The package has a <code class="filename">README.txt</code>, but that only
                   3977: says something about mozilla, so it's probably useless for seeing what
                   3978: dependencies this package has. But since there is a GNU configure script
                   3979: in the package, let's hope that it will complain about everything it
                   3980: needs.</p>
                   3981: <pre class="programlisting">
                   3982: <code class="prompt">$</code> bmake
                   3983: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3984: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3985: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3986: ===&gt; Patching for nvu-1.0
                   3987: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3988: ===&gt; Configuring for nvu-1.0
                   3989: [...]
                   3990: configure: error: Perl 5.004 or higher is required.
                   3991: [...]
                   3992: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3993: [...]
                   3994: </pre>
                   3995: <p>That worked quite well. So I opened the package Makefile in my
                   3996: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   3997: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   3998: package have changed now, and since a perl wrapper is automatically
                   3999: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4000: from scratch.</p>
                   4001: <pre class="programlisting">
                   4002: <code class="prompt">$</code> bmake clean
                   4003: ===&gt; Cleaning for nvu-1.0
                   4004: <code class="prompt">$</code> bmake
                   4005: [...]
                   4006: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4007: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4008: [...]
                   4009: </pre>
                   4010: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4011: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4012: <pre class="programlisting">
                   4013: [...]
                   4014: checking for GTK - version &gt;= 1.2.0... no
                   4015: *** Could not run GTK test program, checking why...
                   4016: [...]
                   4017: </pre>
                   4018: <p>Now to the other dependencies. The first question is: Where is the
                   4019: GTK package hidden in pkgsrc?</p>
                   4020: <pre class="programlisting">
                   4021: <code class="prompt">$</code> echo ../../*/gtk*
                   4022: [many packages ...]
                   4023: <code class="prompt">$</code> echo ../../*/gtk
                   4024: ../../x11/gtk
                   4025: <code class="prompt">$</code> echo ../../*/gtk2
                   4026: ../../x11/gtk2
                   4027: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4028: ../../x11/gtk2/buildlink3.mk
                   4029: </pre>
                   4030: <p>The first try was definitely too broad. The second one had exactly
                   4031: one result, which is very good. But there is one pitfall with GNOME
                   4032: packages. Before GNOME 2 had been released, there were already many
                   4033: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4034: packages, the GNOME 2 packages were imported as separate packages, and
                   4035: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4036: whether this was the case here, and indeed it was.</p>
                   4037: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4038: file, adding the dependency is very easy. I just inserted an
                   4039: <code class="literal">.include</code> line before the last line of the package
                   4040: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4041: <pre class="programlisting">
                   4042: [...]
                   4043: .include "../../x11/gtk2/buildlink3.mk"
                   4044: .include "../../mk/bsd.pkg.mk
                   4045: </pre>
                   4046: <p>After another <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span>, the answer
                   4047: was:</p>
                   4048: <pre class="programlisting">
                   4049: [...]
                   4050: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4051: checking for GTK - version &gt;= 1.2.0... no
                   4052: *** Could not run GTK test program, checking why...
                   4053: *** The test program failed to compile or link. See the file config.log for the
                   4054: *** exact error that occured. This usually means GTK was incorrectly installed
                   4055: *** or that you have moved GTK since it was installed. In the latter case, you
                   4056: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4057: configure: error: Test for GTK failed.
                   4058: [...]
                   4059: </pre>
                   4060: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4061: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4062: told me that this package really wanted to have the GNOME 1 version of
                   4063: GTK. If the package had looked for GTK2, it would have looked for
                   4064: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
                   4065: So I changed the <code class="literal">x11/gtk2</code> to
                   4066: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4067: and tried again.</p>
                   4068: <pre class="programlisting">
                   4069: [...]
                   4070: 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
                   4071: In file included from xpidl.c:42:
                   4072: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4073: In file included from xpidl.c:42:
                   4074: xpidl.h:132: error: parse error before "IDL_ns"
                   4075: [...]
                   4076: </pre>
                   4077: <p>The package still does not find all of its dependencies. Now the
                   4078: question is: Which package provides the
                   4079: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4080: <pre class="programlisting">
                   4081: <code class="prompt">$</code> echo ../../*/*idl*
                   4082: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4083: <code class="prompt">$</code> echo ../../*/*IDL*
                   4084: ../../net/libIDL
                   4085: </pre>
                   4086: <p>Let's take the one from the second try. So I included the
                   4087: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4088: again. But the error didn't change. After digging through some of the
                   4089: code, I concluded that the build process of the package was broken and
                   4090: couldn't have ever worked, but since the Mozilla source tree is quite
                   4091: large, I didn't want to fix it. So I added the following to the package
                   4092: <code class="filename">Makefile</code> and tried again:</p>
                   4093: <pre class="programlisting">
                   4094: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4095: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4096: </pre>
                   4097: <p>The latter line is needed because the package expects the library
                   4098: <code class="filename">libIDL.so</code>, but only
                   4099: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4100: wrapper to rewrite that on the fly.</p>
                   4101: <p>The next problem was related to a recent change of the FreeType
                   4102: 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>
                   4103: which patch files were relevant for this issue and copied them to the
                   4104: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4105: patches so that they applied cleanly and retried again. This time,
                   4106: everything worked.</p>
                   4107: </div>
                   4108: <div class="sect3" lang="en">
                   4109: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4110: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4111: <pre class="programlisting">
                   4112: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4113: [...]
                   4114: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4115: <code class="prompt">$</code> bmake deinstall
                   4116: <code class="prompt">$</code> bmake install
                   4117: </pre>
                   4118: </div>
                   4119: </div>
                   4120: </div>
                   4121: </div>
                   4122: <div class="chapter" lang="en">
                   4123: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4124: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4125: <div class="toc">
                   4126: <p><b>Table of Contents</b></p>
                   4127: <dl>
1.6       rillig   4128: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4129: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
                   4130: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4131: <dd><dl>
                   4132: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4133: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4134: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4135: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4136: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4137: </dl></dd>
                   4138: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4139: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4140: <dd><dl>
                   4141: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4142: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4143: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4144: </dl></dd>
1.6       rillig   4145: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4146: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  4147: </dl>
                   4148: </div>
                   4149: <p>Whenever you're preparing a package, there are a number of
                   4150: files involved which are described in the following
                   4151: sections.</p>
                   4152: <div class="sect1" lang="en">
                   4153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4154: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4155: </h2></div></div></div>
                   4156: <p>Building, installation and creation of a binary package are all
                   4157:   controlled by the package's <code class="filename">Makefile</code>.
                   4158:   The <code class="filename">Makefile</code> describes various things about
                   4159:   a package, for example from where to get it, how to configure,
                   4160:   build, and install it.</p>
                   4161: <p>A package <code class="filename">Makefile</code> contains several
                   4162:   sections that describe the package.</p>
                   4163: <p>In the first section there are the following variables, which
                   4164:   should appear exactly in the order given here.  The order and
                   4165:   grouping of the variables is mostly historical and has no further
                   4166:   meaning.</p>
                   4167: <div class="itemizedlist"><ul type="disc">
                   4168: <li><p><code class="varname">DISTNAME</code> is the basename of the
                   4169:     distribution file to be downloaded from the package's
                   4170:     website.</p></li>
                   4171: <li><p><code class="varname">PKGNAME</code> is the name of the
                   4172:     package, as used by pkgsrc. You only need to provide it if
                   4173:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4174:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4175:     directory name together with the version number. It must match the
                   4176:     regular expression
                   4177:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4178:     starts with a letter or digit, and contains only letters, digits,
                   4179:     dashes, underscores, dots and plus signs.</p></li>
                   4180: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4181:     the package file to create if the <code class="varname">PKGNAME</code>
                   4182:     isn't unique on a SVR4 system. The default is
                   4183:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4184:     <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
                   4185:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4186:     does not produce an unique package name on a SVR4 system.
                   4187:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4188:     characters.</p></li>
                   4189: <li>
                   4190: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4191:     which the package fits in. You can choose any of the top-level
                   4192:     directories of pkgsrc for it.</p>
                   4193: <p>Currently the following values are available for
                   4194:     <code class="varname">CATEGORIES</code>. If more than
                   4195:     one is used, they need to be separated by spaces:</p>
                   4196: <pre class="programlisting">
                   4197: archivers     cross         geography     meta-pkgs     security
                   4198: audio         databases     graphics      misc          shells
                   4199: benchmarks    devel         ham           multimedia    sysutils
                   4200: biology       editors       inputmethod   net           textproc
                   4201: cad           emulators     lang          news          time
                   4202: chat          finance       mail          parallel      wm
                   4203: comms         fonts         math          pkgtools      www
                   4204: converters    games         mbone         print         x11
                   4205: </pre>
                   4206: </li>
                   4207: <li><p><code class="varname">MASTER_SITES</code>,
                   4208:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4209:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4210:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.6       rillig   4211:     <a 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.1       dsieger  4212: </ul></div>
                   4213: <p>The second section contains information about separately
                   4214:   downloaded patches, if any.
                   4215:   </p>
                   4216: <div class="itemizedlist"><ul type="disc">
                   4217: <li><p><code class="varname">PATCHFILES:</code>
                   4218:     Name(s) of additional files that contain distribution patches.
                   4219:     There is no default. pkgsrc will look for them at
                   4220:     <code class="varname">PATCH_SITES</code>.
                   4221:     They will automatically be uncompressed before patching if
                   4222:     the names end with <code class="filename">.gz</code> or
                   4223:     <code class="filename">.Z</code>.</p></li>
                   4224: <li><p><code class="varname">PATCH_SITES</code>:
                   4225:     Primary location(s) for distribution patch files (see
                   4226:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4227: </ul></div>
                   4228: <p>The third section contains the following variables.
                   4229:   </p>
                   4230: <div class="itemizedlist"><ul type="disc">
                   4231: <li><p><code class="varname">MAINTAINER</code> is the email address
                   4232:     of the person who feels responsible for this package, and who is
                   4233:     most likely to look at problems or questions regarding this
                   4234:     package which have been reported with <a 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>. Other
                   4235:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4236:     making major changes to the package. When packaging a new program,
                   4237:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4238:     maintain the package for future updates, set it to
                   4239:     <code class="email">&lt;<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   4240: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   4241:     find more information about the package.</p></li>
                   4242: <li><p><code class="varname">COMMENT</code> is a one-line
                   4243:     description of the package (should not include the package
                   4244:     name).</p></li>
                   4245: </ul></div>
                   4246: <p>Other variables that affect the build:
                   4247:   </p>
                   4248: <div class="itemizedlist"><ul type="disc"><li>
                   4249: <p><code class="varname">WRKSRC</code>: The directory where the
                   4250:       interesting distribution files of the package are found. The
                   4251:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4252:       works for most packages.</p>
                   4253: <p>If a package doesn't create a subdirectory for itself
                   4254:       (most GNU software does, for instance), but extracts itself in
                   4255:       the current directory, you should set
                   4256:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4257: <p>If a package doesn't create a subdirectory with the
                   4258:       name of <code class="varname">DISTNAME</code> but some different name,
                   4259:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4260:       <code class="filename">${WRKDIR}</code>, for example
                   4261:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4262:       <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>
                   4263: <p>The name of the working directory created by pkgsrc is
                   4264:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4265:       variable. By default, its value is
                   4266:       <code class="filename">work</code>. If you want to use the same
                   4267:       pkgsrc tree for building different kinds of binary packages,
                   4268:       you can change the variable according to your needs. Two
                   4269:       other variables handle common cases of setting
                   4270:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4271:       <code class="varname">OBJHOSTNAME</code> is defined in
1.4       rillig   4272:       <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4273:       the host's name is attached to the directory name. If
                   4274:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4275:       is attached, which might look like
                   4276:       <code class="filename">work.i386</code> or
                   4277:       <code class="filename">work.sparc</code>.</p>
                   4278: </li></ul></div>
                   4279: <p>Please pay attention to the following gotchas:</p>
                   4280: <div class="itemizedlist"><ul type="disc">
                   4281: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   4282:       installed in compressed form by the package.  For packages using
                   4283:       BSD-style makefiles which honor MANZ, there is
                   4284:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   4285: <li><p>Replace <code class="filename">/usr/local</code> with
                   4286:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4287:       below).</p></li>
1.6       rillig   4288: <li><p>If the package installs any info files, see <a 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.1       dsieger  4289: </ul></div>
                   4290: </div>
                   4291: <div class="sect1" lang="en">
                   4292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4293: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4294: </h2></div></div></div>
                   4295: <p>The <code class="filename">distinfo</code> file contains the message
                   4296:   digest, or checksum, of each distfile needed for the package. This
                   4297:   ensures that the distfiles retrieved from the Internet have not been
                   4298:   corrupted during transfer or altered by a malign force to introduce
                   4299:   a security hole. Due to recent rumor about weaknesses of digest
                   4300:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4301:   message digests, as well as the file size.</p>
                   4302: <p>The <code class="filename">distinfo</code> file also contains the
                   4303:   checksums for all the patches found in the
1.6       rillig   4304:   <code class="filename">patches</code> directory (see <a href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.1       dsieger  4305: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   4306:   <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
                   4307:   command.</p>
                   4308: <p>Some packages have different sets of distfiles depending on
                   4309:   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
                   4310:   <code class="filename">distinfo</code> file and care should be taken when
                   4311:   upgrading such a package to ensure distfile information is not
                   4312:   lost.</p>
                   4313: </div>
                   4314: <div class="sect1" lang="en">
                   4315: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4316: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4317: <p>Many packages still don't work out-of-the box on the various
                   4318:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4319:   patch files are needed to make the package work. These patch files are
                   4320:   found in the <code class="filename">patches/</code> directory.</p>
                   4321: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4322:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   4323:   extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
                   4324:   order</a>, so <code class="filename">patch-aa</code> is applied before
                   4325:   <code class="filename">patch-ab</code>, etc.</p>
                   4326: <div class="sect2" lang="en">
                   4327: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4328: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4329: <p>The <code class="filename">patch-*</code> files should be in
                   4330:   <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
                   4331:   problems. (To force patches to apply with fuzz you can set
                   4332:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4333:   should contain only changes for a single file, and no file should be
                   4334:   patched by more than one patch file. This helps to keep future
                   4335:   modifications simple.</p>
                   4336: <p>Each patch file is structured as follows: In the first line,
                   4337:   there is the RCS Id of the patch itself. The second line should be
                   4338:   empty for aesthetic reasons. After that, there should be a comment for
                   4339:   each change that the patch does. There are a number of standard
                   4340:   cases:</p>
                   4341: <div class="itemizedlist"><ul type="disc">
                   4342: <li><p>Patches that replace the <code class="literal">==</code>
                   4343:   operator for <a 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
                   4344:   should contain a reference to , to avoid
                   4345:   redundant explanations.</p></li>
                   4346: <li><p>Patches for commonly known vulnerabilities should
                   4347:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4348: <li><p>Patches that change source code should mention the
                   4349:   platform and other environment (for example, the compiler) that the
                   4350:   patch is needed for.</p></li>
                   4351: </ul></div>
                   4352: <p>In all other cases, the patch should be commented so that any
                   4353:   developer who knows the code of the application can make some use of
                   4354:   the patch. Special care should be taken for the upstream developers,
                   4355:   since we generally want that they accept our patches, so we have less
                   4356:   work in the future.</p>
                   4357: </div>
                   4358: <div class="sect2" lang="en">
                   4359: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4360: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4361: <p>One important thing to mention is to pay attention that no RCS
                   4362:   IDs get stored in the patch files, as these will cause problems when
                   4363:   later checked into the NetBSD CVS tree. Use the
                   4364:   <span><strong class="command">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
                   4365:   problems.</p>
                   4366: <p>For even more automation, we recommend using
                   4367:   <span><strong class="command">mkpatches</strong></span> from the same package to make a
                   4368:   whole set of patches. You just have to backup files before you
                   4369:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   4370:   <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
                   4371:   using <span><strong class="command">pkgvi</strong></span> again from the same package. If
                   4372:   you upgrade a package this way, you can easily compare the new
                   4373:   set of patches with the previously existing one with
                   4374:   <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
                   4375:   or update from the <code class="filename">work/.newpatches</code>
                   4376:   directory to <code class="filename">patches/</code>.</p>
                   4377: <p>When you have finished a package, remember to generate
                   4378:   the checksums for the patch files by using the <span><strong class="command">make
1.6       rillig   4379:   makepatchsum</strong></span> command, see <a href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.1       dsieger  4380: <p>When adding a patch that corrects a problem in the
                   4381:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4382:   man pages should go), send the patch as a bug report to the
                   4383:   maintainer.  This benefits non-pkgsrc users of the package,
                   4384:   and usually makes it possible to remove the patch in future
                   4385:   version.</p>
1.2       rillig   4386: <p>The file names of the patch files are usually of the form
                   4387:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1       dsieger  4388: </div>
                   4389: <div class="sect2" lang="en">
                   4390: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4391: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4392: <p>If you want to share patches between multiple packages
                   4393:   in pkgsrc, e.g. because they use the same distfiles, set
                   4394:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4395:   can be found, e.g.:</p>
                   4396: <pre class="programlisting">
                   4397: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4398: </pre>
                   4399: <p>Patch files that are distributed by the author or other
                   4400:     maintainers can be listed in
                   4401:     <code class="varname">PATCHFILES</code>.</p>
                   4402: <p>If it is desired to store any patches that should not be
                   4403:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4404:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4405:     directory tree there is expected to have the same
                   4406:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4407:     patches are expected to be stored inside these dirs (also
                   4408:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4409:     example, if you want to keep a private patch for
                   4410:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4411:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4412:     files in the named directory are expected to be patch files,
                   4413:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4414:     applied</em></span>.</p>
                   4415: </div>
                   4416: <div class="sect2" lang="en">
                   4417: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4418: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4419: <p>When fixing a portability issue in the code do not use
                   4420:       preprocessor magic to check for the current operating system nor
                   4421:       platform.  Doing so hurts portability to other platforms because
                   4422:       the OS-specific details are not abstracted appropriately.</p>
                   4423: <p>The general rule to follow is: instead of checking for the
                   4424:       operating system the application is being built on, check for the
                   4425:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4426:       instead of assuming that kqueue is available under NetBSD and
                   4427:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.6       rillig   4428:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4429:       yes, this generally involves patching the
                   4430:       <span><strong class="command">configure</strong></span> script.  There is absolutely nothing
                   4431:       that prevents some OSes from adopting interfaces from other OSes
                   4432:       (e.g. Linux implementing kqueue), something that the above checks
                   4433:       cannot take into account.</p>
                   4434: <p>Of course, checking for features generally involves more
                   4435:       work on the developer's side, but the resulting changes are
                   4436:       cleaner and there are chances they will work on many other
                   4437:       platforms.  Not to mention that there are higher chances of being
                   4438:       later integrated into the mainstream sources.  Remember:
                   4439:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4440: <p>Some typical examples:</p>
                   4441: <div class="table">
1.6       rillig   4442: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4443: <div class="table-contents"><table summary="Patching examples" border="1">
                   4444: <colgroup>
                   4445: <col>
                   4446: <col>
                   4447: <col>
                   4448: </colgroup>
                   4449: <thead><tr>
                   4450: <th>Where</th>
                   4451: <th>Incorrect</th>
                   4452: <th>Correct</th>
                   4453: </tr></thead>
                   4454: <tbody>
                   4455: <tr>
                   4456: <td>configure script</td>
                   4457: <td>
                   4458: <pre class="programlisting">
                   4459: case ${target_os} in
                   4460: netbsd*) have_kvm=yes ;;
                   4461: *)       have_kvm=no  ;;
                   4462: esac
                   4463: </pre>
                   4464:              </td>
                   4465: <td>
                   4466: <pre class="programlisting">
                   4467: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4468: </pre>
                   4469:              </td>
                   4470: </tr>
                   4471: <tr>
                   4472: <td>C source file</td>
                   4473: <td>
                   4474: <pre class="programlisting">
                   4475: #if defined(__NetBSD__)
                   4476: #  include &lt;sys/event.h&gt;
                   4477: #endif
                   4478: </pre>
                   4479:              </td>
                   4480: <td>
                   4481: <pre class="programlisting">
                   4482: #if defined(HAVE_SYS_EVENT_H)
                   4483: #  include &lt;sys/event.h&gt;
                   4484: #endif
                   4485: </pre>
                   4486:              </td>
                   4487: </tr>
                   4488: <tr>
                   4489: <td>C source file</td>
                   4490: <td>
                   4491: <pre class="programlisting">
                   4492: int
                   4493: monitor_file(...)
                   4494: {
                   4495: #if defined(__NetBSD__)
                   4496:         int fd = kqueue();
                   4497:         ...
                   4498: #else
                   4499:         ...
                   4500: #endif
                   4501: }
                   4502: </pre>
                   4503:              </td>
                   4504: <td>
                   4505: <pre class="programlisting">
                   4506: int
                   4507: monitor_file(...)
                   4508: {
                   4509: #if defined(HAVE_KQUEUE)
                   4510:         int fd = kqueue();
                   4511:         ...
                   4512: #else
                   4513:        ...
                   4514: #endif
                   4515: }
                   4516: </pre>
                   4517:              </td>
                   4518: </tr>
                   4519: </tbody>
                   4520: </table></div>
                   4521: </div>
                   4522: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
                   4523:       packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4524:       1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
                   4525:       2</a>).  It summarizes multiple details on how to make
                   4526:       software easier to package; all the suggestions in it were
                   4527:       collected from our experience in pkgsrc work, so they are possibly
                   4528:       helpful when creating patches too.</p>
                   4529: </div>
                   4530: <div class="sect2" lang="en">
                   4531: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4532: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4533: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4534:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4535:       improvements you do to a package to the mainstream developers.
                   4536:       This is the only way to get their attention on portability issues
                   4537:       and to ensure that future versions can be built out-of-the box on
                   4538:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4539:       the fixes straight from the packaged code.</p>
                   4540: <p>This generally involves cleaning up the patches
                   4541:       (because sometimes the patches that are
                   4542:       added to pkgsrc are quick hacks), filling bug reports in the
                   4543:       appropriate trackers for the projects and working with the
                   4544:       mainstream authors to accept your changes.  It is
                   4545:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4546:       the packages in pkgsrc are kept simple and thus further changes
                   4547:       can be done without much hassle.</p>
                   4548: <p>Support the idea of free software!</p>
                   4549: </div>
                   4550: </div>
                   4551: <div class="sect1" lang="en">
                   4552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4553: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1       dsieger  4554: <div class="variablelist"><dl>
                   4555: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4556: <dd><p>A multi-line description of the piece of software.  This should include
                   4557:          any credits where they are due.  Please bear in mind that others do not
                   4558:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4559:          will read everything that you write here.</p></dd>
                   4560: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4561: <dd><p>This file governs the files that are installed on your
                   4562:          system: all the binaries, manual pages, etc. There are other
                   4563:          directives which may be entered in this file, to control the
                   4564:          creation and deletion of directories, and the location of
1.6       rillig   4565:          inserted files.  See <a href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1       dsieger  4566:          information.</p></dd>
                   4567: </dl></div>
                   4568: </div>
                   4569: <div class="sect1" lang="en">
                   4570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4571: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1       dsieger  4572: <div class="sect2" lang="en">
                   4573: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4574: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1       dsieger  4575: <div class="variablelist"><dl>
                   4576: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   4577: <dd><p>This shell script is invoked twice by <a 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>.
                   4578:            First time after package extraction and before files are
                   4579:            moved in place, the second time after the files to install
                   4580:            are moved in place. This can be used to do any custom
                   4581:            procedures not possible with @exec commands in
                   4582:            <code class="filename">PLIST</code>. See <a 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
1.6       rillig   4583:            <a 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 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.1       dsieger  4584: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4585: <dd><p>This script is executed before and after any files are removed.  It is
                   4586:            this script's responsibility to clean up any additional messy details
                   4587:            around the package's installation, since all pkg_delete knows is how to
                   4588:            delete the files created in the original distribution.
                   4589:            See <a 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>
                   4590:            and <a 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>
                   4591: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4592: <dd>
                   4593: <p>This file is displayed after installation of the package.
                   4594:            Useful for things like legal notices on almost-free
                   4595:            software and hints for updating config files after
                   4596:            installing modules for apache, PHP etc.
                   4597:            Please note that you can modify variables in it easily by using
                   4598:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4599:            <code class="filename">Makefile</code>:</p>
                   4600: <pre class="programlisting">
                   4601: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4602: </pre>
                   4603: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
                   4604:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4605:            performed for <code class="varname">PKGNAME</code>,
                   4606:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4607:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4608:            <code class="varname">X11BASE</code>,
                   4609:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4610:            <code class="varname">ROOT_GROUP</code>, and
                   4611:            <code class="varname">ROOT_GROUP</code>.</p>
                   4612: <p>You can display a different or additional files by
                   4613:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4614:            default is <code class="filename">MESSAGE</code>, if the file
                   4615:            exists.</p>
                   4616: </dd>
                   4617: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4618: <dd><p>FIXME: There is no documentation on the
                   4619:        alternatives framework.</p></dd>
                   4620: </dl></div>
                   4621: </div>
                   4622: <div class="sect2" lang="en">
                   4623: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4624: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1       dsieger  4625: <div class="variablelist"><dl>
                   4626: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4627: <dd><p>This file contains arbitrary things that could
                   4628:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4629:        to be used by more than one package. This file should only be
                   4630:        used when the packages that will use the file are known in
                   4631:        advance. For other purposes it is often better to write a
                   4632:        <code class="filename">*.mk</code> file and give it a good name that
                   4633:        describes what it does.</p></dd>
                   4634: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4635: <dd><p>This file contains the dependency information
1.6       rillig   4636:        for the buildlink3 framework (see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1       dsieger  4637: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4638: <dd><p>This file contains workarounds for compiler bugs
                   4639:        and similar things. It is included automatically by the pkgsrc
                   4640:        infrastructure, so you don't need an extra
                   4641:        <code class="literal">.include</code> line for
                   4642:        it.</p></dd>
                   4643: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4644: <dd><p>This file contains the code for the
1.6       rillig   4645:        package-specific options (see <a href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1       dsieger  4646:        selected by the user. If a package has only one or two options,
                   4647:        it is equally acceptable to put the code directly into the
                   4648:        <code class="filename">Makefile</code>.</p></dd>
                   4649: </dl></div>
                   4650: </div>
                   4651: <div class="sect2" lang="en">
                   4652: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4653: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1       dsieger  4654: <div class="variablelist"><dl>
                   4655: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4656: <dd><p>These files do not take place in the creation of
                   4657:        a package and thus are purely informative to the package
                   4658:        developer.</p></dd>
                   4659: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4660: <dd><p>This file contains things that need to be done
                   4661:        to make the package even
                   4662:        better.</p></dd>
                   4663: </dl></div>
                   4664: </div>
                   4665: </div>
                   4666: <div class="sect1" lang="en">
                   4667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4668: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4669: </h2></div></div></div>
                   4670: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
                   4671:     unpacked into the directory denoted by
                   4672:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4673:     <span><strong class="command">make clean</strong></span>. Besides the sources, this
                   4674:     directory is also used to keep various timestamp files.
                   4675:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4676:     The default is <code class="filename">${.CURDIR}/work</code>
                   4677:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4678:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4679: </div>
                   4680: <div class="sect1" lang="en">
                   4681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4682: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4683: </h2></div></div></div>
                   4684: <p>If you have any files that you wish to be placed in the package prior
                   4685:     to configuration or building, you could place these files here and use
                   4686:     a <span><strong class="command">${CP}</strong></span> command in the
                   4687:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4688:     this. Alternatively, you could simply diff the file against
                   4689:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4690:     the creation of this file.</p>
                   4691: <p>If you want to share files in this way with other
                   4692:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4693:     to the other package's <code class="filename">files</code> directory,
                   4694:     e.g.:</p>
                   4695: <pre class="programlisting">
                   4696: FILESDIR=${.CURDIR}/../xemacs/files
                   4697: </pre>
                   4698: </div>
                   4699: </div>
                   4700: <div class="chapter" lang="en">
                   4701: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4702: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4703: <div class="toc">
                   4704: <p><b>Table of Contents</b></p>
                   4705: <dl>
1.6       rillig   4706: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
                   4707: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4708: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4709: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4710: <dd><dl>
                   4711: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4712: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4713: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4714: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4715: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1       dsieger  4716: </dl></dd>
                   4717: </dl>
                   4718: </div>
                   4719: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4720:   each of which forms a well-defined part of the pkgsrc system. Using
                   4721:   the <a 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
                   4722:   like pkgsrc requires some discipline to keep the code correct and
                   4723:   understandable.</p>
                   4724: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4725:   programming are variables (which are actually macros) and shell
                   4726:   commands. Among these shell commands may even be more complex ones
                   4727:   like <a 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
                   4728:   as intended it is necessary to quote all variables correctly when they
                   4729:   are used.</p>
                   4730: <p>This chapter describes some patterns, that appear quite often in
                   4731:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4732:   with them.</p>
                   4733: <div class="sect1" lang="en">
                   4734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4735: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1       dsieger  4736: <div class="itemizedlist"><ul type="disc"><li>
                   4737: <p>When you are creating a file as a
                   4738:     target of a rule, always write the data to a temporary file first
                   4739:     and finally rename that file. Otherwise there might occur an error
                   4740:     in the middle of generating the file, and when the user runs
                   4741:     <a 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
                   4742:     regenerated properly. Example:</p>
                   4743: <pre class="programlisting">
                   4744: wrong:
                   4745:         @echo "line 1" &gt; ${.TARGET}
                   4746:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4747:         @false
                   4748: 
                   4749: correct:
                   4750:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4751:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4752:         @false
                   4753:         @mv ${.TARGET}.tmp ${.TARGET}
                   4754: </pre>
                   4755: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
                   4756:     <code class="filename">wrong</code> will exist, although there was an error
                   4757:     message in the first run. On the other hand, running <span><strong class="command">make
                   4758:     correct</strong></span> gives an error message twice, as expected.</p>
                   4759: <p>You might remember that <a 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
                   4760:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4761:     happens when it is interrupted, for example by pressing
                   4762:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
                   4763:     when one of the commands fails (like <a 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>
                   4764: </li></ul></div>
                   4765: </div>
                   4766: <div class="sect1" lang="en">
                   4767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4768: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4769: <p><code class="filename">Makefile</code> variables contain strings that
                   4770:     can be processed using the five operators ``='', ``+='', ``?='',
                   4771:     ``:='', and ``!='', which are described in the <a 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
                   4772:     page.</p>
                   4773: <p>When a variable's value is parsed from a
                   4774:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4775:     backslash character ``\'' are handled specially. If a backslash is
                   4776:     followed by a newline, any whitespace immediately in front of the
                   4777:     backslash, the backslash, the newline, and any whitespace
                   4778:     immediately behind the newline are replaced with a single space. A
                   4779:     backslash character and an immediately following hash character are
                   4780:     replaced with a single hash character. Otherwise, the backslash is
                   4781:     passed as is. In a variable assignment, any hash character that is
                   4782:     not preceded by a backslash starts a comment that continues upto the
                   4783:     end of the logical line.</p>
                   4784: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4785:     the only way to create a variable consisting of a single backslash
                   4786:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4787: <p>So far for defining variables. The other thing you can do with
                   4788:     variables is evaluating them. A variable is evaluated when it is
                   4789:     part of the right side of the ``:='' or the ``!='' operator, or
                   4790:     directly before executing a shell command which the variable is part
                   4791:     of. In all other cases, <a 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
                   4792:     is, variables are not evaluated until there's no other way. The
                   4793:     ``modifiers'' mentioned in the man page also evaluate the
                   4794:     variable.</p>
                   4795: <p>Some of the modifiers split the string into words and then
                   4796:     operate on the words, others operate on the string as a whole. When
                   4797:     a string is split into words, it is split as you would expect
                   4798:     it from <a 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.6       rillig   4799: <p>No rule without exception&mdash;the <span><strong class="command">.for</strong></span>
1.1       dsieger  4800:     loop does not follow the shell quoting rules but splits at sequences
                   4801:     of whitespace.</p>
                   4802: <p>There are several types of variables that should be handled
                   4803:     differently. Strings and two types of lists.</p>
                   4804: <div class="itemizedlist"><ul type="disc">
                   4805: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4806:       characters. Nevertheless, you should restrict yourself to only
                   4807:       using printable characters. Examples are
                   4808:       <code class="varname">PREFIX</code> and
                   4809:       <code class="varname">COMMENT</code>.</p></li>
                   4810: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4811:       are never exported to any shell command. Their elements are
                   4812:       separated by whitespace. Therefore, the elements themselves cannot
                   4813:       have embedded whitespace. Any other characters are allowed.
                   4814:       Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
                   4815:       Examples are <code class="varname">DEPENDS</code> and
                   4816:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4817: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4818:       may be exported to a shell command. Their elements can contain any
                   4819:       characters, including whitespace. That's why they cannot be used
                   4820:       in <span><strong class="command">.for</strong></span> loops. Examples are
                   4821:       <code class="varname">DISTFILES</code> and
                   4822:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4823: </ul></div>
                   4824: <div class="sect2" lang="en">
                   4825: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4826: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1       dsieger  4827: <div class="itemizedlist"><ul type="disc">
                   4828: <li><p>All variable names starting with an underscore
                   4829:        are reserved for use by the pkgsrc infrastructure. They shall
                   4830:        not be used by package
                   4831:        <code class="filename">Makefile</code>s.</p></li>
                   4832: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
                   4833:        lowercase variable names for the iteration
                   4834:        variables.</p></li>
                   4835: <li><p>All list variables should have a ``plural''
                   4836:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4837:        <code class="varname">DISTFILES</code>.</p></li>
                   4838: </ul></div>
                   4839: </div>
                   4840: </div>
                   4841: <div class="sect1" lang="en">
                   4842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4843: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  4844: <p>This section presents you with some code snippets you should
                   4845:     use in your own code. If you don't find anything appropriate here,
                   4846:     you should test your code and add it here.</p>
                   4847: <div class="sect2" lang="en">
                   4848: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4849: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  4850: <pre class="programlisting">
                   4851: STRING=                 foo * bar `date`
                   4852: INT_LIST=               # empty
                   4853: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4854: EXT_LIST=               # empty
                   4855: ANOTHER_EXT_LIST=       a=b c=d
                   4856: 
                   4857: INT_LIST+=              ${STRING}               # 1
                   4858: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4859: EXT_LIST+=              ${STRING:Q}             # 3
                   4860: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   4861: </pre>
                   4862: <p>When you add a string to an external list (example 3), it
                   4863:       must be quoted. In all other cases, you must not add a quoting
                   4864:       level. You must not merge internal and external lists, unless you
                   4865:       are sure that all entries are correctly interpreted in both
                   4866:       lists.</p>
                   4867: </div>
                   4868: <div class="sect2" lang="en">
                   4869: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4870: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1       dsieger  4871: <pre class="programlisting">
                   4872: EXT_LIST=       # empty
                   4873: .for i in ${INT_LIST}
                   4874: EXT_LIST+=      ${i:Q}""
                   4875: .endfor
                   4876: </pre>
                   4877: <p>This code converts the internal list
                   4878:       <code class="varname">INT_LIST</code> into the external list
                   4879:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4880:       are unquoted they must be quoted here. The reason for appending
                   4881:       <code class="varname">""</code> is explained below.</p>
                   4882: </div>
                   4883: <div class="sect2" lang="en">
                   4884: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4885: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  4886: <p>Sometimes you may want to print an arbitrary string. There
                   4887:        are many ways to get it wrong and only few that can handle every
                   4888:        nastiness.</p>
                   4889: <pre class="programlisting">
                   4890: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4891: EXT_LIST=       string=${STRING:Q} x=second\ item
                   4892: 
                   4893: all:
                   4894:         echo ${STRING}                  # 1
                   4895:         echo "${STRING}"                # 2
                   4896:         echo "${STRING:Q}"              # 3
                   4897:         echo ${STRING:Q}                # 4
                   4898:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   4899:         printf "%s\\n" ${STRING:Q}""    # 6
                   4900:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   4901: </pre>
                   4902: <p>Example 1 leads to a syntax error in the shell, as the
                   4903:       characters are just copied.</p>
                   4904: <p>Example 2 leads to a syntax error too, and if you leave out
                   4905:       the last " character from <code class="varname">${STRING}</code>,
                   4906:       <a 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
                   4907:       variable would be evaluated, too.</p>
                   4908: <p>Example 3 outputs each space character preceded by a
                   4909:       backslash (or not), depending on the implementation of the
                   4910:       <a 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>
                   4911: <p>Example 4 handles correctly every string that does not start
                   4912:       with a dash. In that case, the result depends on the
                   4913:       implementation of the <a 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
                   4914:       guarantee that your input does not start with a dash, this form is
                   4915:       appropriate.</p>
                   4916: <p>Example 5 handles even the case of a leading dash
                   4917:       correctly.</p>
                   4918: <p>Example 6 also works with every string and is the
                   4919:       light-weight solution, since it does not involve a pipe, which has
                   4920:       its own problems.</p>
                   4921: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   4922:       because the quoting has already been done when adding elements to
                   4923:       the list.</p>
                   4924: <p>As internal lists shall not be passed to the shell, there is
                   4925:       no example for it.</p>
                   4926: </div>
                   4927: <div class="sect2" lang="en">
                   4928: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4929: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  4930: <p>There are many possible sources of wrongly quoted variables.
                   4931:       This section lists some of the commonly known ones.</p>
                   4932: <div class="itemizedlist"><ul type="disc">
                   4933: <li>
                   4934: <p>Whenever you use the value of a list, think
                   4935:        about what happens to leading or trailing whitespace. If the
                   4936:        list is a well-formed shell expression, you can apply the
                   4937:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   4938:        whitespace from each word. The <code class="varname">:M</code> operator
                   4939:        first splits its argument according to the rules of the shell,
                   4940:        and then creates a new list consisting of all words that match
                   4941:        the shell glob expression <code class="varname">*</code>, that is: all.
                   4942:        One class of situations where this is needed is when adding a
                   4943:        variable like <code class="varname">CPPFLAGS</code> to
                   4944:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   4945:        invokes other configure scripts, it strips the leading and
                   4946:        trailing whitespace from the variable and then passes it to the
                   4947:        other configure scripts. But these configure scripts expect the
                   4948:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   4949:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   4950:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   4951:        here is how we do it:</p>
                   4952: <pre class="programlisting">
                   4953: CPPFLAGS=               # empty
                   4954: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   4955: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4956: 
                   4957: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4958: 
                   4959: all:
                   4960:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4961:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   4962: </pre>
                   4963: </li>
                   4964: <li><p>The example above contains one bug: The
                   4965:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   4966:        expression, but there is the C compiler after it, which also
                   4967:        expects a properly quoted string (this time in C syntax). The
                   4968:        version above is therefore only correct if
                   4969:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   4970:        or double quotes. If you want to allow these, you have to add
                   4971:        another layer of quoting to each variable that is used as a C
                   4972:        string literal. You cannot use the <code class="varname">:Q</code>
                   4973:        operator for it, as this operator only works for the
                   4974:        shell.</p></li>
                   4975: <li>
                   4976: <p>Whenever a variable can be empty, the
                   4977:        <code class="varname">:Q</code> operator can have surprising results. Here
                   4978:        are two completely different cases which can be solved with the
                   4979:        same trick.</p>
                   4980: <pre class="programlisting">
                   4981: EMPTY=                  # empty
                   4982: empty_test:
                   4983:         for i in a ${EMPTY:Q} c; do \
                   4984:             echo "$$i"; \
                   4985:         done
                   4986: 
                   4987: for_test:
                   4988: .for i in a:\ a:\test.txt
                   4989:         echo ${i:Q}
                   4990:         echo "foo"
                   4991: .endfor
                   4992: </pre>
                   4993: <p>The first example will only print two of the three lines
                   4994:        we might have expected. This is because
                   4995:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   4996:        the shell cannot see. The workaround is to write
                   4997:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   4998:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   4999:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5000: <p>The second example will only print three lines instead of
                   5001:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5002:        This is because the backslash of the value
                   5003:        <code class="varname">a:\</code> is interpreted as a line-continuation by
                   5004:        <a 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
                   5005:        <a 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
                   5006:        <code class="varname">${i:Q}""</code>.</p>
                   5007: </li>
                   5008: </ul></div>
                   5009: </div>
                   5010: <div class="sect2" lang="en">
                   5011: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5012: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5013: <p>The pkgsrc bmake program does not handle the following
                   5014:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5015:       contains a ``-'' character, one of the closing braces is included
                   5016:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5017: <pre class="programlisting">
                   5018: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5019: </pre>
                   5020: <p>For a more complex code snippet and a workaround, see the
                   5021:       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
                   5022:       <code class="varname">bug1</code>.</p>
                   5023: </div>
                   5024: </div>
                   5025: </div>
                   5026: <div class="chapter" lang="en">
                   5027: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5028: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5029: <div class="toc">
                   5030: <p><b>Table of Contents</b></p>
                   5031: <dl>
1.6       rillig   5032: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
                   5033: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5034: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   5035: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5036: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
                   5037: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5038: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5039: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5040: </dl>
                   5041: </div>
                   5042: <p>The <code class="filename">PLIST</code> file contains a package's
                   5043:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5044:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5045:   directory it's been installed in) plus some additional statements
                   5046:   - see the <a 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.
                   5047:   This chapter addresses some issues that need attention when
                   5048:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5049:   below!).</p>
                   5050: <div class="sect1" lang="en">
                   5051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5052: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5053: <p>Be sure to add a RCS ID line as the first thing in any
                   5054:     <code class="filename">PLIST</code> file you write:</p>
                   5055: <pre class="programlisting">
                   5056: @comment $NetBSD$
                   5057:     </pre>
                   5058: </div>
                   5059: <div class="sect1" lang="en">
                   5060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5061: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.1       dsieger  5062: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
                   5063:     to output a PLIST that matches any new files since the package
1.6       rillig   5064:     was extracted.  See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.1       dsieger  5065:     more information on this target.</p>
                   5066: </div>
                   5067: <div class="sect1" lang="en">
                   5068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5069: <a name="print-PLIST"></a>13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
1.1       dsieger  5070: </h2></div></div></div>
                   5071: <p>If you have used any of the *-dirs packages, as explained in
1.6       rillig   5072:     <a 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
1.1       dsieger  5073:     <span><strong class="command">make print-PLIST</strong></span> outputs a set of
                   5074:     <code class="varname">@comment</code>s instead of real
                   5075:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5076:     specific directories and files, so that the results of that
                   5077:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5078:     lot</em></span> during the update of packages.</p>
                   5079: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5080:     of AWK patterns and actions that are used to filter the output of
                   5081:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5082:     scripting you like to it, but be careful with quoting.</p>
                   5083: <p>For example, to get all files inside the
                   5084:     <code class="filename">libdata/foo</code> directory removed from the
                   5085:     resulting PLIST:</p>
                   5086: <pre class="programlisting">
                   5087: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5088:     </pre>
                   5089: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5090:     to a specific (shared) directory converted to
                   5091:     <code class="varname">@comment</code>s:</p>
                   5092: <pre class="programlisting">
                   5093: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5094:     </pre>
                   5095: </div>
                   5096: <div class="sect1" lang="en">
                   5097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5098: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5099: <p>A number of variables are substituted automatically in
                   5100:     PLISTs when a package is installed on a system. This includes the
                   5101:     following variables:</p>
                   5102: <div class="variablelist"><dl>
                   5103: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5104: <dd>
                   5105: <p>Some packages like emacs and perl embed information
                   5106:          about which architecture they were built on into the
                   5107:          pathnames where they install their files. To handle this
                   5108:          case, PLIST will be preprocessed before actually used, and
                   5109:          the symbol
                   5110:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
                   5111:          replaced by what <span><strong class="command">uname -p</strong></span> gives. The
                   5112:          same is done if the string
                   5113:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5114:          PLIST somewhere - use this on packages that have GNU
                   5115:          autoconf-created configure scripts.</p>
                   5116: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5117: <h3 class="title">Legacy note</h3>
                   5118: <p>There used to be a symbol
                   5119:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
                   5120:            was replaced by the output of <span><strong class="command">uname
                   5121:            -m</strong></span>, but that's no longer supported and has
                   5122:            been removed.</p>
                   5123: </div>
                   5124: </dd>
                   5125: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5126: <dd>
                   5127: <p>Some packages want to embed the OS name and version
                   5128:          into some paths.  To do this, use these variables in the
                   5129:          <code class="filename">PLIST</code>:
                   5130:          </p>
                   5131: <div class="itemizedlist"><ul type="disc">
                   5132: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span><strong class="command">uname -s</strong></span></span>&#8221;</p></li>
                   5133: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
                   5134: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span><strong class="command">uname -r</strong></span></span>&#8221;</p></li>
                   5135: </ul></div>
                   5136: </dd>
                   5137: </dl></div>
                   5138: <p>For a complete list of values which are replaced by
                   5139:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5140:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5141: <p>If you want to change other variables not listed above, you
                   5142:     can add variables and their expansions to this variable in the
1.6       rillig   5143:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.1       dsieger  5144: <pre class="programlisting">
                   5145: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5146:     </pre>
                   5147: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
                   5148:     in the <code class="filename">PLIST</code> with
                   5149:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
                   5150: </div>
                   5151: <div class="sect1" lang="en">
                   5152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5153: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5154: <p>Man pages should be installed in compressed form if
                   5155:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5156:     and uncompressed otherwise. To handle this in the
                   5157:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5158:     appended/removed automatically for man pages according to
                   5159:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5160:     or not, see above for details. This modification of the
                   5161:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5162:     <code class="filename">PLIST</code> itself.</p>
                   5163: </div>
                   5164: <div class="sect1" lang="en">
                   5165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5166: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5167: </h2></div></div></div>
                   5168: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5169:     in generating the binary package, set the variable
                   5170:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   5171:     The files are later concatenated using <a 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
                   5172:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5173:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5174: </div>
                   5175: <div class="sect1" lang="en">
                   5176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5177: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5178: <p>Some packages decide to install a different set of files based on
                   5179:     the operating system being used. These differences can be
                   5180:     automatically handled by using the following files:</p>
                   5181: <div class="itemizedlist"><ul type="disc">
                   5182: <li><p><code class="filename">PLIST.common</code></p></li>
                   5183: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5184: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5185: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5186: <li><p><code class="filename">PLIST.common_end</code></p></li>
                   5187: </ul></div>
                   5188: </div>
                   5189: <div class="sect1" lang="en">
                   5190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5191: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1       dsieger  5192: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5193:     multiple (and unrelated) packages install files.  These
                   5194:     directories are problematic because you have to add special tricks
                   5195:     in the PLIST to conditionally remove them, or have some
                   5196:     centralized package handle them.</p>
                   5197: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5198:     is shared by a few unrelated packages, it's often not worth to add
                   5199:     an extra package to remove it.  Therefore, one simply does:</p>
                   5200: <pre class="programlisting">
                   5201: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
                   5202:     </pre>
                   5203: <p>in the PLISTs of all affected packages, instead of the
                   5204:     regular "@dirrm" line.</p>
                   5205: <p>However, if the directory is shared across many packages, two
                   5206:     different solutions are available:</p>
                   5207: <div class="orderedlist"><ol type="1">
                   5208: <li><p>If the packages have a common dependency, the directory
                   5209:        can be removed in that.  For example, see
                   5210:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
                   5211:        removes the shared directory
                   5212:        <code class="filename">share/omf</code>.</p></li>
                   5213: <li><p>If the packages using the directory are not related at
                   5214:        all (they have no common dependencies), a *-dirs package is
                   5215:        used.</p></li>
                   5216: </ol></div>
                   5217: <p>From now on, we'll discuss the second solution.  To get an
                   5218:     idea of the *-dirs packages available, issue:</p>
                   5219: <pre class="programlisting">
                   5220: <code class="prompt">%</code> cd .../pkgsrc
                   5221: <code class="prompt">%</code> ls -d */*-dirs
                   5222:     </pre>
                   5223: <p>Their use from other packages is very simple.  The
                   5224:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5225:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5226:     version number (always pick the latest one when writing new
                   5227:     packages).</p>
                   5228: <p>For example, if a package installs files under
                   5229:     <code class="filename">share/applications</code>, it should have the
                   5230:     following line in it:</p>
                   5231: <pre class="programlisting">
                   5232: USE_DIRS+=      xdg-1.1
                   5233:     </pre>
                   5234: <p>After regenerating the PLIST using <span><strong class="command">make
                   5235:     print-PLIST</strong></span>, you should get the right (commented out)
                   5236:     lines.</p>
                   5237: <p>Note that even if your package is using
                   5238:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5239:     *-x11-dirs packages.  Just specify the name without that part and
                   5240:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5241:     care of it.</p>
                   5242: </div>
                   5243: </div>
                   5244: <div class="chapter" lang="en">
                   5245: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5246: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5247: <div class="toc">
                   5248: <p><b>Table of Contents</b></p>
                   5249: <dl>
1.6       rillig   5250: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
                   5251: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5252: <dd><dl>
1.6       rillig   5253: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5254: <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.1       dsieger  5255: </dl></dd>
1.6       rillig   5256: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1       dsieger  5257: <dd><dl>
1.6       rillig   5258: <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>
                   5259: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1       dsieger  5260: </dl></dd>
                   5261: </dl>
                   5262: </div>
                   5263: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5264:   are seen by a package's configure and build processes.  This is implemented
                   5265:   in a two step process:</p>
                   5266: <div class="orderedlist"><ol type="1">
                   5267: <li><p>Symlink headers and libraries for dependencies into
                   5268:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5269:       of <code class="varname">WRKDIR</code>.</p></li>
                   5270: <li><p>Create wrapper scripts that are used in place of the normal compiler
                   5271:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5272:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5273:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5274:       native compiler on some operating systems look like GCC, so that
                   5275:       packages that expect GCC won't require modifications to build with
                   5276:       those native compilers.</p></li>
                   5277: </ol></div>
                   5278: <p>This normalizes the environment in which a package is built so that the
                   5279:   package may be built consistently despite what other software may be
                   5280:   installed. Please note that the normal system header and library paths,
                   5281:   e.g. <code class="filename">/usr/include</code>,
                   5282:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5283:   designed to insulate the package build from non-system-supplied
                   5284:   software.</p>
                   5285: <div class="sect1" lang="en">
                   5286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5287: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5288: <p>The process of converting packages to use the buildlink3
                   5289:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5290:     The things to keep in mind are:</p>
                   5291: <div class="orderedlist"><ol type="1">
                   5292: <li><p>Ensure that the build always calls the wrapper scripts
                   5293:        instead of the actual toolchain.  Some packages are tricky,
                   5294:        and the only way to know for sure is the check
                   5295:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5296:        wrappers are being invoked.</p></li>
                   5297: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5298:        the package Makefile, e.g. Java VMs, standalone shells,
                   5299:        etc., because the code to symlink files into
                   5300:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5301:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5302:        </p></li>
                   5303: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5304:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5305:        package's Makefile are added as dependencies for that package.
                   5306:        </p></li>
                   5307: </ol></div>
                   5308: <p>If a dependency on a particular package is required for its libraries and
                   5309:     headers, then we replace:</p>
                   5310: <pre class="programlisting">
                   5311: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5312: </pre>
                   5313: <p>with</p>
                   5314: <pre class="programlisting">
                   5315: .include "../../category/foo/buildlink3.mk"
                   5316: </pre>
                   5317: <p>The buildlink3.mk files usually define the required dependencies.
                   5318:     If you need a newer version of the dependency when using buildlink3.mk
                   5319:     files, then you can define it in your Makefile; for example:</p>
                   5320: <pre class="programlisting">
                   5321: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5322: .include "../../category/foo/buildlink3.mk"
                   5323: </pre>
                   5324: <p>There are several <code class="filename">buildlink3.mk</code>
                   5325:     files in <code class="filename">pkgsrc/mk</code>
                   5326:     that handle special package issues:</p>
                   5327: <div class="itemizedlist"><ul type="disc">
                   5328: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   5329:        the native or a pkgsrc Berkeley DB implementation based on
                   5330:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5331:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   5332: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   5333:        comes with neither Curses nor NCurses, this will take care
                   5334:        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>
                   5335: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   5336:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5337:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5338:        require a Kerberos 5 implementation.</p></li>
                   5339: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5340:        system-provided Motif installation or adds a dependency on
                   5341:        <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
                   5342:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5343:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5344:        which Motif version will be used.</p></li>
                   5345: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
                   5346:        variables that may be used by packages that use the
                   5347:        Open Sound System (OSS) API.</p></li>
                   5348: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   5349:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
                   5350:        the file for more information.</p></li>
                   5351: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   5352:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5353:        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>
                   5354: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   5355:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5356:        library.</p></li>
                   5357: </ul></div>
                   5358: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5359:     files provide a more complete
                   5360:     description of how to use them properly.</p>
                   5361: </div>
                   5362: <div class="sect1" lang="en">
                   5363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5364: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5365: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5366:     included by Makefiles to indicate the need to compile and link
                   5367:     against header files and libraries provided by the package.  A
                   5368:     <code class="filename">buildlink3.mk</code> file should always provide
                   5369:     enough information to add the correct type of dependency
                   5370:     relationship and include any other
                   5371:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5372:     headers and libraries that it needs in turn.</p>
                   5373: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5374:     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>
                   5375:     package is highly recommended.  For most packages, the following
                   5376:     command will generate a good starting point for
                   5377:     <code class="filename">buildlink3.mk</code> files:</p>
                   5378: <pre class="screen">
                   5379: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5380: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5381:     </pre>
                   5382: <div class="sect2" lang="en">
                   5383: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5384: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5385: <p>The following real-life example
                   5386:       <code class="filename">buildlink3.mk</code> is taken
                   5387:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5388: <pre class="programlisting">
                   5389: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
                   5390: 
                   5391: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5392: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
                   5393: 
                   5394: .if ${BUILDLINK_DEPTH} == "+"
                   5395: BUILDLINK_DEPENDS+=     tiff
                   5396: .endif
                   5397: 
                   5398: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5399: BUILDLINK_PACKAGES+=    tiff
                   5400: 
                   5401: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5402: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5403: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5404: .endif  # TIFF_BUILDLINK3_MK
                   5405: 
                   5406: .include "../../devel/zlib/buildlink3.mk"
                   5407: .include "../../graphics/jpeg/buildlink3.mk"
                   5408: 
                   5409: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5410: </pre>
                   5411: <p>The header and footer manipulate
                   5412:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5413:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5414:       at what depth we are including
                   5415:       <code class="filename">buildlink3.mk</code> files.</p>
                   5416: <p>The first section controls if the dependency on
                   5417:       <em class="replaceable"><code>pkg</code></em> is added.
                   5418:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5419:       packages for which dependencies are added by
                   5420:       buildlink3.</p>
                   5421: <p>The second section advises pkgsrc that the
                   5422:       <code class="filename">buildlink3.mk</code> file for
                   5423:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5424:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5425:       packages for which <code class="filename">buildlink3.mk</code> files
                   5426:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5427:       appended to within a <code class="filename">buildlink3.mk</code>
                   5428:       file.</p>
                   5429: <p>The third section is protected from multiple inclusion
                   5430:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5431:       added.  Several important variables are set in the section:</p>
                   5432: <div class="itemizedlist"><ul type="disc">
                   5433: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5434:          is the actual dependency recorded in the installed
                   5435:          package; this should always be set using
                   5436:          <span><strong class="command">+=</strong></span> to ensure that
                   5437:          we're appending to any pre-existing list of values.  This
                   5438:          variable should be set to the first version of the
                   5439:          package that had an API change.
                   5440:          </p></li>
                   5441: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5442:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5443:          pkgsrc directory.</p></li>
                   5444: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5445:          (not shown above) controls whether we use
                   5446:          <code class="varname">BUILD_DEPENDS</code> or
                   5447:          <code class="varname">DEPENDS</code> to add the dependency on
                   5448:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5449:          selected by setting
                   5450:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5451:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5452:          used.</p></li>
                   5453: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5454:            and
                   5455:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5456:            (not shown above) are lists of subdirectories of
                   5457:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5458:            to add to the header and library search paths.  These
                   5459:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
                   5460:          respectively.</p></li>
                   5461: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   5462:            (not shown above) is the list of preprocessor flags to add
                   5463:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5464:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5465:            should be avoided and instead be handled using
                   5466:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5467:          above.</p></li>
                   5468: </ul></div>
                   5469: <p>The following variables are all optionally defined within
                   5470:       this second section (protected against multiple inclusion) and
                   5471:       control which package files are symlinked into
                   5472:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5473:       transformed during the symlinking:</p>
                   5474: <div class="itemizedlist"><ul type="disc">
                   5475: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   5476:            (not shown above) is a shell glob pattern relative to
                   5477:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5478:            to be symlinked into
                   5479:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5480:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5481: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5482:            (not shown above) is a shell pipeline that
                   5483:            outputs to stdout a list of files relative to
                   5484:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5485:            The resulting files are to be symlinked
                   5486:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5487:            this takes the <code class="filename">+CONTENTS</code> of a
                   5488:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5489:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5490: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5491:            (not shown above) is a filter command that filters
                   5492:            <code class="filename">+CONTENTS</code> input into a list of files
                   5493:            relative to
                   5494:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5495:            on stdout.  By default for overwrite packages,
                   5496:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5497:            outputs the contents of the <code class="filename">include</code>
                   5498:            and <code class="filename">lib</code> directories in the package
                   5499:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5500:            it outputs any libtool archives in
                   5501:            <code class="filename">lib</code> directories.</p></li>
                   5502: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   5503:            (not shown above) is a list of sed arguments used to
                   5504:            transform the name of the source filename into a
                   5505:            destination filename, e.g. <span><strong class="command">-e
                   5506:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5507: </ul></div>
                   5508: <p>The last section includes any
                   5509:       <code class="filename">buildlink3.mk</code> needed for
                   5510:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5511:       Including these <code class="filename">buildlink3.mk</code> files
                   5512:       means that the headers and libraries for these
                   5513:       dependencies are also symlinked into
                   5514:       <code class="filename">${BUILDLINK_DIR}</code>
                   5515:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5516:       <code class="filename">buildlink3.mk</code>
                   5517:       file is included.</p>
                   5518: </div>
                   5519: <div class="sect2" lang="en">
                   5520: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5521: <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.1       dsieger  5522: <p>The situation that requires increasing the dependency listed in
                   5523:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5524:        after a package update is when the API or interface to the
                   5525:       header files change.</p>
                   5526: <p>In this case,
                   5527:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5528:       should be adjusted to require at least the new package
                   5529:       version.  In some cases, the packages that depend on this new
                   5530:       version may need their <code class="varname">PKGREVISION</code>s
                   5531:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5532:       files, their
                   5533:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5534:       adjusted, too.  This is needed so pkgsrc will require the
                   5535:       correct package dependency and not settle for an older one
                   5536:       when building the source.</p>
                   5537: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5538:        should be increased when the binary interface or sonames
                   5539:        (major number of the library version) of any installed
                   5540:        shared libraries change.  This is needed so that binary
                   5541:        packages made using it will require the correct package
                   5542:        dependency and not settle for an older one which will not
                   5543:       contain the necessary shared libraries.</p>
1.6       rillig   5544: <p>See <a href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.1       dsieger  5545:        more information about dependencies on other packages,
                   5546:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
                   5547:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5548: <p>Please take careful consideration before adjusting
                   5549:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5550:       or
                   5551:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5552:       as we don't want to cause unneeded package deletions and
                   5553:       rebuilds.  In many cases, new versions of packages work just
                   5554:       fine with older dependencies.</p>
                   5555: <p>Also it is not needed to set
                   5556:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5557:        when it is identical to
                   5558:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5559: </div>
                   5560: </div>
                   5561: <div class="sect1" lang="en">
                   5562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5563: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5564: <p>Some packages in pkgsrc install headers and libraries that
                   5565:       coincide with headers and libraries present in the base system.
                   5566:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5567:       packages should also include a <code class="filename">builtin.mk</code>
                   5568:       file that includes the necessary checks to decide whether using
                   5569:       the built-in software or the pkgsrc software is
                   5570:     appropriate.</p>
                   5571: <p>The only requirements of a builtin.mk file for
                   5572:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   5573: <div class="orderedlist"><ol type="1">
                   5574: <li><p>It should set
                   5575:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5576:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5577:        after it is included.</p></li>
                   5578: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5579:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5580:        which is already set before the
                   5581:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5582: <li><p>It should be written to allow multiple inclusion.  This
                   5583:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5584:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5585: </ol></div>
                   5586: <div class="sect2" lang="en">
                   5587: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5588: <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.1       dsieger  5589: <p>The following is the recommended template for builtin.mk
                   5590:       files:</p>
                   5591: <pre class="programlisting">
                   5592: .if !defined(IS_BUILTIN.foo)
                   5593: #
                   5594: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5595: # genuinely exists in the system or not.
                   5596: #
                   5597: IS_BUILTIN.foo?=        no
                   5598: 
                   5599: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5600: # version can be determined.
                   5601: #
                   5602: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5603: BUILTIN_PKG.foo?=       foo-1.0
                   5604: .  endif
                   5605: .endif  # IS_BUILTIN.foo
                   5606: 
                   5607: .if !defined(USE_BUILTIN.foo)
                   5608: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5609: .  if defined(BUILTIN_PKG.foo)
                   5610: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5611: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5612: USE_BUILTIN.foo!=                                                       \
                   5613:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5614:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5615: .      endif
                   5616: .    endfor
                   5617: .  endif
                   5618: .endif  # USE_BUILTIN.foo
                   5619: 
                   5620: CHECK_BUILTIN.foo?=     no
                   5621: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5622: #
                   5623: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5624: # "yes" or "no".
                   5625: #
                   5626: .endif  # CHECK_BUILTIN.foo
                   5627: </pre>
                   5628: <p>The first section sets
                   5629:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5630:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5631:       in the base system.  This should not be a base system software
                   5632:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5633:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5634:       included as part of the base system.  This variable is only
                   5635:       used internally within the <code class="filename">builtin.mk</code>
                   5636:       file.</p>
                   5637: <p>The second section sets
                   5638:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5639:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5640:       system if it exists (if
                   5641:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5642:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5643:       within the <code class="filename">builtin.mk</code> file.</p>
                   5644: <p>The third section sets
                   5645:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5646:       and is <span class="emphasis"><em>required</em></span> in all
                   5647:       <code class="filename">builtin.mk</code> files.  The code in this
                   5648:       section must make the determination whether the built-in
                   5649:       software is adequate to satisfy the dependencies listed in
                   5650:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5651:       This is typically done by comparing
                   5652:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5653:       against each of the dependencies in
                   5654:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5655:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5656:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5657:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5658:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5659:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5660:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5661:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5662:       that the built-in version of the software is similar enough to
                   5663:       be used as a replacement.</p>
                   5664: <p>The last section is guarded by
                   5665:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5666:       and includes code that uses the value of
                   5667:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5668:       set in the previous section.  This typically includes, e.g.,
                   5669:       adding additional dependency restrictions and listing additional
                   5670:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5671:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5672: </div>
                   5673: <div class="sect2" lang="en">
                   5674: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5675: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5676: <p>When building packages, it's possible to choose whether to set
                   5677:        a global preference for using either the built-in (native)
                   5678:        version or the pkgsrc version of software to satisfy a
                   5679:        dependency.  This is controlled by setting
                   5680:        <code class="varname">PREFER_PKGSRC</code> and
                   5681:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5682:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5683:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5684:        use the pkgsrc versions of software, while
                   5685:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5686:        built-in versions.  Preferences are determined by the most
                   5687:        specific instance of the package in either
                   5688:        <code class="varname">PREFER_PKGSRC</code> or
                   5689:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5690:        in neither or in both variables, then
                   5691:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5692:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5693:        using pkgsrc versions of software for all but the most basic
                   5694:       bits on a NetBSD system, you can set:</p>
                   5695: <pre class="programlisting">
                   5696: PREFER_PKGSRC=  yes
                   5697: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5698: </pre>
                   5699: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5700:       <code class="filename">builtin.mk</code>
                   5701:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5702:       otherwise it is simply ignored in that list.</p>
                   5703: </div>
                   5704: </div>
                   5705: </div>
                   5706: <div class="chapter" lang="en">
                   5707: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5708: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5709: <div class="toc">
                   5710: <p><b>Table of Contents</b></p>
                   5711: <dl>
1.6       rillig   5712: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1       dsieger  5713: <dd><dl>
1.6       rillig   5714: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5715: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5716: </dl></dd>
1.6       rillig   5717: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5718: <dd><dl>
1.6       rillig   5719: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5720: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5721: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5722: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5723: </dl></dd>
                   5724: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5725: <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>
                   5726: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5727: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5728: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5729: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5730: <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.1       dsieger  5731: </dl>
                   5732: </div>
                   5733: <p>This chapter describes the framework known as
                   5734: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5735: <div class="itemizedlist"><ul type="disc">
                   5736: <li><p>Generic installation and manipulation of directories and files
                   5737:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5738: <li><p>Automatic handling of configuration files during installation,
                   5739:     provided that packages are correctly designed.</p></li>
                   5740: <li><p>Generation and installation of system startup scripts.</p></li>
                   5741: <li><p>Registration of system users and groups.</p></li>
                   5742: <li><p>Registration of system shells.</p></li>
                   5743: <li><p>Automatic updating of fonts databases.</p></li>
                   5744: </ul></div>
                   5745: <p>The following sections inspect each of the above points in detail.</p>
                   5746: <p>You may be thinking that many of the things described here could be
                   5747: easily done with simple code in the package's post-installation target
                   5748: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5749: as the code in them is only executed when building from source.  Machines
                   5750: using binary packages could not benefit from it at all (as the code itself
                   5751: could be unavailable).  Therefore, the only way to achieve any of the items
                   5752: described above is by means of the installation scripts, which are
                   5753: automatically generated by pkginstall.</p>
                   5754: <div class="sect1" lang="en">
                   5755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5756: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5757: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5758: of files and directories that belong to a package.  The names used in it
                   5759: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5760: which means that it cannot register files outside this directory (absolute
                   5761: path names are not allowed).  Despite this restriction, some packages need
                   5762: to install files outside this location; e.g., under
                   5763: <code class="filename">${VARBASE}</code> or
                   5764: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5765: is to create such files during installation time by using
                   5766: installation scripts.</p>
                   5767: <p>The generic installation scripts are shell scripts that can
                   5768: contain arbitrary code.  The list of scripts to execute is taken from
                   5769: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5770: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5771: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5772: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5773: commands, so they have the potential to create and manage files
                   5774: anywhere in the file system.</p>
                   5775: <p>Using these general installation files is not recommended, but
                   5776: may be needed in some special cases.  One reason for avoiding them is
                   5777: that the user has to trust the packager that there is no unwanted or
                   5778: simply erroneous code included in the installation script. Also,
                   5779: previously there were many similar scripts for the same functionality,
                   5780: and fixing a common error involved finding and changing all of
                   5781: them.</p>
                   5782: <p>The pkginstall framework offers another, standardized way.  It
                   5783: provides generic scripts to abstract the manipulation of such files
                   5784: and directories based on variables set in the package's
                   5785: <code class="filename">Makefile</code>.  The rest of this section describes
                   5786: these variables.</p>
                   5787: <div class="sect2" lang="en">
                   5788: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5789: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5790: <p>The following variables can be set to request the creation of
                   5791: directories anywhere in the file system:</p>
                   5792: <div class="itemizedlist"><ul type="disc">
                   5793: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5794:     contain a list of directories that should be created and should attempt
                   5795:     to be destroyed by the installation scripts.  The difference between
                   5796:     the two is that the latter prompts the administrator to remove any
                   5797:     directories that may be left after deinstallation (because they were
                   5798:     not empty), while the former does not.</p></li>
                   5799: <li>
                   5800: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5801:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5802:     which directories should be created and should attempt to be destroyed
                   5803:     by the installation scripts.  Each tuple holds the following values,
                   5804:     separated by spaces: the directory name, its owner, its group and its
                   5805:     numerical mode.  For example:</p>
                   5806: <pre class="programlisting">
                   5807: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5808: </pre>
                   5809: <p>The difference between the two is exactly the same as their
                   5810:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5811: </li>
                   5812: </ul></div>
                   5813: </div>
                   5814: <div class="sect2" lang="en">
                   5815: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5816: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5817: <p>Creating non-empty files outside the installation prefix is tricky
                   5818: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5819: To overcome this problem, the only solution is to extract the file in the
                   5820: known place (i.e., inside the installation prefix) and copy it to the
                   5821: appropriate location during installation (done by the installation scripts
                   5822: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5823: file</em></span> in the following paragraphs, which describe the variables
                   5824: that can be used to automatically and consistently handle files outside the
                   5825: installation prefix:</p>
                   5826: <div class="itemizedlist"><ul type="disc">
                   5827: <li>
                   5828: <p><code class="varname">CONF_FILES</code> and
                   5829:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5830:     During installation time, the master file is copied to the target one
                   5831:     if and only if the latter does not exist.  Upon deinstallation, the
                   5832:     target file is removed provided that it was not modified by the
                   5833:     installation.</p>
                   5834: <p>The difference between the two is that the latter prompts the
                   5835:     administrator to remove any files that may be left after
                   5836:     deinstallation (because they were not empty), while the former does
                   5837:     not.</p>
                   5838: </li>
                   5839: <li>
                   5840: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5841:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5842:     files as well as their target locations.  For each of them, it also
                   5843:     specifies their owner, their group and their numeric permissions, in
                   5844:     this order.  For example:</p>
                   5845: <pre class="programlisting">
                   5846: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
                   5847: </pre>
                   5848: <p>The difference between the two is exactly the same as their
                   5849:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5850: </li>
                   5851: </ul></div>
                   5852: </div>
                   5853: </div>
                   5854: <div class="sect1" lang="en">
                   5855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5856: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  5857: <p>Configuration files are special in the sense that they are installed
                   5858: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5859: need special treatment during installation (most of which is automated by
                   5860: pkginstall).  The main concept you must bear in mind is that files marked
                   5861: as configuration files are automatically copied to the right place (somewhere
                   5862: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5863: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5864: be removed if they have local modifications.  This ensures that
                   5865: administrators never lose any custom changes they may have made.</p>
                   5866: <div class="sect2" lang="en">
                   5867: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5868: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1       dsieger  5869: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5870: specifies where configuration files shall be installed.  Its contents are
                   5871: set based upon the following variables:</p>
                   5872: <div class="itemizedlist"><ul type="disc">
                   5873: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   5874:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5875:     be overridden by the user to point to his preferred location (e.g.,
                   5876:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5877:     Packages must not use it directly.</p></li>
                   5878: <li>
                   5879: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5880:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5881:     for the package being built shall be installed.  The definition of this
                   5882:     variable only makes sense in the package's
                   5883:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5884: <p>As an example, consider the Apache package,
                   5885:     <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
                   5886:     configuration files under the
                   5887:     <code class="filename">httpd/</code> subdirectory of
                   5888:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5889:     Makefile.</p>
                   5890: </li>
                   5891: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   5892:     variable that holds this package's configuration directory (if
                   5893:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5894:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5895:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   5896: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   5897:     directory where the configuration files for the package identified by
                   5898:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5899: </ul></div>
                   5900: <p>Based on the above variables, pkginstall determines the value of
                   5901: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5902: variable that can be used within a package to refer to its configuration
                   5903: directory.  The algorithm used to set its value is basically the
                   5904: following:</p>
                   5905: <div class="orderedlist"><ol type="1">
                   5906: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   5907:     its value is used.</p></li>
                   5908: <li><p>If the previous variable is not defined but
                   5909:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   5910:     <code class="filename">Makefile</code>, the resulting value is
                   5911:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   5912: <li><p>Otherwise, it is set to
                   5913:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   5914: </ol></div>
                   5915: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.6       rillig   5916: automatically added to <code class="filename">OWN_DIRS</code>.  See <a href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.</p>
1.1       dsieger  5917: </div>
                   5918: <div class="sect2" lang="en">
                   5919: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5920: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  5921: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5922: known place, you need to teach each package where it shall install its
                   5923: files.  In some cases you will have to patch the package Makefiles to
                   5924: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5925: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5926: generated files:</p>
                   5927: <pre class="programlisting">
                   5928: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   5929: </pre>
                   5930: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5931: for</em></span> its configuration files, not where they will be originally
                   5932: installed (although the difference is never explicit,
                   5933: unfortunately).</p>
                   5934: </div>
                   5935: <div class="sect2" lang="en">
                   5936: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5937: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  5938: <p>As said before, pkginstall automatically handles configuration files.
                   5939: This means that <span class="strong"><strong>the packages themselves must not
                   5940: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   5941: directly</strong></span>.  Bad news is that many software installation scripts
                   5942: will, out of the box, mess with the contents of that directory.  So what is
                   5943: the correct procedure to fix this issue?</p>
                   5944: <p>You must teach the package (usually by manually patching it) to
                   5945: install any configuration files under the examples hierarchy,
                   5946: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5947: <code class="filename">PLIST</code> registers them and the administrator always
                   5948: has the original copies available.</p>
                   5949: <p>Once the required configuration files are in place (i.e., under the
                   5950: examples hierarchy), the pkginstall framework can use them as master copies
                   5951: during the package installation to update what is in
                   5952: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   5953: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.6       rillig   5954: used.  Check out <a href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.1       dsieger  5955: about their syntax and their purpose.  Here is an example, taken from the
                   5956: <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>
                   5957: <pre class="programlisting">
                   5958: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5959: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   5960: </pre>
                   5961: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5962: package and has no meaning outside it.</p>
                   5963: </div>
                   5964: <div class="sect2" lang="en">
                   5965: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5966: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  5967: <p>The automatic copying of config files can be toggled by setting the
                   5968: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5969: installation.</p>
                   5970: </div>
                   5971: </div>
                   5972: <div class="sect1" lang="en">
                   5973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5974: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  5975: <p>System startup scripts are special files because they must be
                   5976: installed in a place known by the underlying OS, usually outside the
1.6       rillig   5977: installation prefix.  Therefore, the same rules described in <a 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.1       dsieger  5978: can be used.  However, pkginstall provides a special mechanism to handle
                   5979: these files.</p>
                   5980: <p>In order to provide system startup scripts, the package has
                   5981: to:</p>
                   5982: <div class="orderedlist"><ol type="1">
                   5983: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   5984:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   5985:     <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
                   5986:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   5987: <li>
                   5988: <p>Tell pkginstall to handle it, appending the name of the script,
                   5989:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5990:     Continuing the previous example:</p>
                   5991: <pre class="programlisting">
                   5992: RCD_SCRIPTS+=   cupsd
                   5993: </pre>
                   5994: </li>
                   5995: </ol></div>
                   5996: <p>Once this is done, pkginstall will do the following steps for each
                   5997: script in an automated fashion:</p>
                   5998: <div class="orderedlist"><ol type="1">
                   5999: <li><p>Process the file found in the files directory applying all the
                   6000:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6001:     variable.</p></li>
                   6002: <li><p>Copy the script from the files directory to the examples
                   6003:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6004:     that this master file must be explicitly registered in the
                   6005:     <code class="filename">PLIST</code>.</p></li>
                   6006: <li><p>Add code to the installation scripts to copy the startup script
                   6007:     from the examples hierarchy into the system-wide startup scripts
                   6008:     directory.</p></li>
                   6009: </ol></div>
                   6010: <div class="sect2" lang="en">
                   6011: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6012: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6013: <p>The automatic copying of config files can be toggled by setting the
                   6014: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6015: installation.  Note that the scripts will be always copied inside the
                   6016: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6017: matter what the value of this variable is.</p>
                   6018: </div>
                   6019: </div>
                   6020: <div class="sect1" lang="en">
                   6021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6022: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6023: <p>If a package needs to create special users and/or groups during
                   6024: installation, it can do so by using the pkginstall framework.</p>
                   6025: <p>Users can be created by adding entries to the
                   6026: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6027: syntax:</p>
                   6028: <pre class="programlisting">
                   6029: user:group
                   6030: </pre>
                   6031: <p>Further specification of user details may be done by setting
                   6032: per-user variables.
                   6033: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6034: numeric UID for the user.
                   6035: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6036: user's description or comment.
                   6037: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6038: user's home directory, and defaults to
                   6039: <code class="filename">/nonexistent</code> if not specified.
                   6040: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6041: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6042: not specified.</p>
                   6043: <p>Similarly, groups can be created by adding entries to the
                   6044: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6045: <pre class="programlisting">
                   6046: group
                   6047: </pre>
                   6048: <p>The numeric GID of the group may be set by defining
                   6049: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6050: <p>If a package needs to create the users and groups at an earlier
                   6051: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6052: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6053: indicate the phase before which the users and groups are created.  In
                   6054: this case, the numeric UIDs and GIDs of the created users and groups
                   6055: are automatically hardcoded into the final installation scripts.</p>
                   6056: </div>
                   6057: <div class="sect1" lang="en">
                   6058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6059: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6060: <p>Packages that install system shells should register them in the shell
                   6061: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6062: administrator.  This must be done from the installation scripts to keep
                   6063: binary packages working on any system.  pkginstall provides an easy way to
                   6064: accomplish this task.</p>
                   6065: <p>When a package provides a shell interpreter, it has to set the
                   6066: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6067: add some hooks to the installation scripts to handle it.  Consider the
                   6068: 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>
                   6069: <pre class="programlisting">
                   6070: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6071: </pre>
                   6072: <div class="sect2" lang="en">
                   6073: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6074: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6075: <p>The automatic registration of shell interpreters can be disabled by
                   6076: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6077: environment variable to <code class="literal">NO</code>.</p>
                   6078: </div>
                   6079: </div>
                   6080: <div class="sect1" lang="en">
                   6081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6082: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6083: <p>Packages that install X11 fonts should update the database files
                   6084: that index the fonts within each fonts directory.  This can easily be
                   6085: accomplished within the pkginstall framework.</p>
                   6086: <p>When a package installs X11 fonts, it must list the directories in
                   6087: which fonts are installed in the
                   6088: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6089: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6090: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6091: installation scripts to run the appropriate commands to update the fonts
                   6092: database files within each of those directories.  For convenience, if the
                   6093: directory path is relative, it is taken to be relative to the package's
                   6094: 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>
                   6095: <pre class="programlisting">
                   6096: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6097: </pre>
                   6098: <div class="sect2" lang="en">
                   6099: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6100: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6101: <p>The automatic update of fonts databases can be disabled by
                   6102: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6103: environment variable to <code class="literal">NO</code>.</p>
                   6104: </div>
                   6105: </div>
                   6106: </div>
                   6107: <div class="chapter" lang="en">
                   6108: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6109: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6110: <div class="toc">
                   6111: <p><b>Table of Contents</b></p>
                   6112: <dl>
1.6       rillig   6113: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   6114: <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>
                   6115: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6116: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6117: </dl>
                   6118: </div>
                   6119: <p>Many packages have the ability to be built to support different
                   6120: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6121: in pkgsrc that provides generic handling of those options that
                   6122: determine different ways in which the packages can be built.  It's
                   6123: possible for the user to specify exactly which sets of options will be
                   6124: built into a package or to allow a set of global default options
                   6125: apply.</p>
1.7       rillig   6126: <p>There are two broad classes of behaviors that one might want to
                   6127: control via options.  One is whether some particular feature is
                   6128: enabled in a program that will be built anyway, often by including or
                   6129: not including a dependency on some other package.  The other is
                   6130: whether or not an additional program will be built as part of the
                   6131: package.  Generally, it is better to make a split package for such
                   6132: additional programs instead of using options, because it enables
                   6133: binary packages to be built which can then be added separately.  For
                   6134: example, the foo package might have minimal dependencies (those
                   6135: packages without which foo doesn't make sense), and then the foo-gfoo
                   6136: package might include the GTK frontend program gfoo.  This is better
                   6137: than including a gtk option to foo that adds gfoo, because either that
                   6138: option is default, in which case binary users can't get foo without
                   6139: gfoo, or not default, in which case they can't get gfoo.  With split
                   6140: packages, they can install foo without having GTK, and later decide to
                   6141: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6142: source users too, avoiding the need for rebuilds.</p>
                   6143: <p>Plugins with widely varying dependencies should usually be split
                   6144: instead of options.</p>
                   6145: <p>It is often more work to maintain split packages, especially if
                   6146: the upstream package does not support this.  The decision of split
                   6147: vs. option should be made based on the likelihood that users will want
                   6148: or object to the various pieces, the size of the dependencies that are
                   6149: included, and the amount of work.</p>
                   6150: <p>A further consideration is licensing.  Non-free parts, or parts
                   6151: that depend on non-free dependencies (especially plugins) should
                   6152: almost always be split if feasible.</p>
1.1       dsieger  6153: <div class="sect1" lang="en">
                   6154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6155: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6156: <p>Global default options are listed in
                   6157: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6158: that should be built into every package if that option is supported.
1.4       rillig   6159: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6160: </div>
                   6161: <div class="sect1" lang="en">
                   6162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6163: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6164: </h2></div></div></div>
                   6165: <p>The following example shows how
                   6166: <code class="filename">bsd.options.mk</code> should be used
                   6167: by the hypothetical ``wibble'' package, either in the package
                   6168: <code class="filename">Makefile</code>, or in a file,
                   6169: e.g. <code class="filename">options.mk</code>, that is included by the
                   6170: main package <code class="filename">Makefile</code>.</p>
                   6171: <pre class="programlisting">
                   6172: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6173: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6174: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6175: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6176: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6177: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6178: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6179: 
                   6180: .include "../../mk/bsd.prefs.mk"
                   6181: 
                   6182: # this package was previously named wibble2
                   6183: .if defined(PKG_OPTIONS.wibble2)
                   6184: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6185: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6186:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6187: .endif
                   6188: 
                   6189: .include "../../mk/bsd.options.mk"
                   6190: 
                   6191: # Package-specific option-handling
                   6192: 
                   6193: ###
                   6194: ### FOO support
                   6195: ###
                   6196: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6197: CONFIGURE_ARGS+=    --enable-foo
                   6198: .endif
                   6199: 
                   6200: ###
                   6201: ### LDAP support
                   6202: ###
                   6203: .if !empty(PKG_OPTIONS:Mldap)
                   6204: .  include "../../databases/openldap-client/buildlink3.mk"
                   6205: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6206: .endif
                   6207: 
                   6208: ###
                   6209: ### database support
                   6210: ###
                   6211: .if !empty(PKG_OPTIONS:Mmysql)
                   6212: .  include "../../mk/mysql.buildlink3.mk"
                   6213: .endif
                   6214: .if !empty(PKG_OPTIONS:Mpgsql)
                   6215: .  include "../../mk/pgsql.buildlink3.mk"
                   6216: .endif
                   6217: </pre>
                   6218: <p>The first section contains the information about which build
                   6219: options are supported by the package, and any default options settings
                   6220: if needed.</p>
                   6221: <div class="orderedlist"><ol type="1">
                   6222: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   6223: <a 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
                   6224: options.  It should be set to
                   6225: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6226: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6227: at the point where the options are processed.</p></li>
                   6228: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6229: build options supported by the package.</p></li>
                   6230: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6231: list of names of groups of mutually exclusive options.  The options in
                   6232: each group are listed in
                   6233: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6234: The most specific setting of any option from the group takes
                   6235: precedence over all other options in the group.  Options from the
                   6236: groups will be automatically added to
                   6237: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6238: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6239: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6240: packages will fail if no option from the group is
                   6241: selected.</p></li>
                   6242: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6243: of names of sets of options.  At least one option from each set must
                   6244: be selected.  The options in each set are listed in
                   6245: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6246: Options from the sets will be automatically added to
                   6247: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6248: fail if no option from the set is selected.</p></li>
                   6249: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6250: build options which are enabled by default.</p></li>
                   6251: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6252: of
                   6253: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.4       rillig   6254: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6255: their option counterparts.  Pairs should be added with
                   6256: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6257: warning will be issued if the user uses a legacy
                   6258: variable.</p></li>
                   6259: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6260: of
                   6261: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6262: pairs that map options that have been renamed to their new
                   6263: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6264: the listing of global legacy options.  A warning will be issued if
                   6265: the user uses a legacy option.</p></li>
                   6266: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6267: options implied by deprecated variables used.  This can be used for
                   6268: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6269: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6270: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6271: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6272: a list of warnings about deprecated variables or options used, and
                   6273: what to use instead.</p></li>
                   6274: </ol></div>
                   6275: <p>A package should never modify
                   6276: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6277: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6278: To suggest a default set of options, use
                   6279: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6280: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6281: including <code class="filename">bsd.options.mk</code>.  If none of
                   6282: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6283: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6284: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6285: happen with platform-specific options if none of them is supported on
                   6286: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6287: empty list and the package is otherwise treated as not using the
                   6288: options framework.</p>
                   6289: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6290: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6291: build options, properly filtered to remove unsupported and duplicate
                   6292: options.</p>
                   6293: <p>The remaining sections contain the logic that is specific to
                   6294: each option.  The correct way to check for an option is to check
                   6295: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6296: <pre class="programlisting">
                   6297: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6298: </pre>
                   6299: </div>
                   6300: <div class="sect1" lang="en">
                   6301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6302: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6303: <p>Options that enable similar features in different packages (like
                   6304: optional support for a library) should use a common name in all
                   6305: packages that support it (like the name of the library).  If another
                   6306: package already has an option with the same meaning, use the same
                   6307: name.</p>
                   6308: <p>Options that enable features specific to one package, where it's
                   6309: unlikely that another (unrelated) package has the same (or a similar)
                   6310: optional feature, should use a name prefixed with
                   6311: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6312: <p>If a group of related packages share an optional feature
                   6313: specific to that group, prefix it with the name of the
                   6314: &#8220;<span class="quote">main</span>&#8221; package
                   6315: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6316: <p>For new options, add a line to
                   6317: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6318: fields, separated by tab.  The first field is the option name, the
                   6319: second its description.  The description should be a whole sentence
                   6320: (starting with an uppercase letter and ending with a period) that
                   6321: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6322: support.</span>&#8221; The file is sorted by option names.</p>
                   6323: </div>
1.7       rillig   6324: <div class="sect1" lang="en">
                   6325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6326: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   6327: <p>When writing <a href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   6328: different dependencies based on the options with which the package was
                   6329: built. For querying these options, the file
                   6330: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6331: typical example looks like this:</p>
                   6332: <pre class="programlisting">
                   6333: pkgbase := libpurple
                   6334: .include "../../mk/pkg-build-options.mk"
                   6335: 
                   6336: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6337: ...
                   6338: .endif
                   6339: </pre>
                   6340: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6341: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6342: options of the libpurple package, which can then be queried like
                   6343: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6344: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6345: details.</p>
                   6346: </div>
1.1       dsieger  6347: </div>
                   6348: <div class="chapter" lang="en">
                   6349: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6350: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6351: <div class="toc">
                   6352: <p><b>Table of Contents</b></p>
                   6353: <dl>
1.6       rillig   6354: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6355: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6356: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6357: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
                   6358: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6359: <dd><dl>
                   6360: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6361: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6362: </dl></dd>
                   6363: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6364: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6365: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6366: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6367: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6368: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6369: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6370: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6371: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6372: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6373: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6374: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6375: </dl>
                   6376: </div>
                   6377: <div class="sect1" lang="en">
                   6378: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6379: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6380: <p>This chapter gives a detailed description on how a package is
                   6381:     built. Building a package is separated into different
                   6382:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6383:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6384:     described in the following sections. Each phase is splitted into
                   6385:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6386:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6387:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6388:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6389:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6390: <p>Never override the regular targets (like
                   6391:     <code class="varname">fetch</code>), if you have to, override the
                   6392:     <code class="varname">do-*</code> ones instead.</p>
                   6393: <p>The basic steps for building a program are always the same.  First
                   6394:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6395:     the local system and then extracted. After any pkgsrc-specific patches
                   6396:     to compile properly are applied, the software can be configured, then
                   6397:     built (usually by compiling), and finally the generated binaries, etc.
                   6398:     can be put into place on the system.</p>
                   6399: <p>To get more details about what is happening at each step,
                   6400:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6401:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6402:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6403: </div>
                   6404: <div class="sect1" lang="en">
                   6405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6406: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6407: <p>Before outlining the process performed by the NetBSD package system in
                   6408:     the next section, here's a brief discussion on where programs are
                   6409:     installed, and which variables influence this.</p>
                   6410: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6411:     where all files of the final program shall be installed. It is
                   6412:     usually set to <code class="varname">LOCALBASE</code>
                   6413:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6414:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6415:     <code class="varname">PREFIX</code> needs to be put
                   6416:     into the various places in the program's source where paths to
1.6       rillig   6417:     these files are encoded.  See <a href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a 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.1       dsieger  6418: <p>When choosing which of these variables to use,
                   6419:     follow the following rules:</p>
                   6420: <div class="itemizedlist"><ul type="disc">
                   6421: <li><p><code class="varname">PREFIX</code> always points to the location
                   6422:        where the current pkg will be installed.  When referring to a
                   6423:        pkg's own installation path, use
                   6424:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6425: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6426:        are installed.  If you need to construct a -I or -L argument
                   6427:        to the compiler to find includes and libraries installed by
                   6428:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
                   6429:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6430:        installed all packages in <code class="filename">/usr/local</code>. As
                   6431:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6432:        administrator, this variable is a misnomer.</p></li>
                   6433: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6434:        distribution (from xsrc, etc.) is installed. When looking for
                   6435:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6436:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6437: <li>
                   6438: <p>X11-based packages are special in that they may be
                   6439:        installed in either <code class="varname">X11BASE</code> or
                   6440:        <code class="varname">LOCALBASE</code>.</p>
                   6441: <p>Usually, X11 packages should be installed under
                   6442:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6443:        will need to include
                   6444:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6445:        request the presence of X11 and to get the right compilation
                   6446:        flags.</p>
                   6447: <p>Even though, there are some packages that cannot be installed
                   6448:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6449:        files. These packages are special and they must be placed under
                   6450:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6451:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6452:        your package.</p>
                   6453: <p>Some notes: If you need
                   6454:        to find includes or libraries installed by a pkg that has
                   6455:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6456:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6457:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6458:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6459:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6460:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6461:        is enabled by default.</p>
                   6462: </li>
                   6463: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6464:        the installed location of an X11
                   6465:        package. <code class="varname">X11PREFIX</code> will be set to
                   6466:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6467:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6468:        installed.</p></li>
                   6469: <li>
                   6470: <p>If xpkgwedge is installed, it is possible to have some
                   6471:        packages installed in <code class="varname">X11BASE</code> and some in
                   6472:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6473:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6474:        definition can be used. It takes pairs in the format
                   6475:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   6476:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6477:        of the installed package &lt;package&gt;, or
                   6478:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6479:        installed.</p>
                   6480: <p>This is best illustrated by example.</p>
                   6481: <p>The following lines are taken from
                   6482:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6483: <pre class="programlisting">
                   6484: EVAL_PREFIX+=           GTKDIR=gtk+
                   6485: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6486: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6487: CONFIGURE_ARGS+=        --enable-multibyte
                   6488: </pre>
                   6489: <p>Specific defaults can be defined for the packages
                   6490:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6491:        definition of the form:</p>
                   6492: <pre class="programlisting">
                   6493: GTKDIR_DEFAULT= ${LOCALBASE}
                   6494: </pre>
                   6495: <p>where <code class="varname">GTKDIR</code> corresponds
                   6496:        to the first definition in
                   6497:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6498: </li>
                   6499: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
                   6500:        install files according to <a 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
                   6501:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6502:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6503: </ul></div>
                   6504: </div>
                   6505: <div class="sect1" lang="en">
                   6506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6507: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.1       dsieger  6508: <p>When building a package, a number of directories is used to store
                   6509:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6510:     directories are explained here.</p>
                   6511: <p>Some of the directory variables contain relative pathnames. There
                   6512:     are two common base directories for these relative directories:
                   6513:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6514:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6515:     inside the package itself.</p>
                   6516: <div class="variablelist"><dl>
                   6517: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6518: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6519:       root directory. Generally, you don't need
                   6520:       it.</p></dd>
                   6521: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6522: <dd><p>This is an absolute pathname that points to the
                   6523:       current package.</p></dd>
                   6524: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6525: <dd><p>This is a pathname relative to
                   6526:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6527:       package.</p></dd>
                   6528: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6529: <dd><p>This is an absolute pathname pointing to the directory
                   6530:       where all work takes place. The distfiles are extracted to this
                   6531:       directory. It also contains temporary directories and log files used by
                   6532:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6533:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6534: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6535: <dd><p>This is an absolute pathname pointing to the directory
                   6536:       where the distfiles are extracted. It is usually a direct subdirectory
                   6537:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6538:       that isn't hidden. This variable may be changed by a package
                   6539:       <code class="filename">Makefile</code>.</p></dd>
                   6540: </dl></div>
                   6541: </div>
                   6542: <div class="sect1" lang="en">
                   6543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6544: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.1       dsieger  6545: <p>You can run a particular phase by typing <span><strong class="command">make
                   6546:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6547:     phase. This will automatically run all phases that are required for this
                   6548:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   6549:     run <span><strong class="command">make</strong></span> without parameters in a package directory,
                   6550:     the package will be built, but not installed.</p>
                   6551: </div>
                   6552: <div class="sect1" lang="en">
                   6553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6554: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6555: <p>The first step in building a package is to fetch the
                   6556:     distribution files (distfiles) from the sites that are providing
                   6557:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6558:     phase.</p>
                   6559: <div class="sect2" lang="en">
                   6560: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6561: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1       dsieger  6562: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6563:       defines all URLs from where the distfile, whose name is
                   6564:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6565:       fetched. The more complicated cases are described
                   6566:       below.</p>
                   6567: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6568:       the list of distfiles that have to be fetched. Its value
                   6569:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6570:       so that most packages don't need to define it at all.
                   6571:       <code class="varname">EXTRACT_SUFX</code> is
                   6572:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6573:       freely. Note that if your package requires additional
                   6574:       distfiles to the default one, you cannot just append the
                   6575:       additional filenames using the <code class="literal">+=</code>
                   6576:       operator, but you have write for example:</p>
                   6577: <pre class="programlisting">
                   6578: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6579: </pre>
                   6580: <p>Each distfile is fetched from a list of sites, usually
                   6581:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6582:       <code class="varname">DISTFILES</code> or multiple
                   6583:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6584:       set
                   6585:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6586:       to the list of URLs where the file
                   6587:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6588:       (including the suffix) can be found.</p>
                   6589: <pre class="programlisting">
                   6590: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6591: DISTFILES+=     foo-file.tar.gz
                   6592: SITES.foo-file.tar.gz= \
                   6593: http://www.somewhere.com/somehow/ \
                   6594: http://www.somewhereelse.com/mirror/somehow/
                   6595: </pre>
                   6596: <p>When actually fetching the distfiles, each item from
                   6597:       <code class="varname">MASTER_SITES</code> or
                   6598:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6599:       appended to it, without an intermediate slash. Therefore,
                   6600:       all site values have to end with a slash or other separator
                   6601:       character. This allows for example to set
                   6602:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6603:       that gets the name of the distfile as a parameter. In this
                   6604:       case, the definition would look like:</p>
                   6605: <pre class="programlisting">
                   6606: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6607: </pre>
                   6608: <p>There are some predefined values for
                   6609:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6610:       packages.  The names of the variables should speak for
                   6611:       themselves.</p>
                   6612: <pre class="programlisting">
                   6613: ${MASTER_SITE_APACHE}
                   6614: ${MASTER_SITE_BACKUP}
                   6615: ${MASTER_SITE_CYGWIN}
                   6616: ${MASTER_SITE_DEBIAN}
                   6617: ${MASTER_SITE_FREEBSD}
                   6618: ${MASTER_SITE_FREEBSD_LOCAL}
                   6619: ${MASTER_SITE_GENTOO}
                   6620: ${MASTER_SITE_GNOME}
                   6621: ${MASTER_SITE_GNU}
                   6622: ${MASTER_SITE_GNUSTEP}
                   6623: ${MASTER_SITE_IFARCHIVE}
                   6624: ${MASTER_SITE_KDE}
                   6625: ${MASTER_SITE_MOZILLA}
                   6626: ${MASTER_SITE_MYSQL}
                   6627: ${MASTER_SITE_OPENOFFICE}
                   6628: ${MASTER_SITE_PERL_CPAN}
                   6629: ${MASTER_SITE_PGSQL}
                   6630: ${MASTER_SITE_R_CRAN}
                   6631: ${MASTER_SITE_SOURCEFORGE}
                   6632: ${MASTER_SITE_SOURCEFORGE_JP}
                   6633: ${MASTER_SITE_SUNSITE}
                   6634: ${MASTER_SITE_SUSE}
                   6635: ${MASTER_SITE_TEX_CTAN}
                   6636: ${MASTER_SITE_XCONTRIB}
                   6637: ${MASTER_SITE_XEMACS}
                   6638: </pre>
                   6639: <p>Some explanations for the less self-explaining ones:
                   6640:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   6641:       for packages that are maintained in <a 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
                   6642:       package source distributions that are maintained in <a 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>
                   6643: <p>If you choose one of these predefined sites, you may
                   6644:       want to specify a subdirectory of that site. Since these
                   6645:       macros may expand to more than one actual site, you
                   6646:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6647:       specify a subdirectory:</p>
                   6648: <pre class="programlisting">
                   6649: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6650: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6651: </pre>
                   6652: <p>Note the trailing slash after the subdirectory
                   6653:       name.</p>
                   6654: </div>
                   6655: <div class="sect2" lang="en">
                   6656: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6657: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6658: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6659:       all the distfiles exist in a local directory
                   6660:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6661:       user). If the files do not exist, they are fetched using
                   6662:       commands of the form</p>
                   6663: <pre class="programlisting">
                   6664: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6665: </pre>
                   6666: <p>where <code class="literal">${site}</code> varies through
                   6667:       several possibilities in turn: first,
                   6668:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6669:       sites specified in either <code class="varname">SITES.file</code> if
                   6670:       defined, else <code class="varname">MASTER_SITES</code> or
                   6671:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6672:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6673:       all except the first and the last can be optionally sorted
                   6674:       by the user, via setting either
                   6675:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6676:       <code class="varname">MASTER_SORT_AWK</code> or
                   6677:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   6678: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6679:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6680:       distfiles, if they are freely distributable.  Packages setting
                   6681:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6682:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6683:       mirrored.</p>
                   6684: </div>
                   6685: </div>
                   6686: <div class="sect1" lang="en">
                   6687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6688: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6689: <p>After the distfile(s) are fetched, their checksum is
                   6690:     generated and compared with the checksums stored in the
                   6691:     distinfo file. If the checksums don't match, the build is
                   6692:     aborted. This is to ensure the same distfile is used for
                   6693:     building, and that the distfile wasn't changed, e.g. by some
                   6694:     malign force, deliberately changed distfiles on the master
                   6695:     distribution site or network lossage.</p>
                   6696: </div>
                   6697: <div class="sect1" lang="en">
                   6698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6699: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6700: <p>When the distfiles are present on the local system, they
                   6701:     need to be extracted, as they usually come in the form of some
                   6702:     compressed archive format.</p>
                   6703: <p>By default, all <code class="varname">DISTFILES</code> are
                   6704:     extracted. If you only need some of them, you can set the
                   6705:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6706:     files.</p>
                   6707: <p>Extracting the files is usually done by a little
                   6708:     program, <code class="filename">mk/extract/extract</code>, which
                   6709:     already knows how to extract various archive formats, so most
                   6710:     likely you will not need to change anything here. But if you
                   6711:     need, the following variables may help you:</p>
                   6712: <div class="variablelist"><dl>
                   6713: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6714: <dd><p>Use these variables to override the default
                   6715:       options for an extract command, which are defined in
                   6716:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6717: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6718: <dd><p>This variable can be set to
                   6719:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6720:       default value), <code class="literal">pax</code>, or an
                   6721:       absolute pathname pointing to the command with which tar
                   6722:       archives should be
                   6723:       extracted.</p></dd>
                   6724: </dl></div>
                   6725: <p>If the <code class="filename">extract</code> program doesn't
                   6726:     serve your needs, you can also override the
                   6727:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6728:     command used for extracting the files. This command is
                   6729:     executed in the <code class="filename">${WRKSRC}</code>
                   6730:     directory. During execution of this command, the shell
                   6731:     variable <code class="varname">extract_file</code> holds the absolute
                   6732:     pathname of the file that is going to be extracted.</p>
                   6733: <p>And if that still does not suffice, you can override the
                   6734:     <code class="varname">do-extract</code> target in the package
                   6735:     Makefile.</p>
                   6736: </div>
                   6737: <div class="sect1" lang="en">
                   6738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6739: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6740: <p>After extraction, all the patches named by the
                   6741:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6742:     subdirectory of the package as well as in
                   6743:     $LOCALPATCHES/$PKGPATH (e.g.
                   6744:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6745:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6746:     <code class="filename">.gz</code> are uncompressed before they are
                   6747:     applied, files ending in <code class="filename">.orig</code> or
                   6748:     <code class="filename">.rej</code> are ignored. Any special options to
                   6749:     <a 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
1.6       rillig   6750:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
1.1       dsieger  6751: <p>By default <a 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
                   6752:     it fail if the patches apply with some lines of fuzz. Please
                   6753:     fix (regen) the patches so that they apply cleanly. The
                   6754:     rationale behind this is that patches that don't apply cleanly
                   6755:     may end up being applied in the wrong place, and cause severe
                   6756:     harm there.</p>
                   6757: </div>
                   6758: <div class="sect1" lang="en">
                   6759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6760: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6761: <p>This is covered in <a href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1       dsieger  6762:     </p>
                   6763: </div>
                   6764: <div class="sect1" lang="en">
                   6765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6766: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6767: <p>This phase creates wrapper programs for the compilers and
                   6768:     linkers. The following variables can be used to tweak the
                   6769:     wrappers.</p>
                   6770: <div class="variablelist"><dl>
                   6771: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6772: <dd><p>The command used to print progress
                   6773:       messages. Does nothing by default. Set to
                   6774:       <code class="literal">${ECHO}</code> to see the progress
                   6775:       messages.</p></dd>
                   6776: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6777: <dd><p>This variable can be set to
                   6778:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6779:       depending on whether you want additional information in the
                   6780:       wrapper log file.</p></dd>
                   6781: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6782: <dd><p>This variable can be set to
                   6783:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6784:       on whether the wrapper should use its cache, which will
                   6785:       improve the speed. The default value is
                   6786:       <code class="literal">yes</code>, but is forced to
                   6787:       <code class="literal">no</code> if the platform does not support
                   6788:       it.</p></dd>
                   6789: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6790: <dd><p>A list of reordering commands. A reordering
                   6791:       command has the form
                   6792:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6793:       It ensures that that
                   6794:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6795:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6796:       </p></dd>
                   6797: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6798: <dd><p>A list of transformation commands. [TODO:
                   6799:       investigate further]</p></dd>
                   6800: </dl></div>
                   6801: </div>
                   6802: <div class="sect1" lang="en">
                   6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6804: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6805: <p>Most pieces of software need information on the header
                   6806:     files, system calls, and library routines which are available
                   6807:     on the platform they run on. The process of determining this
                   6808:     information is known as configuration, and is usually
                   6809:     automated. In most cases, a script is supplied with the
                   6810:     distfiles, and its invocation results in generation of header
                   6811:     files, Makefiles, etc.</p>
                   6812: <p>If the package contains a configure script, this can be
                   6813:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6814:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6815:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6816:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6817:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6818: <pre class="programlisting">
                   6819: .for d in ${CONFIGURE_DIRS}
                   6820:         cd ${WRKSRC} \
                   6821:         &amp;&amp; cd ${d} \
                   6822:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6823: .endfor
                   6824: </pre>
                   6825: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6826:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6827:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6828:     configure script is run with the environment
                   6829:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6830:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6831:     <code class="varname">CONFIGURE_ENV</code>,
                   6832:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6833:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6834:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6835:     package.</p>
                   6836: <p>If the program uses an <code class="filename">Imakefile</code>
                   6837:     for configuration, the appropriate steps can be invoked by
                   6838:     setting <code class="varname">USE_IMAKE</code> to
                   6839:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6840:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   6841:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6842:     xmkmf's environment by adding them to the
                   6843:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   6844: <p>If there is no configure step at all, set
                   6845:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
                   6846: </div>
                   6847: <div class="sect1" lang="en">
                   6848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6849: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6850: <p>For building a package, a rough equivalent of the
                   6851:     following code is executed.</p>
                   6852: <pre class="programlisting">
                   6853: .for d in ${BUILD_DIRS}
                   6854:         cd ${WRKSRC} \
                   6855:         &amp;&amp; cd ${d} \
                   6856:         &amp;&amp; env ${MAKE_ENV} \
                   6857:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6858:                 -f ${MAKE_FILE} \
                   6859:                 ${BUILD_TARGET}
                   6860: .endfor
                   6861: </pre>
                   6862: <p><code class="varname">BUILD_DIRS</code> (default:
                   6863:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6864:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6865:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6866:     <code class="varname">MAKE_ENV</code> and arguments
                   6867:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6868:     <code class="varname">MAKE_ENV</code>,
                   6869:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6870:     <code class="varname">MAKE_FILE</code> and
                   6871:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6872:     package.</p>
                   6873: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   6874:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6875:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6876:     default value of <code class="varname">MAKE_FILE</code> is
                   6877:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6878:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
                   6879: <p>If there is no build step at all, set
                   6880:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
                   6881: </div>
                   6882: <div class="sect1" lang="en">
                   6883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6884: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  6885: <p>[TODO]</p>
                   6886: </div>
                   6887: <div class="sect1" lang="en">
                   6888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6889: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  6890: <p>Once the build stage has completed, the final step is to
                   6891:     install the software in public directories, so users can
                   6892:     access the programs and files.</p>
                   6893: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   6894:     equivalent of the following code is executed. Additionally,
                   6895:     before and after this code, much magic is performed to do
                   6896:     consistency checks, registering the package, and so on.</p>
                   6897: <pre class="programlisting">
                   6898: .for d in ${INSTALL_DIRS}
                   6899:         cd ${WRKSRC} \
                   6900:         &amp;&amp; cd ${d} \
                   6901:         &amp;&amp; env ${MAKE_ENV} \
                   6902:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6903:                 -f ${MAKE_FILE} \
                   6904:                 ${INSTALL_TARGET}
                   6905: .endfor
                   6906: </pre>
                   6907: <p>The variable's meanings are analogous to the ones in the
                   6908:     <span class="emphasis"><em>build</em></span> phase.
                   6909:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6910:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6911:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6912:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6913:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6914:     defined.</p>
                   6915: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   6916:     variables are useful. They are all variations of the
                   6917:     <a 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
                   6918:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6919:     install command. The specialized variants, together with their
                   6920:     intended use, are:</p>
                   6921: <div class="variablelist"><dl>
                   6922: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   6923: <dd><p>directories that contain
                   6924:       binaries</p></dd>
                   6925: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   6926: <dd><p>directories that contain
                   6927:       scripts</p></dd>
                   6928: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   6929: <dd><p>directories that contain shared and static
                   6930:       libraries</p></dd>
                   6931: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   6932: <dd><p>directories that contain data
                   6933:       files</p></dd>
                   6934: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   6935: <dd><p>directories that contain man
                   6936:       pages</p></dd>
                   6937: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   6938: <dd><p>binaries that can be stripped from debugging
                   6939:       symbols</p></dd>
                   6940: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   6941: <dd><p>binaries that cannot be
                   6942:       stripped</p></dd>
                   6943: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   6944: <dd><p>game
                   6945:       binaries</p></dd>
                   6946: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   6947: <dd><p>shared and static
                   6948:       libraries</p></dd>
                   6949: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6950: <dd><p>data files</p></dd>
                   6951: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   6952: <dd><p>data files for
                   6953:       games</p></dd>
                   6954: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6955: <dd><p>man pages</p></dd>
                   6956: </dl></div>
                   6957: <p>Some other variables are:</p>
                   6958: <div class="variablelist"><dl>
                   6959: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6960: <dd><p>A list of directories relative to
                   6961:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6962:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6963:       The package is supposed to create all needed directories itself
                   6964:       before installing files to it and list all other directories here.
                   6965:       </p></dd>
                   6966: </dl></div>
                   6967: <p>In the rare cases that a package shouldn't install anything,
                   6968:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   6969:     mostly relevant for packages in the <code class="filename">regress</code>
                   6970:     category.</p>
                   6971: </div>
                   6972: <div class="sect1" lang="en">
                   6973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6974: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  6975: <p>Once the install stage has completed, a binary package of
                   6976:     the installed files can be built.  These binary packages can be
                   6977:     used for quick installation without previous compilation, e.g. by
                   6978:     the <span><strong class="command">make bin-install</strong></span> or by using
                   6979:     <span><strong class="command">pkg_add</strong></span>.</p>
                   6980: <p>By default, the binary packages are created in
                   6981:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6982:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6983:     one for each category in the <code class="varname">CATEGORIES</code>
                   6984:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6985:     <code class="filename">pkgsrc/packages</code>.</p>
                   6986: <p>If there should be no binary package, set
                   6987:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   6988:     This should only be used in rare cases, like when a package
                   6989:     definitely is only usable on the machine where it is built and even
                   6990:     then, a binary package can be useful.</p>
                   6991: </div>
                   6992: <div class="sect1" lang="en">
                   6993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6994: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  6995: <p>Once you're finished with a package, you can clean the work
                   6996:     directory by running <span><strong class="command">make clean</strong></span>.  If you want
                   6997:     to clean the work directories of all dependencies too, use
                   6998:     <span><strong class="command">make clean-depends</strong></span>.</p>
                   6999: </div>
                   7000: <div class="sect1" lang="en">
                   7001: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7002: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1       dsieger  7003: <div class="variablelist"><dl>
                   7004: <dt><span class="term">pre/post-*</span></dt>
                   7005: <dd><p>For any of the main targets described in the
                   7006:          previous section, two auxiliary targets exist with
                   7007:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7008:          prefix for the main target's name.  These targets are
                   7009:          invoked before and after the main target is called,
                   7010:          allowing extra configuration or installation steps be
                   7011:          performed from a package's Makefile, for example, which
                   7012:          a program's configure script or install target
                   7013:          omitted.</p></dd>
                   7014: <dt><span class="term">do-*</span></dt>
                   7015: <dd><p>Should one of the main targets do the wrong thing,
                   7016:          and should there be no variable to fix this, you can
                   7017:          redefine it with the do-* target.  (Note that redefining
                   7018:          the target itself instead of the do-* target is a bad
                   7019:          idea, as the pre-* and post-* targets won't be called
                   7020:          anymore, etc.) You will not usually need to do
                   7021:          this.</p></dd>
                   7022: <dt><span class="term">reinstall</span></dt>
                   7023: <dd>
                   7024: <p>If you did a <span><strong class="command">make install</strong></span> and
                   7025:          you noticed some file was not installed properly, you
                   7026:          can repeat the installation with this target, which will
                   7027:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7028: <p>This is the default value of
                   7029:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   7030:          <span><strong class="command">make update</strong></span> and <span><strong class="command">make
                   7031:          package</strong></span>, where the defaults are
                   7032:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7033:          respectively.</p>
                   7034: </dd>
                   7035: <dt><span class="term">deinstall</span></dt>
                   7036: <dd>
                   7037: <p>This target does a <a 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
                   7038:          current directory, effectively de-installing the
                   7039:          package. The following variables can be used to tune the
                   7040:          behaviour:</p>
                   7041: <div class="variablelist"><dl>
                   7042: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   7043: <dd><p>Add a "-v" to the <a 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>
                   7044: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7045: <dd><p>Remove all packages that require (depend on)
                   7046:                the given package.  This can be used to remove any
                   7047:                packages that may have been pulled in by a given
                   7048:                package, e.g. if <span><strong class="command">make deinstall
                   7049:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7050:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7051:                likely to remove whole KDE. Works by adding
                   7052:                &#8220;<span class="quote">-R</span>&#8221; to the <a 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>
                   7053:                command line.</p></dd>
                   7054: </dl></div>
                   7055: </dd>
                   7056: <dt><span class="term">bin-install</span></dt>
                   7057: <dd><p>Install a binary package from local disk and via FTP
                   7058:          from a list of sites (see the
                   7059:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   7060:          <span><strong class="command">make package</strong></span> if no binary package is
                   7061:          available anywhere.  The arguments given to
                   7062:          <span><strong class="command">pkg_add</strong></span> can be set via
                   7063:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7064:          operation, etc.</p></dd>
                   7065: <dt><span class="term">update</span></dt>
                   7066: <dd>
                   7067: <p>This target causes the current package to be
                   7068:          updated to the latest version.  The package and all
                   7069:          depending packages first get de-installed, then current
                   7070:          versions of the corresponding packages get compiled and
                   7071:          installed.  This is similar to manually noting which
                   7072:          packages are currently installed, then performing a
                   7073:          series of <span><strong class="command">make deinstall</strong></span> and
                   7074:          <span><strong class="command">make install</strong></span> (or whatever
                   7075:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7076:          packages.</p>
                   7077: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
                   7078:          resume package updating in case a previous <span><strong class="command">make
                   7079:          update</strong></span> was interrupted for some reason.
                   7080:          However, in this case, make sure you don't call
                   7081:          <span><strong class="command">make clean</strong></span> or otherwise remove the
                   7082:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7083:          Otherwise, you lose the ability to automatically update
                   7084:          the current package along with the dependent packages
                   7085:          you have installed.</p>
                   7086: <p>Resuming an interrupted <span><strong class="command">make
                   7087:          update</strong></span> will only work as long as the package
                   7088:          tree remains unchanged.  If the source code for one of
                   7089:          the packages to be updated has been changed, resuming
                   7090:          <span><strong class="command">make update</strong></span> will most certainly
                   7091:          fail!</p>
                   7092: <p>The following variables can be used either on the
1.4       rillig   7093:          command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7094:          alter the behaviour of <span><strong class="command">make
                   7095:          update</strong></span>:</p>
                   7096: <div class="variablelist"><dl>
                   7097: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7098: <dd><p>Install target to recursively use for the
                   7099:                updated package and the dependent packages.
                   7100:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7101:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
                   7102:                <span><strong class="command">make update</strong></span>.  Other good
                   7103:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7104:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7105:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7106:                endless loop!</p></dd>
                   7107: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7108: <dd><p>Don't clean up after updating.  Useful if
                   7109:                you want to leave the work sources of the updated
                   7110:                packages around for inspection or other purposes.
                   7111:                Be sure you eventually clean up the source tree
                   7112:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7113:                or you may run into troubles with old source code
                   7114:                still lying around on your next
                   7115:                <span><strong class="command">make</strong></span> or <span><strong class="command">make
                   7116:                update</strong></span>.</p></dd>
                   7117: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7118: <dd><p>Deinstall each package before installing
                   7119:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7120:                may be necessary if the
                   7121:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
                   7122:                called after interrupting a running <span><strong class="command">make
                   7123:                update</strong></span>.</p></dd>
                   7124: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7125: <dd><p>Allows you to disable recursion and hardcode
                   7126:                the target for packages.  The default is
                   7127:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7128:                facilitating a recursive update of prerequisite
                   7129:                packages.  Only set
                   7130:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7131:                disable recursive updates. Use
                   7132:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7133:                set a specific target for each package to be
                   7134:                installed during <span><strong class="command">make update</strong></span>
                   7135:                (see above).</p></dd>
                   7136: </dl></div>
                   7137: </dd>
                   7138: <dt><span class="term">clean-update</span></dt>
                   7139: <dd>
                   7140: <p>Clean the source tree for all packages that would
                   7141:          get updated if <span><strong class="command">make update</strong></span> was called
                   7142:          from the current directory.  This target should not be
                   7143:          used if the current package (or any of its depending
                   7144:          packages) have already been de-installed (e.g., after
                   7145:          calling <span><strong class="command">make update</strong></span>) or you may lose
                   7146:          some packages you intended to update. As a rule of
                   7147:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   7148:          the first time you run <span><strong class="command">make update</strong></span>
                   7149:          and only if you have a dirty package tree (e.g., if you
                   7150:          used <code class="varname">NOCLEAN</code>).</p>
                   7151: <p>If you are unsure about whether your tree is
                   7152:          clean, you can either perform a <span><strong class="command">make
                   7153:          clean</strong></span> at the top of the tree, or use the
                   7154:          following sequence of commands from the directory of the
                   7155:          package you want to update (<span class="emphasis"><em>before</em></span>
                   7156:          running <span><strong class="command">make update</strong></span> for the first
                   7157:          time, otherwise you lose all the packages you wanted to
                   7158:          update!):</p>
                   7159: <pre class="screen">
                   7160: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7161: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7162: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7163:          </pre>
                   7164: <p>The following variables can be used either on the
1.4       rillig   7165:          command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7166:          <span><strong class="command">make clean-update</strong></span>:</p>
1.1       dsieger  7167: <div class="variablelist"><dl>
                   7168: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   7169: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
                   7170:                reconstruct the list of directories to update for
                   7171:                this package.  Only use this if <span><strong class="command">make
                   7172:                update</strong></span> successfully installed all
                   7173:                packages you wanted to update.  Normally, this is
                   7174:                done automatically on <span><strong class="command">make
                   7175:                update</strong></span>, but may have been suppressed by
                   7176:                the <code class="varname">NOCLEAN</code> variable (see
                   7177:                above).</p></dd>
                   7178: </dl></div>
                   7179: </dd>
                   7180: <dt><span class="term">replace</span></dt>
                   7181: <dd>
                   7182: <p>Update the installation of the current package.  This
                   7183:          differs from update in that it does not replace dependent
                   7184:          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
                   7185:          target to work.</p>
                   7186: <p><span class="emphasis"><em>Be careful when using this
                   7187:          target!</em></span> There are no guarantees that dependent
                   7188:          packages will still work, in particular they will most
                   7189:          certainly break if you <span><strong class="command">make replace</strong></span> a
                   7190:          library package whose shared library major version changed
                   7191:          between your installed version and the new one.  For this
                   7192:          reason, this target is not officially supported and only
                   7193:          recommended for advanced users.</p>
                   7194: </dd>
                   7195: <dt><span class="term">info</span></dt>
                   7196: <dd><p>This target invokes <a 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
                   7197:          package. You can use this to check which version of a
                   7198:          package is installed.</p></dd>
                   7199: <dt><span class="term">index</span></dt>
                   7200: <dd>
                   7201: <p>This is a top-level command, i.e. it should be used in
                   7202:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7203:          database of all packages in the local pkgsrc tree, including
                   7204:          dependencies, comment, maintainer, and some other useful
                   7205:          information.  Individual entries are created by running
                   7206:          <span><strong class="command">make describe</strong></span> in the packages'
                   7207:          directories.  This index file is saved as
                   7208:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   7209:          verbose format by running <span><strong class="command">make
                   7210:          print-index</strong></span>.  You can search in it with
                   7211:          <span><strong class="command">make search
                   7212:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7213:          extract a list of all packages that depend on a particular
                   7214:          one by running <span><strong class="command">make show-deps
                   7215:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7216: <p>Running this command takes a very long time, some
                   7217:          hours even on fast machines!</p>
                   7218: </dd>
                   7219: <dt><span class="term">readme</span></dt>
                   7220: <dd>
                   7221: <p>This target generates a
                   7222:          <code class="filename">README.html</code> file, which can be
                   7223:          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
                   7224:          contain references to any packages which are in the
                   7225:          <code class="varname">PACKAGES</code> directory on the local
                   7226:          host. The generated files can be made to refer to URLs
                   7227:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7228:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7229:          wanted to generate <code class="filename">README.html</code>
                   7230:          files which pointed to binary packages on the local
                   7231:          machine, in the directory
                   7232:          <code class="filename">/usr/packages</code>, set
                   7233:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7234:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7235:          <code class="varname">${PACKAGES}</code> directory and its
                   7236:          subdirectories will be searched for all the binary
                   7237:          packages.</p>
                   7238: <p>The target can be run at the toplevel or in category
                   7239:          directories, in which case it descends recursively.</p>
                   7240: </dd>
                   7241: <dt><span class="term">readme-all</span></dt>
                   7242: <dd><p>This is a top-level command, run it in
                   7243:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7244:          file <code class="filename">README-all.html</code> which contains a
                   7245:          list of all packages currently available in the NetBSD
                   7246:          Packages Collection, together with the category they belong
                   7247:          to and a short description. This file is compiled from the
                   7248:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   7249:          to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
                   7250:          readme</strong></span>.</p></dd>
                   7251: <dt><span class="term">cdrom-readme</span></dt>
                   7252: <dd><p>This is very much the same as the
                   7253:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7254:          used when generating a pkgsrc tree to be written to a
                   7255:          CD-ROM.  This target also produces
                   7256:          <code class="filename">README.html</code> files, and can be made
                   7257:          to refer to URLs based on
                   7258:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7259:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7260: <dt><span class="term">show-distfiles</span></dt>
                   7261: <dd><p>This target shows which distfiles and patchfiles
                   7262:          are needed to build the package
                   7263:          (<code class="varname">ALLFILES</code>, which contains all
                   7264:          <code class="varname">DISTFILES</code> and
                   7265:          <code class="varname">PATCHFILES</code>, but not
                   7266:          <code class="filename">patches/*</code>).</p></dd>
                   7267: <dt><span class="term">show-downlevel</span></dt>
                   7268: <dd><p>This target shows nothing if the package is not
                   7269:          installed. If a version of this package is installed,
                   7270:          but is not the version provided in this version of
                   7271:          pkgsrc, then a warning message is displayed. This target
                   7272:          can be used to show which of your installed packages are
                   7273:          downlevel, and so the old versions can be deleted, and
                   7274:          the current ones added.</p></dd>
                   7275: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7276: <dd><p>This target shows the directory in the pkgsrc
                   7277:          hierarchy from which the package can be built and
                   7278:          installed. This may not be the same directory as the one
                   7279:          from which the package was installed. This target is
                   7280:          intended to be used by people who may wish to upgrade
                   7281:          many packages on a single host, and can be invoked from
                   7282:          the top-level pkgsrc Makefile by using the
                   7283:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
                   7284: <dt><span class="term">show-installed-depends</span></dt>
                   7285: <dd><p>This target shows which installed packages match
                   7286:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7287:          if out of date dependencies are causing build
                   7288:          problems.</p></dd>
                   7289: <dt><span class="term">check-shlibs</span></dt>
                   7290: <dd><p>After a package is installed, check all its
                   7291:          binaries and (on ELF platforms) shared libraries to see
                   7292:          if they find the shared libs they need.  Run by default
1.4       rillig   7293:          if <code class="varname">PKG_DEVELOPER</code> is set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1       dsieger  7294: <dt><span class="term">print-PLIST</span></dt>
                   7295: <dd>
                   7296: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
                   7297:          upgraded pkg, this prints out an attempt to generate a
                   7298:          new <code class="filename">PLIST</code> from a <span><strong class="command">find
                   7299:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7300:          to care for shared libs etc., but it is
                   7301:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7302:          result before putting it into
                   7303:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7304:          diff the output of this command against an already
                   7305:          existing <code class="filename">PLIST</code> file.</p>
                   7306: <p>If the package installs files via <a 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
                   7307:          other methods that don't update file access times, be
                   7308:          sure to add these files manually to your
                   7309:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7310:          -newer</span>&#8221; command used by this target won't catch
                   7311:          them!</p>
1.6       rillig   7312: <p>See <a href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span><strong class="command">make print-PLIST</strong></span>&#8221;</a> for more
1.1       dsieger  7313:          information on this target.</p>
                   7314: </dd>
                   7315: <dt><span class="term">bulk-package</span></dt>
                   7316: <dd>
                   7317: <p>Used to do bulk builds. If an appropriate binary
                   7318:          package already exists, no action is taken. If not, this
                   7319:          target will compile, install and package it (and its
                   7320:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.6       rillig   7321:          properly. See <a href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7322:          After creating the binary package, the sources, the
                   7323:          just-installed package and its required packages are
                   7324:          removed, preserving free disk space.</p>
                   7325: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7326:          all packages installed on a system!</em></span></p>
                   7327: </dd>
                   7328: <dt><span class="term">bulk-install</span></dt>
                   7329: <dd>
                   7330: <p>Used during bulk-installs to install required
                   7331:          packages. If an up-to-date binary package is available,
                   7332:          it will be installed via <a 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,
                   7333:          <span><strong class="command">make bulk-package</strong></span> will be executed,
                   7334:          but the installed binary won't be removed.</p>
                   7335: <p>A binary package is considered
                   7336:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
                   7337:          <a 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>
                   7338: <div class="itemizedlist"><ul type="disc">
                   7339: <li><p>None of the package's files
                   7340:              (<code class="filename">Makefile</code>, ...) were modified
                   7341:              since it was built.</p></li>
                   7342: <li><p>None of the package's required (binary)
                   7343:              packages were modified since it was built.</p></li>
                   7344: </ul></div>
                   7345: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7346:          all packages installed on a system!</em></span></p>
                   7347: </dd>
                   7348: </dl></div>
                   7349: </div>
                   7350: </div>
                   7351: <div class="chapter" lang="en">
                   7352: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7353: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7354: <div class="toc">
                   7355: <p><b>Table of Contents</b></p>
                   7356: <dl>
1.6       rillig   7357: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7358: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7359: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7360: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7361: </dl>
                   7362: </div>
                   7363: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7364: by pkgsrc and also for individual packages to define what commands
                   7365: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7366: or for later run-time of an installed packaged (such as
                   7367: <code class="varname">DEPENDS</code>).
                   7368: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7369: package will not be used.</p>
                   7370: <p>When building a package, the replacement tools are
                   7371: made available in a directory (as symlinks or wrapper scripts)
                   7372: that is early in the executable search path. Just like the buildlink
                   7373: system, this helps with consistent builds.</p>
                   7374: <p>A tool may be needed to help build a specific package. For example,
                   7375: perl, GNU make (gmake) or yacc may be needed.</p>
                   7376: <p>Also a tool may be needed, for example, because the native system's supplied
                   7377: tool may be inefficient for building a package with pkgsrc.
                   7378: For example, a package may need GNU awk, bison (instead of
                   7379: yacc) or a better sed.</p>
                   7380: <p>The tools used by a package can be listed by running
                   7381: <span><strong class="command">make show-tools</strong></span>.</p>
                   7382: <div class="sect1" lang="en">
                   7383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7384: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7385: <p>The default set of tools used by pkgsrc is defined in
                   7386: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   7387: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
                   7388: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
                   7389: These can be seen by running:
                   7390: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   7391: <p>If a package needs a specific program to build
                   7392: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7393: to define the tools needed.</p>
                   7394: </div>
                   7395: <div class="sect1" lang="en">
                   7396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7397: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1       dsieger  7398: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
                   7399: and not the native version for a build dependency.
                   7400: And the :run means that it is used for a
                   7401: run-time dependencies also (and becomes a DEPENDS).
                   7402: The default is a build dependency which can be set with
                   7403: :build. (So in this example, it is the same as gmake:build
                   7404: and pkg-config:build.)</p>
                   7405: <pre class="programlisting">
                   7406: USE_TOOLS+=     mktemp:pkgsrc
                   7407: USE_TOOLS+=     gmake perl:run pkg-config
                   7408: </pre>
                   7409: <p>When using the tools framework, a
                   7410: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7411: which contains the full path to the appropriate tool. For example,
                   7412: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
                   7413: on Linux systems.</p>
                   7414: <p>If you always need a pkgsrc version of the
                   7415: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7416: </p>
                   7417: </div>
                   7418: <div class="sect1" lang="en">
                   7419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7420: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7421: <p>When improving or porting pkgsrc to a new platform, have a look
                   7422: at (or create) the corresponding platform specific make file fragment under
                   7423: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7424: the name of the common tools. For example:</p>
                   7425: <pre class="programlisting">
                   7426: .if exists(/usr/bin/bzcat)
                   7427: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7428: .elif exists(/usr/bin/bzip2)
                   7429: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7430: .endif
                   7431: 
                   7432: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7433: </pre>
                   7434: </div>
                   7435: <div class="sect1" lang="en">
                   7436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7437: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1       dsieger  7438: <div class="qandaset">
                   7439: <dl>
1.6       rillig   7440: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7441: </dt>
1.6       rillig   7442: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7443:        tools?</a>
                   7444: </dt>
1.6       rillig   7445: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7446:        package is using while being built? I want to know whether it
                   7447:        uses sed or not.</a>
                   7448: </dt>
                   7449: </dl>
                   7450: <table border="0" summary="Q and A Set">
                   7451: <col align="left" width="1%">
                   7452: <tbody>
                   7453: <tr class="question">
                   7454: <td align="left" valign="top">
1.9     ! rillig   7455: <a name="tools.new"></a><a name="id2707293"></a><b>18.4.1.</b>
1.1       dsieger  7456: </td>
                   7457: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7458: </tr>
                   7459: <tr class="answer">
                   7460: <td align="left" valign="top"></td>
                   7461: <td align="left" valign="top"><p>TODO</p></td>
                   7462: </tr>
                   7463: <tr class="question">
                   7464: <td align="left" valign="top">
1.9     ! rillig   7465: <a name="tools.listall"></a><a name="id2707303"></a><b>18.4.2.</b>
1.1       dsieger  7466: </td>
                   7467: <td align="left" valign="top"><p>How do I get a list of all available
                   7468:        tools?</p></td>
                   7469: </tr>
                   7470: <tr class="answer">
                   7471: <td align="left" valign="top"></td>
                   7472: <td align="left" valign="top"><p>TODO</p></td>
                   7473: </tr>
                   7474: <tr class="question">
                   7475: <td align="left" valign="top">
1.9     ! rillig   7476: <a name="tools.used"></a><a name="id2707314"></a><b>18.4.3.</b>
1.1       dsieger  7477: </td>
                   7478: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7479:        package is using while being built? I want to know whether it
                   7480:        uses sed or not.</p></td>
                   7481: </tr>
                   7482: <tr class="answer">
                   7483: <td align="left" valign="top"></td>
                   7484: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7485:        to do it.)</p></td>
                   7486: </tr>
                   7487: </tbody>
                   7488: </table>
                   7489: </div>
                   7490: </div>
                   7491: </div>
                   7492: <div class="chapter" lang="en">
                   7493: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7494: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7495: <div class="toc">
                   7496: <p><b>Table of Contents</b></p>
                   7497: <dl>
1.6       rillig   7498: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7499: <dd><dl>
1.6       rillig   7500: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
                   7501: <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>
                   7502: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7503: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7504: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7505: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7506: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7507: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7508: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7509: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7510: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7511: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7512: </dl></dd>
                   7513: <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>
                   7514: <dd><dl>
                   7515: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7516: <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>
                   7517: </dl></dd>
                   7518: <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>
                   7519: <dd><dl>
                   7520: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7521: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7522: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7523: </dl></dd>
                   7524: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7525: <dd><dl>
                   7526: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7527: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7528: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7529: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7530: </dl></dd>
                   7531: <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>
                   7532: <dd><dl>
                   7533: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7534: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
                   7535: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7536: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7537: </dl></dd>
                   7538: <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>
                   7539: <dd><dl>
                   7540: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7541: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7542: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7543: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7544: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7545: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7546: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7547: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7548: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig   7549: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   7550: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7551: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7552: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7553: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7554: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7555: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7556: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7557: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7558:     emulation</a></span></dt>
1.6       rillig   7559: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7560: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7561: </dl></dd>
1.6       rillig   7562: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7563: </dl>
                   7564: </div>
                   7565: <div class="sect1" lang="en">
                   7566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7567: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1       dsieger  7568: <div class="sect2" lang="en">
                   7569: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7570: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7571: <p>One appealing feature of pkgsrc is that it runs on many
                   7572:     different platforms. As a result, it is important to ensure,
                   7573:     where possible, that packages in pkgsrc are portable. This
                   7574:     chapter mentions some particular details you should pay
                   7575:     attention to while working on pkgsrc.</p>
                   7576: </div>
                   7577: <div class="sect2" lang="en">
                   7578: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7579: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  7580: </h3></div></div></div>
                   7581: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7582:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.4       rillig   7583:     which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7584:     want to use those variables in the preprocessor directives of
                   7585:     <a 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
                   7586:     <code class="literal">.for</code>), you need to include the file
                   7587:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7588:     loads the user preferences.</p>
                   7589: <p>But note that some variables may not be completely defined
                   7590:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7591:     included, as they may contain references to variables that are
                   7592:     not yet defined. In shell commands this is no problem, since
                   7593:     variables are actually macros, which are only expanded when they
                   7594:     are used. But in the preprocessor directives mentioned above and
                   7595:     in dependency lines (of the form <code class="literal">target:
                   7596:     dependencies</code>) the variables are expanded at load
                   7597:     time.</p>
                   7598: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7599: <h3 class="title">Note</h3>
                   7600: <p>Currently there is no exhaustive list of all
                   7601:     variables that tells you whether they can be used at load time
                   7602:     or only at run time, but it is in preparation.</p>
                   7603: </div>
                   7604: </div>
                   7605: <div class="sect2" lang="en">
                   7606: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7607: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7608: <p>Occasionally, packages require interaction from the user,
                   7609:     and this can be in a number of ways:</p>
                   7610: <div class="itemizedlist"><ul type="disc">
                   7611: <li><p>When fetching the distfiles, some packages require user
                   7612:        interaction such as entering username/password or accepting a
                   7613:        license on a web page.</p></li>
                   7614: <li><p>When extracting the distfiles, some packages may ask for
                   7615:        passwords.</p></li>
                   7616: <li><p>help to configure the package before it is built</p></li>
                   7617: <li><p>help during the build process</p></li>
                   7618: <li><p>help during the installation of a package</p></li>
                   7619: </ul></div>
                   7620: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7621:     provided to notify the pkgsrc mechanism of an interactive stage
                   7622:     which will be needed, and this should be set in the package's
                   7623:     <code class="filename">Makefile</code>, e.g.:</p>
                   7624: <pre class="programlisting">
                   7625: INTERACTIVE_STAGE=      build
                   7626:     </pre>
                   7627: <p>Multiple interactive stages can be specified:</p>
                   7628: <pre class="programlisting">
                   7629: INTERACTIVE_STAGE=      configure install
                   7630:     </pre>
                   7631: <p>The user can then decide to skip this package by setting the
                   7632:     <code class="varname">BATCH</code> variable.</p>
                   7633: </div>
                   7634: <div class="sect2" lang="en">
                   7635: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7636: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7637: <p>Authors of software can choose the licence under which
                   7638:     software can be copied.  This is due to copyright law, and reasons
                   7639:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7640:     system recognizes that there are a number of licenses which some
                   7641:     users may find objectionable or difficult or impossible to comply
                   7642:     with.  The Free Software Foundation has declared some licenses
                   7643:     "Free", and the Open Source Initiative has a definition of "Open
                   7644:     Source".  The pkgsrc system, as a policy choice, does not label
                   7645:     packages which have licenses that are Free or Open Source.
                   7646:     However, packages without a license meeting either of those tests
                   7647:     are labeled with a license tag denoting the license.  Note that a
                   7648:     package with no license to copy trivially does not meet either the
                   7649:     Free or Open Source test.</p>
                   7650: <p>For packages which are not Free or Open Source, pkgsrc will
                   7651:     not build the package unless the user has indicated to pkgsrc that
                   7652:     packages with that particular license may be built.  Note that
                   7653:     this documentation avoids the term "accepted the license".  The
                   7654:     pkgsrc system is merely providing a mechanism to avoid
                   7655:     accidentally building a package with a non-free license;
                   7656:     judgement and responsibility remain with the user.  (Installation
                   7657:     of binary packages are not currently subject to this mechanism;
                   7658:     this is a bug.)</p>
                   7659: <p>One might want to only install packages with a BSD license,
                   7660:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7661:     does not provide a way to do this.  It might be possible to put in
                   7662:     tags for free licenses, and have a default
                   7663:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7664:     widely viewed as having a very poor ratio of benefit to
                   7665:     work.</p>
                   7666: <p>The license tag mechanism is intended to address
                   7667:     copyright-related issues surrounding building, installing and
                   7668:     using a package, and not to address redistribution issues (see
                   7669:     <code class="varname">RESTRICTED</code> and
                   7670:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7671:     definition of licenses for which tags are not needed implies
                   7672:     that packages with redistribution restrictions should have
                   7673:     tags, because Free or Open Source programs do not have
                   7674:     redistribution restrictions.</p>
                   7675: <p>Denoting that a package may be copied according to a
                   7676:     particular license is done by placing the license in
                   7677:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7678:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7679:     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>
                   7680: <pre class="programlisting">
                   7681: LICENSE=        xv-license
                   7682:     </pre>
                   7683: <p>When trying to build, the user will get a notice that the
                   7684:     package is covered by a license which has not been placed in the
                   7685:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7686: <pre class="programlisting">
                   7687: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7688: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7689: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7690: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7691: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7692: *** Error code 1
                   7693:     </pre>
                   7694: <p>The license can be viewed with <span><strong class="command">make
                   7695:     show-license</strong></span>, and if the user so chooses, the line
1.4       rillig   7696:     printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7697:     convey to pkgsrc that it should not in the future fail because of
                   7698:     that license:</p>
                   7699: <pre class="programlisting">
                   7700: ACCEPTABLE_LICENSES+=xv-license
                   7701:     </pre>
                   7702: <p>When adding a package with a new license, the license text
                   7703:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7704:     displaying.  A list of known licenses can be seen in this
                   7705:     directory.</p>
                   7706: <p>When the license changes (in a way other than formatting),
                   7707:     please make sure that the new license has a different name (e.g.,
                   7708:     append the version number if it exists, or the date).  Just
                   7709:     because a user told pkgsrc to build programs under a previous
                   7710:     version of a license does not mean that pkgsrc should build
                   7711:     programs under the new licenses.  The higher-level point is that
                   7712:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7713:     test is a mechanistic test of whether a particular text has been
                   7714:     approved by either of two bodies.</p>
                   7715: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7716:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7717:     is deprecated because it does not crisply refer to a particular
                   7718:     license text.  Another problem with such usage is that it does not
                   7719:     enable a user to tell pkgsrc to proceed for a single package
                   7720:     without also telling pkgsrc to proceed for all packages with that
                   7721:     tag.</p>
                   7722: </div>
                   7723: <div class="sect2" lang="en">
                   7724: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7725: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7726: <p>Some licenses restrict how software may be re-distributed.
                   7727:     Because a license tag is required unless the package is Free or
                   7728:     Open Source, all packages with restrictions should have license
                   7729:     tags.  By declaring the restrictions, package tools can
                   7730:     automatically refrain from e.g. placing binary packages on FTP
                   7731:     sites.</p>
                   7732: <p>There are four restrictions that may be encoded, which are
                   7733:     the cross product of sources (distfiles) and binaries not being
                   7734:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7735:     language in any license, and because non-Free licenses tend to be
                   7736:     different from each other, pkgsrc adopts a definition of FTP and
                   7737:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7738:     should not be made available over the Internet at no charge.
                   7739:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7740:     made available on some kind of media, together with other source
                   7741:     and binary packages, and which is sold for a distribution charge.
                   7742:     </p>
                   7743: <p>In order to encode these restrictions, the package system
                   7744:     defines five make variables that can be set to note these
                   7745:     restrictions:</p>
                   7746: <div class="itemizedlist"><ul type="disc">
                   7747: <li>
                   7748: <p><code class="varname">RESTRICTED</code></p>
                   7749: <p>This variable should be set whenever a restriction
                   7750:        exists (regardless of its kind).  Set this variable to a
                   7751:        string containing the reason for the restriction.  It should
                   7752:        be understood that those wanting to understand the restriction
                   7753:        will have to read the license, and perhaps seek advice of
                   7754:        counsel.</p>
                   7755: </li>
                   7756: <li>
                   7757: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7758: <p>Binaries may not be placed on CD-ROM containing other
                   7759:        binary packages, for which a distribution charge may be made.
                   7760:        In this case, set this variable to
                   7761:        <code class="varname">${RESTRICTED}</code>.</p>
                   7762: </li>
                   7763: <li>
                   7764: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7765: <p>Binaries may not made available on the Internet without
                   7766:        charge.  In this case, set this variable to
                   7767:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7768:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7769: </li>
                   7770: <li>
                   7771: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7772: <p>Distfiles may not be placed on CD-ROM, together with
                   7773:        other distfiles, for which a fee may be charged.  In this
                   7774:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7775:        </p>
                   7776: </li>
                   7777: <li>
                   7778: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7779: <p>Distfiles may not made available via FTP at no charge.
                   7780:        In this case, set this variable to
                   7781:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7782:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7783: </li>
                   7784: </ul></div>
                   7785: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
                   7786:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7787:     generic make variables to denote restrictions is deprecated,
                   7788:     because they unconditionally prevent users from generating
                   7789:     binary packages!</p>
                   7790: </div>
                   7791: <div class="sect2" lang="en">
                   7792: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7793: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  7794: <p>Your package may depend on some other package being present
                   7795:     - and there are various ways of expressing this dependency.
                   7796:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7797:     <code class="varname">DEPENDS</code> definitions, the
                   7798:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7799:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7800:     to handle dependencies, and which uses the variables named above.
1.6       rillig   7801:     See <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1       dsieger  7802: <p>The basic difference between the two variables is as
                   7803:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7804:     that pre-requisite in the binary package so it will be pulled in
                   7805:     when the binary package is later installed, whilst the
                   7806:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7807:     dependency that is only needed for building the package.</p>
                   7808: <p>This means that if you only need a package present whilst
                   7809:     you are building, it should be noted as a
                   7810:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7811: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7812:     <code class="varname">DEPENDS</code> definition is:</p>
                   7813: <pre class="programlisting">
                   7814: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7815:     </pre>
                   7816: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
                   7817:     may include any of the wildcard version numbers recognized by
                   7818:     <a 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>
                   7819: <div class="orderedlist"><ol type="1">
                   7820: <li>
                   7821: <p>If your package needs another package's binaries or
                   7822:        libraries to build or run, and if that package has a
                   7823:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7824: <pre class="programlisting">
                   7825: .include "../../graphics/jpeg/buildlink3.mk"
                   7826:        </pre>
                   7827: </li>
                   7828: <li>
                   7829: <p>If your package needs to use another package to build
                   7830:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7831:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7832:        definition:</p>
                   7833: <pre class="programlisting">
                   7834: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
                   7835:        </pre>
                   7836: </li>
                   7837: <li>
                   7838: <p>If your package needs a library with which to link and
                   7839:        again there is no <code class="filename">buildlink3.mk</code> file
                   7840:        available, this is specified using the
                   7841:        <code class="varname">DEPENDS</code> definition. For example:</p>
                   7842: <pre class="programlisting">
                   7843: DEPENDS+=       xpm-3.4j:../../graphics/xpm
                   7844:        </pre>
1.9     ! rillig   7845: <p>You can also use wildcards in package dependencies:</p>
1.1       dsieger  7846: <pre class="programlisting">
                   7847: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
                   7848:        </pre>
                   7849: <p>Note that such wildcard dependencies are retained when
                   7850:        creating binary packages.  The dependency is checked when
                   7851:        installing the binary package and any package which matches
                   7852:        the pattern will be used.  Wildcard dependencies should be
                   7853:        used with care.</p>
                   7854: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
                   7855:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7856:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7857:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
                   7858: <p>Wildcards can also be used to specify that a package
                   7859:        will only build against a certain minimum version of a
                   7860:        pre-requisite:</p>
                   7861: <pre class="programlisting">
                   7862: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
                   7863:        </pre>
                   7864: <p>This means that the package will build against version
                   7865:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7866:        be warranted if, for example, the API of the library has
                   7867:        changed with version 3.5.4 and a package would not compile
                   7868:        against an earlier version of tiff.</p>
                   7869: <p>Please note that such dependencies should only be
                   7870:        updated if a package requires a newer pre-requisite, but
                   7871:        not to denote recommendations such as
                   7872:        ABI changes that do not prevent a package from building
                   7873:        correctly.  Such recommendations can be expressed using
                   7874:        <code class="varname">ABI_DEPENDS</code>:</p>
                   7875: <pre class="programlisting">
                   7876: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
                   7877:        </pre>
                   7878: <p>In addition to the above <code class="varname">DEPENDS</code>
                   7879:        line, this denotes that while a package will build against
                   7880:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7881:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7882:        dependencies unless explicitly ignored (in which case a
                   7883:        warning will be printed).</p>
                   7884: <p>To ignore these ABI dependency recommendations and just
                   7885:        use the required <code class="varname">DEPENDS</code>, set
                   7886:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7887:        it easier and faster to update packages built using pkgsrc,
                   7888:        since older compatible dependencies can continue to be
                   7889:        used. This is useful for people who watch their rebuilds
                   7890:        very carefully; it is not very good as a general-purpose
                   7891:        hammer.  If you use it, you need to be mindful of possible
                   7892:        ABI changes, including those from the underlying OS.</p>
                   7893: <p>Packages that are built with recommendations ignored
                   7894:        may not be uploaded to ftp.NetBSD.org by developers and
                   7895:        should not be used across different systems that may have
                   7896:        different versions of binary packages installed.</p>
                   7897: <p>For security fixes, please update the package
1.6       rillig   7898:        vulnerabilities file. See <a 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.1       dsieger  7899:        information.</p>
                   7900: </li>
                   7901: <li>
                   7902: <p>If your package needs some executable to be able to run
                   7903:        correctly and if there's no
                   7904:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7905:        using the <code class="varname">DEPENDS</code> variable. The
                   7906:        <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
                   7907:        be able to execute the latex binary from the teTeX package
                   7908:        when it runs, and that is specified:</p>
                   7909: <pre class="programlisting">
                   7910: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
                   7911:        </pre>
                   7912: <p>The comment about wildcard dependencies from previous
                   7913:        paragraph applies here, too.</p>
                   7914: </li>
                   7915: </ol></div>
                   7916: <p>If your package needs files from another package to build,
                   7917:     add the relevant distribution files to
                   7918:     <code class="varname">DISTFILES</code>, so they will be extracted
                   7919:     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.
                   7920:     (It relies on the jpeg sources being present in source form
                   7921:     during the build.)</p>
                   7922: </div>
                   7923: <div class="sect2" lang="en">
                   7924: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7925: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  7926: <p>Your package may conflict with other packages a user might
                   7927:     already have installed on his system, e.g. if your package
                   7928:     installs the same set of files as another package in the pkgsrc
                   7929:     tree.</p>
                   7930: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   7931:     space-separated list of packages (including version string) your
                   7932:     package conflicts with.</p>
                   7933: <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>
                   7934:     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>
                   7935:     install the same shared library, thus you set in
                   7936:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   7937: <pre class="programlisting">
                   7938: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7939:     </pre>
                   7940: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7941: <pre class="programlisting">
                   7942: CONFLICTS=      Xaw3d-[0-9]*
                   7943:     </pre>
                   7944: <p>Packages will automatically conflict with other packages
                   7945:     with the name prefix and a different version
                   7946:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   7947:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
                   7948: </div>
                   7949: <div class="sect2" lang="en">
                   7950: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7951: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7952: <p>There are several reasons why a package might be
                   7953:     instructed to not build under certain circumstances.  If the
                   7954:     package builds and runs on most platforms, the exceptions
                   7955:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   7956:     the package builds and runs on a small handful of platforms,
                   7957:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   7958:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7959:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7960:     (OS-version-platform) that can use glob-style
                   7961:     wildcards.</p>
                   7962: <p>Some packages are tightly bound to a specific version of an
                   7963:     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
                   7964:     backwards compatible with other versions of the OS, and should be
                   7965:     uploaded to a version specific directory on the FTP server.  Mark
                   7966:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   7967:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   7968:     the package system internals, but may be used in the
                   7969:     future.</p>
                   7970: <p>If the package should be skipped (for example, because it
                   7971:     provides functionality already provided by the system), set
                   7972:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7973:     the package should fail because some preconditions are not met,
                   7974:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7975:     message.</p>
                   7976: </div>
                   7977: <div class="sect2" lang="en">
                   7978: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7979: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7980: <p>To ensure that a package may not be deleted, once it has been
                   7981:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7982:     be set in the package Makefile. This will be carried into any
                   7983:     binary package that is made from this pkgsrc entry. A
                   7984:     &#8220;<span class="quote">preserved</span>&#8221; package will
                   7985:     not be deleted using <a 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
                   7986:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
                   7987: </div>
                   7988: <div class="sect2" lang="en">
                   7989: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7990: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7991: <p>When a vulnerability is found, this should be noted in
                   7992:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
                   7993:     and after committing that file, use <span><strong class="command">make upload</strong></span>
                   7994:     in the same directory to update the file on ftp.NetBSD.org.</p>
                   7995: <p>After fixing the vulnerability by a patch, its
                   7996:     <code class="varname">PKGREVISION</code> should be increased (this
                   7997:     is of course not necessary if the problem is fixed by using
                   7998:     a newer release of the software).</p>
                   7999: <p>Also, if the fix should be applied to the stable pkgsrc
                   8000:     branch, be sure to submit a pullup request!</p>
                   8001: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8002:     semi-automatically by a weekly cron job.</p>
                   8003: </div>
                   8004: <div class="sect2" lang="en">
                   8005: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8006: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  8007: <p>When making fixes to an existing package it can be useful
                   8008:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8009:     avoid conflicting with future versions by the original author, a
                   8010:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8011:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8012:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8013:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8014: <pre class="programlisting">
                   8015: DISTNAME=       foo-17.42
                   8016: PKGREVISION=    9
                   8017:     </pre>
                   8018: <p>will result in a <code class="varname">PKGNAME</code> of
                   8019:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8020:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8021:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8022:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8023: <p>When a new release of the package is released, the
                   8024:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8025:     minor release of the above package, things should be like:</p>
                   8026: <pre class="programlisting">
                   8027: DISTNAME=       foo-17.43
                   8028:     </pre>
                   8029: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8030:     non-trivial change in the resulting binary package.  Without a
                   8031:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8032:     version installed has no way of knowing that their package is out
                   8033:     of date.  Thus, changes without increasing
                   8034:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8035:     trivial that no reasonable person would want to upgrade", and this
                   8036:     is the rough test for when increasing
                   8037:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8038:     changes that do not merit increasing
                   8039:     <code class="varname">PKGREVISION</code> are:</p>
                   8040: <div class="itemizedlist"><ul type="disc">
                   8041: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
                   8042:       or comments in Makefile.</p></li>
                   8043: <li><p>
                   8044:       Changing build variables if the resulting binary package is the same.</p></li>
                   8045: <li><p>
                   8046:       Changing <code class="filename">DESCR</code>.</p></li>
                   8047: <li><p>
                   8048:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8049: </ul></div>
                   8050: <p>Examples of changes that do merit an increase to
                   8051:     <code class="varname">PKGREVISION</code> include:</p>
                   8052: <div class="itemizedlist"><ul type="disc">
                   8053: <li><p>
                   8054:       Security fixes</p></li>
                   8055: <li><p>
                   8056:       Changes or additions to a patch file</p></li>
                   8057: <li><p>
                   8058:       Changes to the <code class="filename">PLIST</code></p></li>
                   8059: </ul></div>
                   8060: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8061:     changes.</p>
                   8062: </div>
                   8063: <div class="sect2" lang="en">
                   8064: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8065: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1       dsieger  8066: <p>When you want to replace the same text in multiple files
                   8067:     or when the replacement text varies, patches alone cannot help.
                   8068:     This is where the SUBST framework comes in. It provides an
                   8069:     easy-to-use interface for replacing text in files.
                   8070:     Example:</p>
                   8071: <pre class="programlisting">
                   8072: SUBST_CLASSES+=                 fix-paths
                   8073: SUBST_STAGE.fix-paths=          pre-configure
                   8074: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8075: SUBST_FILES.fix-paths=          src/*.c
                   8076: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8077: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8078: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8079:     </pre>
                   8080: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8081:     that are used to identify the different SUBST blocks that are
                   8082:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8083:     important to always use the <code class="literal">+=</code> operator with
                   8084:     this variable. Otherwise some substitutions may be
                   8085:     skipped.</p>
                   8086: <p>The remaining variables of each SUBST block are
                   8087:     parameterized with the identifier from the first line
                   8088:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8089:     parameters to a function call.</p>
                   8090: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8091:     which the replacement will take place. All combinations of
                   8092:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8093:     <code class="literal">post-</code> together with a phase name are
                   8094:     possible, though only few are actually used. Most commonly used
                   8095:     are <code class="literal">post-patch</code> and
                   8096:     <code class="literal">pre-configure</code>. Of these two,
                   8097:     <code class="literal">pre-configure</code> should be preferred because
                   8098:     then it is possible to run <span><strong class="command">bmake patch</strong></span> and
                   8099:     have the state after applying the patches but before making any
                   8100:     other changes. This is especially useful when you are debugging
                   8101:     a package in order to create new patches for it. Similarly,
                   8102:     <code class="literal">post-build</code> is preferred over
                   8103:     <code class="literal">pre-install</code>, because the install phase should
                   8104:     generally be kept as simple as possible. When you use
                   8105:     <code class="literal">post-build</code>, you have the same files in the
                   8106:     working directory that will be installed later, so you can check
                   8107:     if the substitution has succeeded.</p>
                   8108: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8109:     that is printed just before the substitution is done.</p>
                   8110: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8111:     globbing patterns that specifies the files in which the
                   8112:     substitution will take place. The patterns are interpreted
                   8113:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8114: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
                   8115:     <a 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
                   8116:     command should be prefixed with <code class="literal">-e</code>, so that
                   8117:     all SUBST blocks look uniform.</p>
                   8118: <p>There are some more variables, but they are so seldomly
                   8119:     used that they are only documented in the
                   8120:     <code class="filename">mk/subst.mk</code> file.</p>
                   8121: </div>
                   8122: </div>
                   8123: <div class="sect1" lang="en">
                   8124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8125: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  8126: <div class="sect2" lang="en">
                   8127: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8128: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  8129: <p>If you need to download from a dynamic URL you can set
                   8130:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
                   8131:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8132:     with the name of each file to download as an argument, expecting
                   8133:     it to output the URL of the directory from which to download
                   8134:     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
                   8135:     example of this usage.</p>
                   8136: <p>If the download can't be automated, because the user must
                   8137:     submit personal information to apply for a password, or must pay
                   8138:     for the source, or whatever, you can set
                   8139:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8140:     displayed to the user before aborting the build. Example:</p>
                   8141: <pre class="programlisting">
                   8142: FETCH_MESSAGE=  "Please download the files"
                   8143: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8144: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8145:     </pre>
                   8146: </div>
                   8147: <div class="sect2" lang="en">
                   8148: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8149: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  8150: <p>Sometimes authors of a software package make some
                   8151:     modifications after the software was released, and they put up a
                   8152:     new distfile without changing the package's version number. If a
                   8153:     package is already in pkgsrc at that time, the checksum will
                   8154:     no longer match. The contents of the new distfile should be
                   8155:     compared against the old one before changing anything, to make
                   8156:     sure the distfile was really updated on purpose, and that
                   8157:     no trojan horse or so crept in.
                   8158:     Please mention that the distfiles were compared and what was found
                   8159:     in your commit message.
                   8160:     Then, the correct way to work around this is to
                   8161:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8162:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8163:     <code class="varname">DISTFILES</code> and
                   8164:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8165:     subdirectory of the local distfiles directory.
1.6       rillig   8166:     (See <a 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.1       dsieger  8167:     In case this
                   8168:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8169:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8170:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8171:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8172:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8173:     path in the filenames.
                   8174:     Also increase the PKGREVISION if the installed package is different.
                   8175:     Furthermore, a mail to the package's authors seems appropriate
                   8176:     telling them that changing distfiles after releases without
                   8177:     changing the file names is not good practice.</p>
                   8178: </div>
                   8179: </div>
                   8180: <div class="sect1" lang="en">
                   8181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8182: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  8183: <div class="sect2" lang="en">
                   8184: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8185: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8186: <p>pkgsrc supports many different machines, with different
                   8187:     object formats like a.out and ELF, and varying abilities to do
                   8188:     shared library and dynamic loading at all. To accompany this,
                   8189:     varying commands and options have to be passed to the
                   8190:     compiler, linker, etc. to get the Right Thing, which can be
                   8191:     pretty annoying especially if you don't have all the machines
                   8192:     at your hand to test things.  The
                   8193:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
                   8194:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8195:     both static and dynamic libraries from a set of source files,
                   8196:     thus being platform-independent.</p>
                   8197: <p>Here's how to use libtool in a package in seven simple
                   8198:     steps:</p>
                   8199: <div class="orderedlist"><ol type="1">
                   8200: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
                   8201:        Makefile.</p></li>
                   8202: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8203:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8204:        add it to the definition of <code class="varname">CC</code>, if only
                   8205:        libraries are being built in a given Makefile. This one command
                   8206:        will build both PIC and non-PIC library objects, so you need not
                   8207:        have separate shared and non-shared library rules.</p></li>
                   8208: <li>
                   8209: <p>For the linking of the library, remove any
                   8210:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8211:        -Bshareable</span>&#8221; commands, and instead use:</p>
                   8212: <pre class="programlisting">
                   8213: ${LIBTOOL} --mode=link \
                   8214:     ${CC} -o ${.TARGET:.a=.la} \
                   8215:         ${OBJS:.o=.lo} \
                   8216:         -rpath ${PREFIX}/lib \
                   8217:         -version-info major:minor
                   8218:        </pre>
                   8219: <p>Note that the library is changed to have a
                   8220:        <code class="filename">.la</code> extension, and the objects are
                   8221:        changed to have a <code class="filename">.lo</code>
                   8222:        extension. Change <code class="varname">OBJS</code> as
                   8223:        necessary. This automatically creates all of the
                   8224:        <code class="filename">.a</code>,
                   8225:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8226:        necessary) in the build directory. Be sure to include
                   8227:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8228:        minor are zero, as libtool will otherwise strip off the
                   8229:        shared library version.</p>
                   8230: <p>From the libtool manual:</p>
                   8231: <pre class="programlisting">
                   8232: So, libtool library versions are described by three integers:
                   8233: 
                   8234: CURRENT
                   8235: The most recent interface number that this library implements.
                   8236: 
                   8237: REVISION
                   8238: The implementation number of the CURRENT interface.
                   8239: 
                   8240: AGE
                   8241: The difference between the newest and oldest interfaces that
                   8242: this library implements.  In other words, the library implements
                   8243: all the interface numbers in the range from number `CURRENT -
                   8244: AGE' to `CURRENT'.
                   8245: 
                   8246: If two libraries have identical CURRENT and AGE numbers, then the
                   8247: dynamic linker chooses the library with the greater REVISION number.
                   8248:        </pre>
                   8249: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
                   8250:        different results for a.out and ELF (excluding symlinks)
                   8251:        in only one case. An ELF library of the form
                   8252:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8253:        will have a symlink of
                   8254:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8255:        on an a.out platform. This is handled
                   8256:        automatically.</p>
                   8257: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
                   8258:        directory of the library being built.</p>
                   8259: <p>In the <code class="filename">PLIST</code>, include only the
                   8260:        <code class="filename">.la</code> file, the other files will be
                   8261:        added automatically.</p>
                   8262: </li>
                   8263: <li>
                   8264: <p>When linking shared object (<code class="filename">.so</code>)
                   8265:        files, i.e. files that are loaded via <a 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
                   8266:        shared libraries, use &#8220;<span class="quote">-module
                   8267:        -avoid-version</span>&#8221; to prevent them getting version
                   8268:        tacked on.</p>
                   8269: <p>The <code class="filename">PLIST</code> file gets the
                   8270:        <code class="filename">foo.so</code> entry.</p>
                   8271: </li>
                   8272: <li>
                   8273: <p>When linking programs that depend on these libraries
                   8274:        <span class="emphasis"><em>before</em></span> they are installed, preface
                   8275:        the <a 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 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}
                   8276:        --mode=link</span>&#8221;, and it will find the correct
                   8277:        libraries (static or shared), but please be aware that
                   8278:        libtool will not allow you to specify a relative path in
                   8279:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8280:        expects you to change that argument to be the
                   8281:        <code class="filename">.la</code> file. e.g.</p>
                   8282: <pre class="programlisting">
                   8283: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8284:        </pre>
                   8285: <p>should be changed to:</p>
                   8286: <pre class="programlisting">
                   8287: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8288:        </pre>
                   8289: <p>and it will do the right thing with the libraries.</p>
                   8290: </li>
                   8291: <li>
                   8292: <p>When installing libraries, preface the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8293:        or <a 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}
                   8294:        --mode=install</span>&#8221;, and change the library name to
                   8295:        <code class="filename">.la</code>. e.g.</p>
                   8296: <pre class="programlisting">
                   8297: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
                   8298:        </pre>
                   8299: <p>This will install the static <code class="filename">.a</code>,
                   8300:        shared library, any needed symlinks, and run
                   8301:        <a 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>
                   8302: </li>
                   8303: <li><p>In your <code class="filename">PLIST</code>, include only
                   8304:        the <code class="filename">.la</code>
                   8305:        file (this is a change from previous behaviour).</p></li>
                   8306: </ol></div>
                   8307: </div>
                   8308: <div class="sect2" lang="en">
                   8309: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8310: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8311: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8312:     package Makefile. This will override the package's own libtool
                   8313:     in most cases.  For older libtool using packages,  libtool is
                   8314:     made by ltconfig script during the do-configure step; you can
                   8315:     check the libtool script location by doing <span><strong class="command">make
                   8316:     configure; find work*/ -name libtool</strong></span>.</p>
                   8317: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8318:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8319:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8320:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8321:     package's libtool script(s), set it as appropriate.</p>
                   8322: <p>If you do not need <code class="filename">*.a</code> static
                   8323:     libraries built and installed, then use
                   8324:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8325: <p>If your package makes use of the platform-independent library
                   8326:     for loading dynamic shared objects, that comes with libtool
                   8327:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8328: <p>Some packages use libtool incorrectly so that the package
                   8329:     may not work or build in some circumstances. Some of the more
                   8330:     common errors are:</p>
                   8331: <div class="itemizedlist"><ul type="disc">
                   8332: <li>
                   8333: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8334:        executable or library. This in itself isn't a problem if one of two things
                   8335:        has been done:</p>
                   8336: <div class="orderedlist"><ol type="1">
                   8337: <li><p>The shared object is named correctly, i.e.
                   8338:            <code class="filename">libfoo.la</code>, not
                   8339:            <code class="filename">foo.la</code></p></li>
                   8340: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8341: </ol></div>
                   8342: </li>
                   8343: <li><p>The use of libltdl without the correct calls to initialisation routines.
                   8344:        The function lt_dlinit() should be called and the macro
                   8345:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8346:        executables.</p></li>
                   8347: </ul></div>
                   8348: </div>
                   8349: <div class="sect2" lang="en">
                   8350: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8351: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8352: <p>If a package needs GNU autoconf or automake to be executed
                   8353:     to regenerate the configure script and Makefile.in makefile
                   8354:     templates, then they should be executed in a pre-configure
                   8355:     target.</p>
                   8356: <p>For packages that need only autoconf:</p>
                   8357: <pre class="programlisting">
                   8358: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8359: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8360: ...
                   8361: 
                   8362: pre-configure:
                   8363:         cd ${WRKSRC} &amp;&amp; autoconf
                   8364: 
                   8365: ...
                   8366:     </pre>
                   8367: <p>and for packages that need automake and autoconf:</p>
                   8368: <pre class="programlisting">
                   8369: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8370: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8371: ...
                   8372: 
                   8373: pre-configure:
                   8374:         set -e; cd ${WRKSRC}; \
                   8375:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8376: 
                   8377: ...
                   8378:     </pre>
                   8379: <p>Packages which use GNU Automake will almost certainly
                   8380:     require GNU Make.</p>
                   8381: <p>There are times when the configure process makes
                   8382:     additional changes to the generated files, which then causes
                   8383:     the build process to try to re-execute the automake sequence.
                   8384:     This is prevented by touching various files in the configure
                   8385:     stage. If this causes problems with your package you can set
                   8386:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8387:     Makefile.</p>
                   8388: </div>
                   8389: </div>
                   8390: <div class="sect1" lang="en">
                   8391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8392: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1       dsieger  8393: <div class="sect2" lang="en">
                   8394: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8395: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8396: <p>Compilers for the C, C++, and Fortran languages comes with
                   8397:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8398:     is written in C and will hide all other compilers (via the wrapper
1.6       rillig   8399:     framework, see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8400: <p>To declare which language's compiler a package needs, set
                   8401:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8402:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8403:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8404:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8405:     written in C++, usually need a C compiler for the configure
                   8406:     phase.</p>
                   8407: </div>
                   8408: <div class="sect2" lang="en">
                   8409: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8410: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8411: <p>If a program is written in Java, use the Java framework in
                   8412:     pkgsrc.  The package must include
                   8413:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8414:     provides the following variables:</p>
                   8415: <div class="itemizedlist"><ul type="disc">
                   8416: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8417:       dependency on the JDK is added.  If
                   8418:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8419:       there is only a runtime dependency on the JDK.  The default is
                   8420:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8421:       JDK.</p></li>
                   8422: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8423:       a package needs a Java2 implementation.  The supported values
                   8424:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8425:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8426:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8427:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8428:       above. This variable is not set by default.</p></li>
                   8429: </ul></div>
                   8430: </div>
                   8431: <div class="sect2" lang="en">
                   8432: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8433: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8434: <p>If your package contains interpreted perl scripts, add
                   8435:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8436:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8437:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8438:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8439:     that you want adjusted.  Every occurrence of
                   8440:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8441:     path to the perl executable.</p>
                   8442: <p>If a particular version of perl is needed, set the
                   8443:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8444:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.6       rillig   8445: <p>See <a 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.1       dsieger  8446:     about handling perl modules.</p>
                   8447: </div>
                   8448: <div class="sect2" lang="en">
                   8449: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8450: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1       dsieger  8451: <p>Currently, there is no special handling for other languages
                   8452:     in pkgsrc.  If a compiler package provides a
                   8453:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8454:     just add a (build) dependency on the appropriate compiler
                   8455:     package.</p>
                   8456: </div>
                   8457: </div>
                   8458: <div class="sect1" lang="en">
                   8459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8460: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  8461: <p>The most common failures when building a package are that
                   8462:        some platforms do not provide certain header files, functions or
                   8463:        libraries, or they provide the functions in a library that the
                   8464:        original package author didn't know. To work around this, you
                   8465:        can rewrite the source code in most cases so that it does not
                   8466:        use the missing functions or provides a replacement function.</p>
                   8467: <div class="sect2" lang="en">
                   8468: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8469: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8470: <p>If a package already comes with a GNU configure script, the
                   8471:        preferred way to fix the build failure is to change the
                   8472:        configure script, not the code. In the other cases, you can
                   8473:        utilize the C preprocessor, which defines certain macros
                   8474:        depending on the operating system and hardware architecture it
                   8475:        compiles for. These macros can be queried using for example
                   8476:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8477:        system, hardware architecture and compiler has its own macro.
                   8478:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8479:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8480:        are all defined, you know that you are using NetBSD on an i386
                   8481:        compatible CPU, and your compiler is GCC.</p>
                   8482: <p>The list of the following macros for hardware and
                   8483:        operating system depends on the compiler that is used. For
                   8484:        example, if you want to conditionally compile code on Solaris,
                   8485:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8486:        does not define it. Use <code class="varname">__sun</code> instead.</p>
                   8487: <div class="sect3" lang="en">
                   8488: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8489: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  8490: <p>To distinguish between 4.4 BSD-derived systems and the
                   8491:         rest of the world, you should use the following code.</p>
                   8492: <pre class="programlisting">
                   8493: #include &lt;sys/param.h&gt;
                   8494: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8495: /* BSD-specific code goes here */
                   8496: #else
                   8497: /* non-BSD-specific code goes here */
                   8498: #endif
                   8499: </pre>
                   8500: <p>If this distinction is not fine enough, you can also test
                   8501:        for the following macros.</p>
                   8502: <pre class="programlisting">
                   8503: FreeBSD     __FreeBSD__
                   8504: DragonFly   __DragonFly__
                   8505: Interix     __INTERIX
                   8506: IRIX        __sgi (TODO: get a definite source for this)
                   8507: Linux       linux, __linux, __linux__
                   8508: NetBSD      __NetBSD__
                   8509: OpenBSD     __OpenBSD__
                   8510: Solaris     sun, __sun
                   8511: </pre>
                   8512: </div>
                   8513: <div class="sect3" lang="en">
                   8514: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8515: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  8516: <pre class="programlisting">
                   8517: i386        i386, __i386, __i386__
                   8518: MIPS        __mips
                   8519: SPARC       sparc, __sparc
                   8520: </pre>
                   8521: </div>
                   8522: <div class="sect3" lang="en">
                   8523: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8524: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  8525: <pre class="programlisting">
                   8526: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8527: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8528: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8529: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8530: </pre>
                   8531: </div>
                   8532: </div>
                   8533: <div class="sect2" lang="en">
                   8534: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8535: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8536: <p>Some source files trigger bugs in the compiler, based on
                   8537:         combinations of compiler version and architecture and almost
                   8538:         always relation to optimisation being enabled.  Common symptoms
                   8539:         are gcc internal errors or never finishing compiling a
                   8540:        file.</p>
                   8541: <p>Typically, a workaround involves testing the
                   8542:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8543:         optimisation for that combination of file,
                   8544:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8545:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8546:        number of examples.</p>
                   8547: </div>
                   8548: <div class="sect2" lang="en">
                   8549: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8550: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.1       dsieger  8551: <p>This error message often means that a package did not
                   8552:        link to a shared library it needs. The following functions are
                   8553:        known to cause this error message over and over.</p>
                   8554: <div class="informaltable">
                   8555: <a name="undefined-reference-functions"></a><table border="1">
                   8556: <colgroup>
                   8557: <col>
                   8558: <col>
                   8559: <col>
                   8560: </colgroup>
                   8561: <thead><tr>
                   8562: <th>Function</th>
                   8563: <th>Library</th>
                   8564: <th>Affected platforms</th>
                   8565: </tr></thead>
                   8566: <tbody>
                   8567: <tr>
                   8568: <td>accept, bind, connect</td>
                   8569: <td>-lsocket</td>
                   8570: <td>Solaris</td>
                   8571: </tr>
                   8572: <tr>
                   8573: <td>crypt</td>
                   8574: <td>-lcrypt</td>
                   8575: <td>DragonFly, NetBSD</td>
                   8576: </tr>
                   8577: <tr>
                   8578: <td>dlopen, dlsym</td>
                   8579: <td>-ldl</td>
                   8580: <td>Linux</td>
                   8581: </tr>
                   8582: <tr>
                   8583: <td>gethost*</td>
                   8584: <td>-lnsl</td>
                   8585: <td>Solaris</td>
                   8586: </tr>
                   8587: <tr>
                   8588: <td>inet_aton</td>
                   8589: <td>-lresolv</td>
                   8590: <td>Solaris</td>
                   8591: </tr>
                   8592: <tr>
                   8593: <td>nanosleep, sem_*, timer_*</td>
                   8594: <td>-lrt</td>
                   8595: <td>Solaris</td>
                   8596: </tr>
                   8597: <tr>
                   8598: <td>openpty</td>
                   8599: <td>-lutil</td>
                   8600: <td>Linux</td>
                   8601: </tr>
                   8602: </tbody>
                   8603: </table>
                   8604: </div>
                   8605: <p>To fix these linker errors, it is often sufficient to say
                   8606:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8607:     -l<em class="replaceable"><code>foo</code></em></code> to the package
                   8608:     <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
                   8609:     bmake</strong></span>.</p>
                   8610: <div class="sect3" lang="en">
                   8611: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8612: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8613: <p>When you are using the SunPro compiler, there is another
                   8614: possibility. That compiler cannot handle the following code:</p>
                   8615: <pre class="programlisting">
                   8616: extern int extern_func(int);
                   8617: 
                   8618: static inline int
                   8619: inline_func(int x)
                   8620: {
                   8621:         return extern_func(x);
                   8622: }
                   8623: 
                   8624: int main(void)
                   8625: {
                   8626:         return 0;
                   8627: }
                   8628: </pre>
                   8629: <p>It generates the code for <code class="function">inline_func</code> even if
                   8630: that function is never used. This code then refers to
                   8631: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8632: solve this problem you can try to tell the package to disable inlining
                   8633: of functions.</p>
                   8634: </div>
                   8635: </div>
                   8636: <div class="sect2" lang="en">
                   8637: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8638: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8639: <p>Sometimes packages fail to build because the compiler runs
                   8640:     into an operating system specific soft limit.  With the
                   8641:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8642:     to unlimit the resources.  Currently, the allowed values are
                   8643:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8644:     Setting this variable is similar to running the shell builtin
                   8645:     <span><strong class="command">ulimit</strong></span> command to raise the maximum data
                   8646:     segment size or maximum stack size of a process, respectively, to
                   8647:     their hard limits.</p>
                   8648: </div>
                   8649: </div>
                   8650: <div class="sect1" lang="en">
                   8651: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8652: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  8653: <div class="sect2" lang="en">
                   8654: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8655: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.1       dsieger  8656: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
                   8657:     with some operating systems cannot create more than one
                   8658:     directory at a time. As such, you should call
                   8659:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8660: <pre class="programlisting">
                   8661: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8662: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8663:     </pre>
                   8664: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
                   8665:     dir2</code></span>&#8221; to the
                   8666:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8667:     automatically do the right thing.</p>
                   8668: </div>
                   8669: <div class="sect2" lang="en">
                   8670: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8671: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8672: <p>In general, documentation should be installed into
                   8673:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8674:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8675:     includes the version number of the package).</p>
                   8676: <p>Many modern packages using GNU autoconf allow to set the
                   8677:     directory where HTML documentation is installed with the
                   8678:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8679:     is needed because otherwise the documentation ends up in
                   8680:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8681:     places.</p>
                   8682: <p>An exception to the above is that library API documentation
                   8683:     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
                   8684:     browsers (devhelp) should be left at their default location, which
                   8685:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8686:     documentation can be recognized from files ending in
                   8687:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8688:     (It is also acceptable to install such files in
                   8689:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8690:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8691:     <code class="filename">.devhelp*</code> file must be directly in that
                   8692:     directory then, no additional subdirectory level is allowed in
                   8693:     this case. This is usually achieved by using
                   8694:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8695:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8696:     though.)</p>
                   8697: </div>
                   8698: <div class="sect2" lang="en">
                   8699: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8700: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8701: <p>Certain packages, most of them in the games category, install
                   8702:     a score file that allows all users on the system to record their
                   8703:     highscores.  In order for this to work, the binaries need to be
                   8704:     installed setgid and the score files owned by the appropriate
                   8705:     group and/or owner (traditionally the "games" user/group).  The
                   8706:     following variables, documented in more detail in
                   8707:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8708:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8709:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8710:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
                   8711: <p>Note that per default, setgid installation of games is
                   8712:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8713:     the other variables accordingly.</p>
                   8714: <p>A package should therefor never hard code file ownership or
                   8715:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8716:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8717:     correctly.</p>
                   8718: </div>
                   8719: <div class="sect2" lang="en">
                   8720: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8721: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.4       rillig   8722: <div class="itemizedlist"><ul type="disc">
                   8723: <li><p>All installation operations have to be prefixed with
                   8724:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8725: <li><p>automake gets this DESTDIR mostly right
                   8726:       automatically. Many manual rules and pre/post-install often are
                   8727:       incorrect; fix them.</p></li>
                   8728: <li><p>If files are installed with special owner/group
                   8729:       either use @owner/@group in the <code class="filename">PLIST</code>
                   8730:       (preferred) or use <code class="varname">SPECIAL_PERMS</code>
                   8731:       (discouraged). Note that @owner/@group are sticky during
                   8732:       install, keep this in mind.</p></li>
                   8733: <li><p>In general, packages should support
                   8734:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8735:       DESTDIR.</p></li>
                   8736: </ul></div>
                   8737: </div>
                   8738: <div class="sect2" lang="en">
                   8739: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8740: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8741: <p>Your package may also contain scripts with hardcoded paths to
                   8742:       other interpreters besides (or as well as) perl.  To correct the
                   8743:       full pathname to the script interpreter, you need to set the
                   8744:       following definitions in your <code class="filename">Makefile</code> (we
                   8745:     shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
                   8746: <pre class="programlisting">
                   8747: REPLACE_INTERPRETER+=   tcl
                   8748: REPLACE.tcl.old=        .*/bin/tclsh
                   8749: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8750: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8751: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8752:     </pre>
                   8753: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8754: <h3 class="title">Note</h3>
                   8755: <p>Before March 2006, these variables were called
                   8756:     <code class="varname">_REPLACE.*</code> and
                   8757:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8758: </div>
                   8759: </div>
                   8760: <div class="sect2" lang="en">
                   8761: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8762: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8763: <p>Makefiles of packages providing perl5 modules should include
                   8764:     the Makefile fragment
                   8765:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
                   8766:     <span><strong class="command">do-configure</strong></span> target for the standard perl
                   8767:     configuration for such modules as well as various hooks to tune
                   8768:     this configuration.  See comments in this file for
                   8769:     details.</p>
                   8770: <p>Perl5 modules will install into different places depending
                   8771:     on the version of perl used during the build process.  To
                   8772:     address this, pkgsrc will append lines to the
                   8773:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8774:     the installed <code class="filename">.packlist</code> file generated by
                   8775:     most perl5 modules.  This is invoked by defining
                   8776:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8777:     paths to packlist files, e.g.:</p>
                   8778: <pre class="programlisting">
                   8779: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8780:     </pre>
                   8781: <p>The variables <code class="varname">PERL5_SITELIB</code>,
                   8782:     <code class="varname">PERL5_SITEARCH</code>, and
                   8783:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8784:     in which perl5 modules may be installed, and may be used by
                   8785:     perl5 packages that don't have a packlist.  These three
                   8786:     variables are also substituted for in the
                   8787:     <code class="filename">PLIST</code>.</p>
                   8788: </div>
                   8789: <div class="sect2" lang="en">
                   8790: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8791: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8792: <p>Some packages install info files or use the
                   8793:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8794:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8795:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8796:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8797:     handle registration of the info files in the Info directory
                   8798:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8799:     files registration is either provided by the system, or by a
                   8800:     special purpose package automatically added as dependency if
                   8801:     needed.</p>
                   8802: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8803:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8804:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8805:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
                   8806: <p>The info files for the package should be listed in the
                   8807:     package <code class="filename">PLIST</code>; however any split info files
                   8808:     need not be listed.</p>
                   8809: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
                   8810:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8811:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8812:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8813:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8814:     variable in the package <code class="filename">Makefile</code>. By
                   8815:     default, a minimum version of 3.12 is required. If the system
                   8816:     does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
                   8817:     does not match the required minimum, a build dependency on the
                   8818:     <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
                   8819:     be added automatically.</p>
                   8820: <p>The build and installation process of the software provided
                   8821:     by the package should not use the
                   8822:     <span><strong class="command">install-info</strong></span> command as the registration of
                   8823:     info files is the task of the package
                   8824:     <code class="filename">INSTALL</code> script, and it must use the
                   8825:     appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
                   8826: <p>To achieve this goal, the pkgsrc infrastructure creates
                   8827:     overriding scripts for the <span><strong class="command">install-info</strong></span> and
                   8828:     <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
                   8829:     in <code class="varname">PATH</code>.</p>
                   8830: <p>The script overriding <span><strong class="command">install-info</strong></span> has
                   8831:     no effect except the logging of a message. The script overriding
                   8832:     <span><strong class="command">makeinfo</strong></span> logs a message and according to the
                   8833:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
                   8834:     <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
                   8835: </div>
                   8836: <div class="sect2" lang="en">
                   8837: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8838: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8839: <p>All packages that install manual pages should install them
                   8840:     into the same directory, so that there is one common place to look
                   8841:     for them. In pkgsrc, this place is
                   8842:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8843:     should be used in packages. The default for
                   8844:     <code class="varname">PKGMANDIR</code> is
                   8845:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8846:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
                   8847: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8848: <h3 class="title">Note</h3>
                   8849: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8850:     is far from complete.</p>
                   8851: </div>
                   8852: <p>The <code class="filename">PLIST</code> files can just use
                   8853:     <code class="filename">man/</code> as the top level directory for the man
                   8854:     page file entries, and the pkgsrc framework will convert as
                   8855:     needed. In all other places, the correct
                   8856:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8857: <p>Packages that are
                   8858:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8859:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8860:     <code class="filename">./configure</code>
                   8861:     --mandir switch to set where the man pages should be installed.
                   8862:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8863:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8864: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8865:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8866:     to &#8220;<span class="quote">no</span>&#8221;.
                   8867:     Or if the <code class="filename">./configure</code> script uses
                   8868:     a non-standard use of --mandir, you can set
                   8869:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.6       rillig   8870: <p>See <a href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.1       dsieger  8871:     information on installation of compressed manual pages.</p>
                   8872: </div>
                   8873: <div class="sect2" lang="en">
                   8874: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   8875: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8876: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8877:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8878:     you need to take some extra steps to make sure they get registered
                   8879:     in the database:</p>
                   8880: <div class="orderedlist"><ol type="1">
1.7       rillig   8881: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  8882:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   8883:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  8884:        deinstallation time, and tells the package where to install
1.7       rillig   8885:        GConf data files using some standard configure arguments.  It
1.1       dsieger  8886:        also disallows any access to the database directly from the
                   8887:        package.</p></li>
                   8888: <li><p>Ensure that the package installs its
                   8889:        <code class="filename">.schemas</code> files under
                   8890:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8891:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8892:        need to manually patch the package.</p></li>
                   8893: <li><p>Check the PLIST and remove any entries under the etc/gconf
                   8894:        directory, as they will be handled automatically.  See
1.6       rillig   8895:        <a 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.7       rillig   8896: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  8897:        your <code class="filename">Makefile</code> with a list of all
                   8898:        <code class="filename">.schemas</code> files installed by the package, if
                   8899:        any.  Names must not contain any directories in them.</p></li>
1.7       rillig   8900: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  8901:        your <code class="filename">Makefile</code> with a
                   8902:        list of all <code class="filename">.entries</code> files installed by the
                   8903:        package, if any. Names must not contain any directories in
                   8904:        them.</p></li>
                   8905: </ol></div>
                   8906: </div>
                   8907: <div class="sect2" lang="en">
                   8908: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8909: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1       dsieger  8910: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8911:     scrollkeeper, you need to take some extra steps to make sure they
                   8912:     get registered in the database:</p>
                   8913: <div class="orderedlist"><ol type="1">
                   8914: <li><p>Include
                   8915:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   8916:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8917:        takes care of rebuilding the scrollkeeper database at
                   8918:        installation and deinstallation time, and disallows any access
                   8919:        to it directly from the package.</p></li>
                   8920: <li><p>Check the PLIST and remove any entries under the
                   8921:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8922:        will be handled automatically.</p></li>
                   8923: <li><p>Remove the <code class="filename">share/omf</code> directory from
                   8924:        the PLIST.  It will be handled by scrollkeeper.</p></li>
                   8925: </ol></div>
                   8926: </div>
                   8927: <div class="sect2" lang="en">
                   8928: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8929: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  8930: <p>If a package installs font files, you will need to rebuild
                   8931:     the fonts database in the directory where they get installed at
                   8932:     installation and deinstallation time.  This can be automatically
                   8933:     done by using the pkginstall framework.</p>
                   8934: <p>You can list the directories where fonts are installed in the
                   8935:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8936:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   8937:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   8938:     Also make sure that the database file
                   8939:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   8940: <p>Note that you should not create new directories for fonts;
                   8941:     instead use the standard ones to avoid that the user needs to
                   8942:     manually configure his X server to find them.</p>
                   8943: </div>
                   8944: <div class="sect2" lang="en">
                   8945: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8946: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  8947: <p>If a package installs GTK2 immodules or loaders, you need to
                   8948:     take some extra steps to get them registered in the GTK2 database
                   8949:     properly:</p>
                   8950: <div class="orderedlist"><ol type="1">
                   8951: <li><p>Include
                   8952:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8953:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8954:       rebuilding the database at installation and deinstallation time.</p></li>
                   8955: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   8956:       your package installs GTK2 immodules.</p></li>
                   8957: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   8958:       GTK2 loaders.</p></li>
                   8959: <li>
                   8960: <p>Patch the package to not touch any of the GTK2
                   8961:       databases directly.  These are:</p>
                   8962: <div class="itemizedlist"><ul type="disc">
                   8963: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8964: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
                   8965: </ul></div>
                   8966: </li>
                   8967: <li><p>Check the <code class="filename">PLIST</code> and remove
                   8968:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8969:       directory, as they will be handled automatically.</p></li>
                   8970: </ol></div>
                   8971: </div>
                   8972: <div class="sect2" lang="en">
                   8973: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8974: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  8975: <p>If a package installs SGML or XML data files that need to be
                   8976:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8977:     etc.), you need to take some extra steps:</p>
                   8978: <div class="orderedlist"><ol type="1">
                   8979: <li><p>Include
                   8980:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8981:        your <code class="filename">Makefile</code>, which takes care of
                   8982:        registering those files in system-wide catalogs at
                   8983:        installation and deinstallation time.</p></li>
                   8984: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
                   8985:        any SGML catalogs installed by the package.</p></li>
                   8986: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
                   8987:        any XML catalogs installed by the package.</p></li>
                   8988: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
                   8989:        to be added to the SGML catalog.  These come in groups of
                   8990:        three strings; see xmlcatmgr(1) for more information
                   8991:        (specifically, arguments recognized by the 'add' action).
                   8992:        Note that you will normally not use this variable.</p></li>
                   8993: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
                   8994:        to be added to the XML catalog.  These come in groups of three
                   8995:        strings; see xmlcatmgr(1) for more information (specifically,
                   8996:        arguments recognized by the 'add' action).  Note that you will
                   8997:        normally not use this variable.</p></li>
                   8998: </ol></div>
                   8999: </div>
                   9000: <div class="sect2" lang="en">
                   9001: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9002: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9003: <p>If a package provides extensions to the MIME database by
                   9004:     installing <code class="filename">.xml</code> files inside
                   9005:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9006:     need to take some extra steps to ensure that the database is kept
                   9007:     consistent with respect to these new files:</p>
                   9008: <div class="orderedlist"><ol type="1">
                   9009: <li><p>Include
                   9010:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9011:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9012:        this same directory, which is reserved for inclusion from
                   9013:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9014:        care of rebuilding the MIME database at installation and
                   9015:        deinstallation time, and disallows any access to it directly
                   9016:        from the package.</p></li>
                   9017: <li><p>Check the PLIST and remove any entries under the
                   9018:        <code class="filename">share/mime</code> directory,
                   9019:        <span class="emphasis"><em>except</em></span> for files saved under
                   9020:        <code class="filename">share/mime/packages</code>.  The former are
                   9021:        handled automatically by
                   9022:        the update-mime-database program, but the latter are
                   9023:        package-dependent and must be removed by the package that
                   9024:        installed them in the first place.</p></li>
                   9025: <li><p>Remove any <code class="filename">share/mime/*</code> directories
                   9026:        from the PLIST.  They will be handled by the shared-mime-info
                   9027:        package.</p></li>
                   9028: </ol></div>
                   9029: </div>
                   9030: <div class="sect2" lang="en">
                   9031: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9032: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9033: <p>If a package uses intltool during its build, add
                   9034:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9035:     which forces it to use the intltool package provided by pkgsrc,
                   9036:     instead of the one bundled with the distribution file.</p>
                   9037: <p>This tracks intltool's build-time dependencies and uses the
                   9038:     latest available version; this way, the package benefits of any
                   9039:     bug fixes that may have appeared since it was released.</p>
                   9040: </div>
                   9041: <div class="sect2" lang="en">
                   9042: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9043: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9044: <p>If a package contains a rc.d script, it won't be copied into
                   9045:     the startup directory by default, but you can enable it, by adding
                   9046:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.4       rillig   9047:     <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9048:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9049:     it will automatically remove the scripts when the package is
                   9050:     deinstalled.</p>
                   9051: </div>
                   9052: <div class="sect2" lang="en">
                   9053: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9054: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9055: <p>If a package installs TeX packages into the texmf tree,
                   9056:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9057:     updated.</p>
                   9058: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9059: <h3 class="title">Note</h3>
                   9060: <p>Except the main TeX packages such as teTeX-texmf,
                   9061:     packages should install files
                   9062:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9063:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
                   9064: </div>
                   9065: <div class="orderedlist"><ol type="1">
                   9066: <li><p>Include
                   9067:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9068:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9069:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9070:       database at installation and deinstallation time.</p></li>
                   9071: <li>
                   9072: <p>If your package installs files into a texmf
                   9073:       tree other than the one
                   9074:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9075:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9076:       trees that need database update.</p>
                   9077: <p>If your package also installs font map files that need
                   9078:       to be registered using <span><strong class="command">updmap</strong></span>,
                   9079:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
                   9080:       such font map files.  Then <span><strong class="command">updmap</strong></span> will
                   9081:       be run automatically at installation/deinstallation to
                   9082:       enable/disable font map files for TeX output
                   9083:       drivers.</p>
                   9084: </li>
                   9085: <li><p>Make sure that none of <code class="filename">ls-R</code>
                   9086:       databases are included in <code class="filename">PLIST</code>, as
                   9087:       they will be removed only by the teTeX-bin package.</p></li>
                   9088: </ol></div>
                   9089: </div>
                   9090: <div class="sect2" lang="en">
                   9091: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9092: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  9093:     emulation</h3></div></div></div>
                   9094: <p>There are some packages that provide libraries and
                   9095:     executables for running binaries from a one operating system
                   9096:     on a different one (if the latter supports it).  One example
                   9097:     is running Linux binaries on NetBSD.</p>
                   9098: <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>
                   9099:     helps in extracting and packaging Linux rpm packages.</p>
                   9100: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
                   9101:     avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
                   9102:     if all libraries for each installed executable can be found by
                   9103:     the dynamic linker.  Since the standard dynamic linker is run,
                   9104:     this fails for emulation packages, because the libraries used
                   9105:     by the emulation are not in the standard directories.</p>
                   9106: </div>
                   9107: <div class="sect2" lang="en">
                   9108: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9109: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9110: <p>If a package installs images under the
                   9111:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9112:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9113:     database, you need to take some extra steps to make sure that the
                   9114:     shared theme directory is handled appropriately and that the cache
                   9115:     database is rebuilt:</p>
                   9116: <div class="orderedlist"><ol type="1">
                   9117: <li><p>Include
                   9118:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9119: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9120:        entry that refers to the theme cache.</p></li>
                   9121: <li><p>Ensure that the PLIST does not remove the shared icon
                   9122:          directories from the <code class="filename">share/icons/hicolor</code>
                   9123:          hierarchy because they will be handled automatically.</p></li>
                   9124: </ol></div>
                   9125: <p>The best way to verify that the PLIST is correct with
                   9126:       respect to the last two points is to regenerate it using
                   9127:       <span><strong class="command">make print-PLIST</strong></span>.</p>
                   9128: </div>
                   9129: <div class="sect2" lang="en">
                   9130: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9131: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  9132: <p>If a package installs <code class="filename">.desktop</code> files
                   9133:       under <code class="filename">share/applications</code> and these include
                   9134:       MIME information, you need to take extra steps to ensure that they
                   9135:       are registered into the MIME database:</p>
                   9136: <div class="orderedlist"><ol type="1">
                   9137: <li><p>Include
                   9138:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9139: <li><p>Check the PLIST and remove the entry that refers to the
                   9140:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9141:          It will be handled automatically.</p></li>
                   9142: </ol></div>
                   9143: <p>The best way to verify that the PLIST is correct with
                   9144:       respect to the last point is to regenerate it using <span><strong class="command">make
                   9145:       print-PLIST</strong></span>.</p>
                   9146: </div>
                   9147: </div>
                   9148: <div class="sect1" lang="en">
                   9149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9150: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9151: <p>In some cases one does not have the time to solve a problem
                   9152:   immediately.  There are currently two ways to declare that one knows
                   9153:   that a package has problems.</p>
                   9154: <div class="itemizedlist"><ul type="disc">
                   9155: <li><p>The first way is to plainly mark it as broken.  For
                   9156:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9157:     reason why the package is broken (similar to the
                   9158:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9159:     the package will immediately be shown this message, and the build
                   9160:     will not be even tried.</p></li>
                   9161: <li><p>After each pkgsrc freeze period (a time when the
                   9162:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9163:     that were not building in the official branch build on the latest
                   9164:     NetBSD release will be marked as broken on that branch.  This is
                   9165:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9166:     branch name (or appending the branch name to it).  If a user tries
                   9167:     to build such a package and the build fails, the user gets a
                   9168:     message that says that the package was broken on the respective
                   9169:     branch(es).</p></li>
                   9170: </ul></div>
                   9171: <p>Both types of packages are removed from pkgsrc in irregular
                   9172:   intervals.</p>
                   9173: </div>
                   9174: </div>
                   9175: <div class="chapter" lang="en">
                   9176: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9177: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9178: <p>To check out all the gotchas when building a package, here are
                   9179:   the steps that I do in order to get a package working.  Please note
                   9180:   this is basically the same as what was explained in the previous
                   9181:   sections, only with some debugging aids.</p>
                   9182: <div class="itemizedlist"><ul type="disc">
1.4       rillig   9183: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.1       dsieger  9184: <li>
                   9185: <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>,
                   9186:       create a directory for a new package, change into it, then run
                   9187:       <span><strong class="command">url2pkg</strong></span>:</p>
                   9188: <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>
                   9189: <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>
                   9190: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9191: </li>
                   9192: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9193: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9194: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
                   9195: <li><p>Add any dependencies glimpsed from documentation and the
                   9196:       configure step to the package's
                   9197:       <code class="filename">Makefile</code>.</p></li>
                   9198: <li>
                   9199: <p>Make the package compile, doing multiple rounds of</p>
                   9200: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9201: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9202: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9203: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9204: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9205: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9206: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9207: <p>Doing this step as non-root user will ensure that no files
                   9208:       are modified that shouldn't be, especially during the build
                   9209:       phase.  <span><strong class="command">mkpatches</strong></span>,
                   9210:       <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
                   9211:       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>
                   9212:       package.</p>
                   9213: </li>
                   9214: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.6       rillig   9215:       necessary; see <a href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.1       dsieger  9216: <li>
                   9217: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9218: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9219: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9220: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9221: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9222: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9223: <p>You usually need to be <code class="username">root</code> to do
                   9224:       this.  Look if there are any files left:</p>
                   9225: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9226: <p>If this reveals any files that are missing in
                   9227:       <code class="filename">PLIST</code>, add them.</p>
                   9228: </li>
                   9229: <li>
                   9230: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9231:       package again and make a binary package:</p>
                   9232: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9233: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9234: </li>
                   9235: <li>
                   9236: <p>Delete the installed package:</p>
                   9237: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9238: </li>
                   9239: <li>
                   9240: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
                   9241:       command, which shouldn't find anything now:</p>
                   9242: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9243: </li>
                   9244: <li>
                   9245: <p>Reinstall the binary package:</p>
                   9246: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9247: </li>
                   9248: <li><p>Play with it.  Make sure everything works.</p></li>
                   9249: <li>
                   9250: <p>Run <span><strong class="command">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
                   9251:       reports:</p>
                   9252: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9253: </li>
1.6       rillig   9254: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1       dsieger  9255: </ul></div>
                   9256: </div>
                   9257: <div class="chapter" lang="en">
                   9258: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9259: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9260: <div class="toc">
                   9261: <p><b>Table of Contents</b></p>
                   9262: <dl>
1.6       rillig   9263: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9264: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9265: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9266: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9267: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   9268: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9269: </dl>
                   9270: </div>
                   9271: <div class="sect1" lang="en">
                   9272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9273: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9274: <p>Our policy is that we accept binaries only from pkgsrc
                   9275:        developers to guarantee that the packages don't contain any
                   9276:        trojan horses etc. This is not to annoy anyone but rather to
                   9277:        protect our users! You're still free to put up your home-made
                   9278:        binary packages and tell the world where to get them. NetBSD
                   9279:        developers doing bulk builds and wanting to upload them please
1.6       rillig   9280:        see <a 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.1       dsieger  9281: </div>
                   9282: <div class="sect1" lang="en">
                   9283: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9284: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9285: <p>First, check that your package is complete, compiles and
1.6       rillig   9286:        runs well; see <a href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.1       dsieger  9287:        document. Next, generate an uuencoded gzipped <a href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
                   9288:        archive that contains all files that make up the package.
                   9289:        Finally, send this package to the pkgsrc bug tracking system,
                   9290:        either with the <a 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
                   9291:        that, go to the web page
1.4       rillig   9292:        <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1       dsieger  9293:        which contains some instructions and a link to a form, where you
                   9294:        can submit packages.</p>
                   9295: <p>In the form of the problem report, the category should be
                   9296:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9297:        and version number, and the description field should contain a
                   9298:        short description of your package (contents of the COMMENT
                   9299:        variable or DESCR file are OK). The uuencoded package data should
                   9300:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
                   9301: <p>If you want to submit several packages, please send a
                   9302:        separate PR for each one, it's easier for us to track things
                   9303:        that way.</p>
                   9304: <p>Alternatively, you can also import new packages into
                   9305:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
                   9306:        homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
                   9307:        for details.</p>
                   9308: </div>
                   9309: <div class="sect1" lang="en">
                   9310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9311: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9312: <p>Please note all package additions, updates, moves, and
                   9313:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9314:        important to keep this file up to date and conforming to the
                   9315:        existing format, because it will be used by scripts to
                   9316:        automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
                   9317:        sites. Additionally, check the
                   9318:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9319:        for the package you updated or removed, in case it was mentioned
                   9320:        there.</p>
                   9321: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9322:        bumped, the change should appear in
                   9323:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9324:        related or otherwise relevant. Mass bumps that result from a
                   9325:        dependency being updated should not be mentioned. In all other
                   9326:        cases it's the developer's decision.</p>
                   9327: <p>There is a make target that helps in creating proper
                   9328:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span><strong class="command">make
                   9329:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9330:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9331:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9332:   file is up-to-date (to avoid having to resolve conflicts later-on)
                   9333:   and then to <span><strong class="command">cd</strong></span> to the package directory.  For
                   9334:   package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
                   9335:   For new packages, or package moves or removals, set the
                   9336:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9337:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.4       rillig   9338:   in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1       dsieger  9339:   not the same as your NetBSD login name. Don't forget to commit
                   9340:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
                   9341: </div>
                   9342: <div class="sect1" lang="en">
                   9343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9344: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1       dsieger  9345: <p>This section is only of interest for pkgsrc developers with write
                   9346:   access to the pkgsrc repository. Please remember that cvs
                   9347:   imports files relative to the current working directory, and that
                   9348:   the pathname that you
                   9349:   give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
                   9350:   to place the files in the repository.  Newly created packages should be
                   9351:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
                   9352:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
                   9353: <pre class="programlisting">
                   9354: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9355: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   9356: </pre>
                   9357: <p>Remember to move the directory from which you imported out of
                   9358:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9359:   update</span>&#8221; your source tree.  Also don't forget to add the new
                   9360:   package to the category's <code class="filename">Makefile</code>.</p>
                   9361: <p>The commit message of the initial import should include part of the
                   9362:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9363:   what the package is/does.</p>
                   9364: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
                   9365:   add</span>&#8221; because the former gets everything with a single command,
                   9366:   and provides a consistent tag.</p>
                   9367: </div>
                   9368: <div class="sect1" lang="en">
                   9369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9370: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9371: <p>Please always put a concise, appropriate and relevant summary of the
                   9372:   changes between old and new versions into the commit log when updating
                   9373:   a package. There are various reasons for this:</p>
                   9374: <div class="itemizedlist"><ul type="disc">
                   9375: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9376:   or its information may be overwritten by newer information.</p></li>
                   9377: <li><p>Having the change information between old and new versions in our CVS
                   9378:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9379: <li><p>Having the change information between old and new versions in our CVS
                   9380:   repository is very useful for people who read the pkgsrc-changes mailing
                   9381:   list, so that they can make tactical decisions about when to upgrade
                   9382:   the package.</p></li>
                   9383: </ul></div>
                   9384: <p>Please also recognize that, just because a new version of a package
                   9385:   has been released, it should not automatically be upgraded in the CVS
                   9386:   repository.  We prefer to be conservative in the packages that are
                   9387:   included in pkgsrc - development or beta packages are not really the
                   9388:   best thing for most places in which pkgsrc is used. Please use your
                   9389:   judgement about what should go into pkgsrc, and bear in mind that
                   9390:   stability is to be preferred above new and possibly untested features.</p>
                   9391: </div>
                   9392: <div class="sect1" lang="en">
                   9393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9394: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1       dsieger  9395: <div class="orderedlist"><ol type="1">
                   9396: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9397: <li>
                   9398: <p>Remove all CVS dirs.</p>
                   9399: <p>Alternatively to the first two steps you can also do:</p>
                   9400: <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>
                   9401: <p>and use that for further work.</p>
                   9402: </li>
                   9403: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9404: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9405: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
                   9406: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
                   9407: place.</p></li>
                   9408: <li>
                   9409: <p>Check if any package depends on it:
                   9410: </p>
                   9411: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9412: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9413: </li>
                   9414: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9415: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9416: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9417: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9418: <li>
                   9419: <p>Commit the changed and removed files:</p>
                   9420: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9421: <p>(and any packages from step 5, of course).</p>
                   9422: </li>
                   9423: </ol></div>
                   9424: </div>
                   9425: </div>
                   9426: <div class="chapter" lang="en">
                   9427: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9428: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9429: <p>This section contains the answers to questions that may
                   9430:        arise when you are writing a package. If you don't find your
                   9431:        question answered here, first have a look in the other chapters,
                   9432:        and if you still don't have the answer, ask on the
                   9433:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9434: <div class="qandaset">
                   9435: <dl>
1.6       rillig   9436: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9437:        MAKEFLAGS, .MAKEFLAGS and
                   9438:        MAKE_FLAGS?</a>
                   9439: </dt>
1.6       rillig   9440: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9441:        MAKE, GMAKE and
                   9442:        MAKE_PROGRAM?</a>
                   9443: </dt>
1.6       rillig   9444: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9445:        CC, PKG_CC and
                   9446:        PKGSRC_COMPILER?</a>
                   9447: </dt>
1.6       rillig   9448: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9449:        BUILDLINK_LDFLAGS,
                   9450:        BUILDLINK_LDADD and
                   9451:        BUILDLINK_LIBS?</a>
                   9452: </dt>
1.6       rillig   9453: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9454:        VARNAME=BUILDLINK_PREFIX.foo
                   9455:        say it's empty?</a>
                   9456: </dt>
1.6       rillig   9457: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9458:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9459:        don't understand the := inside
                   9460:        it.</a>
                   9461: </dt>
1.6       rillig   9462: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9463:        developers?</a>
                   9464: </dt>
1.6       rillig   9465: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9466:        documentation?</a>
                   9467: </dt>
1.6       rillig   9468: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9469: do?</a>
                   9470: </dt>
                   9471: </dl>
                   9472: <table border="0" summary="Q and A Set">
                   9473: <col align="left" width="1%">
                   9474: <tbody>
                   9475: <tr class="question">
                   9476: <td align="left" valign="top">
1.9     ! rillig   9477: <a name="devfaq.makeflags"></a><a name="id2713325"></a><b>22.1.</b>
1.1       dsieger  9478: </td>
                   9479: <td align="left" valign="top"><p>What is the difference between
                   9480:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9481:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9482: </tr>
                   9483: <tr class="answer">
                   9484: <td align="left" valign="top"></td>
                   9485: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
                   9486:        to the pkgsrc-internal invocations of <a 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
                   9487:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9488:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9489:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9490: </tr>
                   9491: <tr class="question">
                   9492: <td align="left" valign="top">
1.9     ! rillig   9493: <a name="devfaq.make"></a><a name="id2713364"></a><b>22.2.</b>
1.1       dsieger  9494: </td>
                   9495: <td align="left" valign="top"><p>What is the difference between
                   9496:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9497:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9498: </tr>
                   9499: <tr class="answer">
                   9500: <td align="left" valign="top"></td>
                   9501: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
                   9502:        <a 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
                   9503:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9504:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9505:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9506:        Make program that is used for building the
                   9507:        package.</p></td>
                   9508: </tr>
                   9509: <tr class="question">
                   9510: <td align="left" valign="top">
1.9     ! rillig   9511: <a name="devfaq.cc"></a><a name="id2713404"></a><b>22.3.</b>
1.1       dsieger  9512: </td>
                   9513: <td align="left" valign="top"><p>What is the difference between
                   9514:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9515:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9516: </tr>
                   9517: <tr class="answer">
                   9518: <td align="left" valign="top"></td>
                   9519: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9520:        compiler, which can be configured by the pkgsrc user.
                   9521:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9522:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9523:        path to a compiler, but the type of compiler that should be
                   9524:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9525:        information about the latter variable.</p></td>
                   9526: </tr>
                   9527: <tr class="question">
                   9528: <td align="left" valign="top">
1.9     ! rillig   9529: <a name="devfaq.bl3flags"></a><a name="id2713444"></a><b>22.4.</b>
1.1       dsieger  9530: </td>
                   9531: <td align="left" valign="top"><p>What is the difference between
                   9532:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9533:        <code class="varname">BUILDLINK_LDADD</code> and
                   9534:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9535: </tr>
                   9536: <tr class="answer">
                   9537: <td align="left" valign="top"></td>
                   9538: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9539: </tr>
                   9540: <tr class="question">
                   9541: <td align="left" valign="top">
1.9     ! rillig   9542: <a name="devfaq.bl3prefix"></a><a name="id2713464"></a><b>22.5.</b>
1.1       dsieger  9543: </td>
                   9544: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
                   9545:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9546:        say it's empty?</p></td>
                   9547: </tr>
                   9548: <tr class="answer">
                   9549: <td align="left" valign="top"></td>
                   9550: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9551:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9552:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
                   9553:        <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
                   9554:        command.</p></td>
                   9555: </tr>
                   9556: <tr class="question">
                   9557: <td align="left" valign="top">
1.9     ! rillig   9558: <a name="devfaq.master_sites"></a><a name="id2713494"></a><b>22.6.</b>
1.1       dsieger  9559: </td>
                   9560: <td align="left" valign="top"><p>What does
                   9561:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9562:        don't understand the <code class="literal">:=</code> inside
                   9563:        it.</p></td>
                   9564: </tr>
                   9565: <tr class="answer">
                   9566: <td align="left" valign="top"></td>
                   9567: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9568:        assignment operator, like you might expect at first sight.
                   9569:        Instead, it is a degenerate form of
                   9570:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   9571:        which is documented in the <a 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
                   9572:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9573:        case of <code class="varname">MASTER_SITE_*</code>,
                   9574:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9575:        <em class="replaceable"><code>new_string</code></em> is
                   9576:        <code class="literal">package/</code>. That's where the
                   9577:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9578:        together.</p></td>
                   9579: </tr>
                   9580: <tr class="question">
                   9581: <td align="left" valign="top">
1.9     ! rillig   9582: <a name="devfaq.mailinglists"></a><a name="id2713571"></a><b>22.7.</b>
1.1       dsieger  9583: </td>
                   9584: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9585:        developers?</p></td>
                   9586: </tr>
                   9587: <tr class="answer">
                   9588: <td align="left" valign="top"></td>
                   9589: <td align="left" valign="top"><div class="variablelist"><dl>
1.4       rillig   9590: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1       dsieger  9591: <dd><p>This is a list for technical discussions related
                   9592:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9593:        pkgsrc infrastructure, proposed new features, questions related
                   9594:        to porting pkgsrc to a new platform, advice for maintaining a
                   9595:        package, patches that affect many packages, help requests moved
                   9596:        from pkgsrc-users when an infrastructure bug is found,
                   9597:        etc.</p></dd>
1.4       rillig   9598: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1       dsieger  9599: <dd><p>All bug reports in category "pkg" sent with
                   9600:        <a 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
                   9601:        directly; use one of the other mailing
                   9602:        lists.</p></dd>
                   9603: </dl></div></td>
                   9604: </tr>
                   9605: <tr class="question">
                   9606: <td align="left" valign="top">
1.9     ! rillig   9607: <a name="devfaq.documentation"></a><a name="id2713609"></a><b>22.8.</b>
1.1       dsieger  9608: </td>
                   9609: <td align="left" valign="top"><p>Where is the pkgsrc
                   9610:        documentation?</p></td>
                   9611: </tr>
                   9612: <tr class="answer">
                   9613: <td align="left" valign="top"></td>
                   9614: <td align="left" valign="top">
                   9615: <p>There are many places where you can find
                   9616:        documentation about pkgsrc:</p>
                   9617: <div class="itemizedlist"><ul type="disc">
                   9618: <li><p>The pkgsrc guide (this document) is a collection
                   9619:        of chapters that explain large parts of pkgsrc, but some
                   9620:        chapters tend to be outdated. Which ones they are is hard to
                   9621:        say.</p></li>
                   9622: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
                   9623:        about certain features, announcements of new parts of the pkgsrc
                   9624:        infrastructure and sometimes even announcements that a certain
                   9625:        feature has been marked as obsolete. The benefit here is that
                   9626:        each message has a date appended to it.</p></li>
                   9627: <li><p>Many of the files in the
                   9628:        <code class="filename">mk/</code> directory start with a comment that
                   9629:        describes the purpose of the file and how it can be used by the
                   9630:        pkgsrc user and package authors. An easy way to find this
                   9631:        documentation is to run <span><strong class="command">bmake
                   9632:        help</strong></span>.</p></li>
                   9633: <li><p>The CVS log messages are a rich source of
                   9634:        information, but they tend to be highly abbreviated, especially
                   9635:        for actions that occur often. Some contain a detailed
                   9636:        description of what has changed, but they are geared towards the
                   9637:        other pkgsrc developers, not towards an average pkgsrc user.
                   9638:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9639:        don't know what has been before, these messages may not be worth
                   9640:        too much to you.</p></li>
                   9641: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9642:        documented</span>&#8221;, that is the documentation exists only in the
                   9643:        mind of the developer who wrote the code. To get this
                   9644:        information, use the <span><strong class="command">cvs annotate</strong></span> command
                   9645:        to see who has written it and ask on the
                   9646:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9647:        find your questions later (see above). To be sure that the
                   9648:        developer in charge reads the mail, you may CC him or
                   9649:        her.</p></li>
                   9650: </ul></div>
                   9651: </td>
                   9652: </tr>
                   9653: <tr class="question">
                   9654: <td align="left" valign="top">
1.9     ! rillig   9655: <a name="devfaq.too-much-time"></a><a name="id2713671"></a><b>22.9.</b>
1.1       dsieger  9656: </td>
                   9657: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9658: do?</p></td>
                   9659: </tr>
                   9660: <tr class="answer">
                   9661: <td align="left" valign="top"></td>
                   9662: <td align="left" valign="top">
                   9663: <p>This is not really an FAQ yet, but here's the answer
                   9664: anyway.</p>
                   9665: <div class="itemizedlist"><ul type="disc">
                   9666: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
                   9667:     <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
                   9668:     will tell you about newer versions of installed packages that are
                   9669:     available, but not yet updated in pkgsrc.</p></li>
                   9670: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.6       rillig   9671:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9672:     cleanups and enhancements for pkgsrc that would be nice to
                   9673:     have.</p></li>
                   9674: <li><p>Review packages for which review was requested on
                   9675:     the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
                   9676:     mailing list.</p></li>
                   9677: </ul></div>
                   9678: </td>
                   9679: </tr>
                   9680: </tbody>
                   9681: </table>
                   9682: </div>
                   9683: </div>
                   9684: <div class="chapter" lang="en">
                   9685: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9686: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9687: <div class="toc">
                   9688: <p><b>Table of Contents</b></p>
                   9689: <dl>
1.6       rillig   9690: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9691: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9692: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9693: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9694: </dl>
                   9695: </div>
                   9696: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
                   9697: site</a>:</p>
                   9698: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9699:   environment, an intuitive and attractive desktop for users, and the
                   9700:   GNOME development platform, an extensive framework for building
                   9701:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9702: <p>pkgsrc provides a seamless way to automatically build and install
                   9703: a complete GNOME environment <span class="emphasis"><em>under many different
                   9704: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9705: the most advanced build and packaging systems for GNOME due to its
                   9706: included technologies buildlink3, the wrappers and tools framework and
                   9707: automatic configuration file management.  Lots of efforts are put into
                   9708: achieving a completely clean deinstallation of installed software
                   9709: components.</p>
                   9710: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9711: the above also means that great efforts are put into making GNOME work
                   9712: under this operating system.  Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9713: pkgsrc as its preferred packaging system, contributing lots of
                   9714: portability fixes to make GNOME build and install under it.</p>
                   9715: <p>This chapter is aimed at pkgsrc developers and other people
                   9716: interested in helping our GNOME porting and packaging efforts.  It
                   9717: provides instructions on how to manage the existing packages and some
                   9718: important information regarding their internals.</p>
                   9719: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9720: <h3 class="title">We need your help!</h3>
                   9721: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9722:   and GNOME and are willing to learn new exciting stuff, please jump
                   9723:   straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9724:   work</a> list!  There is still a long way to go to get a
                   9725:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9726:   achieve it!</p>
                   9727: </div>
                   9728: <div class="sect1" lang="en">
                   9729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9730: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9731: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9732: <div class="itemizedlist"><ul type="disc">
                   9733: <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
                   9734:     the core GNOME desktop environment.  It only includes the necessary
                   9735:     bits to get it to boot correctly, although it may lack important
                   9736:     functionality for daily operation.  The idea behind this package is
                   9737:     to let end users build their own configurations on top of this one,
                   9738:     first installing this meta package to achieve a functional setup and
                   9739:     then adding individual applications.</p></li>
                   9740: <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
                   9741:     complete installation of the GNOME platform and desktop as defined
                   9742:     by the GNOME project; this is based on the components distributed in
                   9743:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9744:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9745:     official FTP server.  Developer-only tools found in those
                   9746:     directories are not installed unless required by some other
                   9747:     component to work properly.  Similarly, packages from the bindings
                   9748:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9749:     in unless required as a dependency for an end-user component.  This
                   9750:     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>
                   9751: <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>:
                   9752:     Installs all the tools required to build a GNOME component when
                   9753:     fetched from the CVS repository.  These are required to let the
                   9754:     <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9755: </ul></div>
                   9756: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9757: sorted in a way that eases updates: a package may depend on other
                   9758: packages listed before it but not on any listed after it.  It is very
                   9759: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9760: change it to alphabetical sorting!</em></span></p>
                   9761: </div>
                   9762: <div class="sect1" lang="en">
                   9763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9764: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9765: <p>Almost all GNOME applications are written in C and use a common
                   9766: set of tools as their build system.  Things get different with the new
                   9767: bindings to other languages (such as Python), but the following will
                   9768: give you a general idea on the minimum required tools:</p>
                   9769: <div class="itemizedlist"><ul type="disc">
                   9770: <li>
                   9771: <p>Almost all GNOME applications use the GNU Autotools as their
                   9772:     build system.  As a general rule you will need to tell this to your
                   9773:     package:</p>
                   9774: <pre class="programlisting">
                   9775: GNU_CONFIGURE=yes
                   9776: USE_LIBTOOL=yes
                   9777: USE_TOOLS+=gmake
                   9778: </pre>
                   9779: </li>
                   9780: <li>
                   9781: <p>If the package uses pkg-config to detect dependencies, add this
                   9782:     tool to the list of required utilities:</p>
                   9783: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   9784: <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
                   9785:     the end of the build process to ensure that you did not miss to
                   9786:     specify any dependency in your package and that the version
                   9787:     requirements are all correct.</p>
                   9788: </li>
                   9789: <li><p>If the package uses intltool, be sure to add
                   9790:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9791:     to handle dependencies and to force the package to use the latest
                   9792:     available version.</p></li>
                   9793: <li>
                   9794: <p>If the package uses gtk-doc (a documentation generation
                   9795:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9796:     tool is rather big and the distfile should come with pregenerated
                   9797:     documentation anyway; if it does not, it is a bug that you ought to
                   9798:     report.  For such packages you should disable gtk-doc (unless it is
                   9799:     the default):</p>
                   9800: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9801: <p>The default location of installed HTML files
                   9802:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9803:     and should not be changed unless the package insists on installing
                   9804:     them somewhere else.  Otherwise programs as
                   9805:     <span><strong class="command">devhelp</strong></span> will not be able to open them.  You can
                   9806:     do that with an entry similar to:</p>
                   9807: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   9808: </li>
                   9809: </ul></div>
                   9810: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9811: files under the installation prefix to maintain databases.  In this
                   9812: context, shared means that those exact same directories and files are
                   9813: used among several different packages, leading to conflicts in the
                   9814: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9815: handle the most common cases, so you have to forget about using
                   9816: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9817: omitting shared files from them.  If you find yourself doing those,
                   9818: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9819: <p>The following table lists the common situations that result in
                   9820: using shared directories or files.  For each of them, the appropriate
                   9821: solution is given.  After applying the solution be sure to
                   9822: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9823: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
                   9824: <div class="table">
1.6       rillig   9825: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  9826: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   9827: <colgroup>
                   9828: <col>
                   9829: <col>
                   9830: </colgroup>
                   9831: <thead><tr>
                   9832: <th>If the package...</th>
                   9833: <th>Then...</th>
                   9834: </tr></thead>
                   9835: <tbody>
                   9836: <tr>
                   9837: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.6       rillig   9838: <td>See <a href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, &#8220;Packages installing scrollkeeper data files&#8221;</a>.</td>
1.1       dsieger  9839: </tr>
                   9840: <tr>
                   9841: <td>Installs icons under the
                   9842:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9843:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.6       rillig   9844: <td>See <a 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.1       dsieger  9845: </tr>
                   9846: <tr>
                   9847: <td>Installs files under
                   9848:         <code class="filename">share/mime/packages</code>.</td>
1.6       rillig   9849: <td>See <a 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.1       dsieger  9850: </tr>
                   9851: <tr>
                   9852: <td>Installs <code class="filename">.desktop</code> files under
                   9853:         <code class="filename">share/applications</code> and these include MIME
                   9854:         information.</td>
1.6       rillig   9855: <td>See <a href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.1       dsieger  9856: </tr>
                   9857: </tbody>
                   9858: </table></div>
                   9859: </div>
                   9860: <br class="table-break">
                   9861: </div>
                   9862: <div class="sect1" lang="en">
                   9863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9864: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  9865: <p>When seeing GNOME as a whole, there are two kinds of
                   9866: updates:</p>
                   9867: <div class="variablelist"><dl>
                   9868: <dt><span class="term">Major update</span></dt>
                   9869: <dd>
                   9870: <p>Given that there is still a very long way for GNOME 3 (if it
                   9871:       ever appears), we consider a major update one that goes from a
                   9872:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9873:       where <code class="literal">Y</code> is even and greater than
                   9874:       <code class="literal">X</code>.  These are hard to achieve because they
                   9875:       introduce lots of changes in the components' code and almost all
                   9876:       GNOME distfiles are updated to newer versions.  Some of them can
                   9877:       even break API and ABI compatibility with the previous major
                   9878:       version series.  As a result, the update needs to be done all at
                   9879:       once to minimize breakage.</p>
                   9880: <p>A major update typically consists of around 80 package
                   9881:       updates and the addition of some new ones.</p>
                   9882: </dd>
                   9883: <dt><span class="term">Minor update</span></dt>
                   9884: <dd>
                   9885: <p>We consider a minor update one that goes from a
                   9886:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9887:       one where <code class="literal">Y</code> is greater than
                   9888:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9889:       not update all GNOME components, can be done in an incremental way
                   9890:       and do not break API nor ABI compatibility.</p>
                   9891: <p>A minor update typically consists of around 50 package
                   9892:       updates, although the numbers here may vary a lot.</p>
                   9893: </dd>
                   9894: </dl></div>
                   9895: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9896: release (either major or minor), the following steps should be
                   9897: followed:</p>
                   9898: <div class="orderedlist"><ol type="1">
                   9899: <li>
                   9900: <p>Get a list of all the tarballs that form the new release by
                   9901:     using the following commands.  These will leave the full list of the
                   9902:     components's distfiles into the <code class="filename">list.txt</code>
                   9903:     file:</p>
                   9904: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9905:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9906:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9907: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9908:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9909:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9910: </li>
                   9911: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   9912:     bump their version to the release you are updating them to.  The
                   9913:     three meta packages should be always consistent with versioning.
                   9914:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9915:     in them.</p></li>
                   9916: <li>
                   9917: <p>For each meta package, update all its
                   9918:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9919:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9920:     newer version (even if found in the FTP) because the meta packages
                   9921:     are supposed to list the exact versions that form a specific GNOME
                   9922:     release.  Exceptions are permitted here if a newer version solves a
                   9923:     serious issue in the overall desktop experience; these typically
                   9924:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9925:     from the developers.</p>
                   9926: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9927:     should be updated to the latest version available (if found in
                   9928:     pkgsrc).  This is the case, for example, of the dependencies on the
                   9929:     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>
                   9930: </li>
                   9931: <li>
                   9932: <p>Generate a patch from the modified meta packages and extract the
                   9933:     list of "new" lines.  This will provide you an outline on what
                   9934:     packages need to be updated in pkgsrc and in what order:</p>
                   9935: <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>
                   9936: </li>
                   9937: <li><p>For major desktop updates it is recommended to zap all your
                   9938:     installed packages and start over from scratch at this point.</p></li>
                   9939: <li><p>Now comes the longest step by far: iterate over the contents
                   9940:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9941:     it in order.  For major desktop updates none of these should be
                   9942:     committed until the entire set is completed because there are chances
                   9943:     of breaking not-yet-updated packages.</p></li>
                   9944: <li><p>Once the packages are up to date and working, commit them to
                   9945:     the tree one by one with appropriate log messages.  At the end,
                   9946:     commit the three meta package updates and all the corresponding
                   9947:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9948:     <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>
                   9949: </ol></div>
                   9950: </div>
                   9951: <div class="sect1" lang="en">
                   9952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9953: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  9954: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9955: packages.  Please, it is very important that you always, always,
                   9956: <span class="strong"><strong>always</strong></span> feed back any portability
1.6       rillig   9957: fixes you do to a GNOME package to the mainstream developers (see <a 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.1       dsieger  9958: their attention on portability issues and to ensure that future versions
                   9959: can be built out-of-the box on NetBSD.  The less custom patches in
                   9960: pkgsrc, the easier further updates are.  Those developers in charge of
                   9961: issuing major GNOME updates will be grateful if you do that.</p>
                   9962: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
                   9963: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9964: of them do.  Do not be short on your reports: always provide detailed
                   9965: explanations of the current failure, how it can be improved to achieve
                   9966: maximum portability and, if at all possible, provide a patch against CVS
                   9967: head.  The more verbose you are, the higher chances of your patch being
                   9968: accepted.</p>
                   9969: <p>Also, please avoid using preprocessor magic to fix portability
                   9970: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9971: GNOME to their operating system, the official GNOME sources are now
                   9972: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9973: and similar macros.  This hurts portability.  Please see our patching
1.6       rillig   9974: guidelines (<a href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.1       dsieger  9975: details.</p>
                   9976: </div>
                   9977: </div>
                   9978: </div>
                   9979: <div class="part" lang="en">
                   9980: <div class="titlepage"><div><div><h1 class="title">
                   9981: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   9982: <div class="partintro" lang="en">
                   9983: <div></div>
                   9984: <p>This part of the guide deals with everything
                   9985:        from the infrastructure that is behind the interfaces described
                   9986:        in the developer's guide. A casual package maintainer should not
                   9987:        need anything from this part.</p>
                   9988: <div class="toc">
                   9989: <p><b>Table of Contents</b></p>
                   9990: <dl>
1.6       rillig   9991: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  9992: <dd><dl>
1.6       rillig   9993: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9994: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9995: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  9996: <dd><dl>
1.6       rillig   9997: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9998: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  9999: </dl></dd>
1.6       rillig   10000: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10001: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10002: <dd><dl>
1.6       rillig   10003: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10004: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10005: </dl></dd>
1.6       rillig   10006: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10007: <dd><dl>
1.6       rillig   10008: <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>
                   10009: <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.1       dsieger  10010: </dl></dd>
                   10011: </dl></dd>
1.6       rillig   10012: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10013: <dd><dl>
1.6       rillig   10014: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10015: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10016: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10017: <dd><dl>
1.6       rillig   10018: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10019: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10020: </dl></dd>
                   10021: </dl></dd>
1.6       rillig   10022: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10023: <dd><dl>
1.6       rillig   10024: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10025: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10026: </dl></dd>
                   10027: </dl>
                   10028: </div>
                   10029: </div>
                   10030: <div class="chapter" lang="en">
                   10031: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10032: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10033: <div class="toc">
                   10034: <p><b>Table of Contents</b></p>
                   10035: <dl>
1.6       rillig   10036: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10037: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10038: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10039: <dd><dl>
1.6       rillig   10040: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10041: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10042: </dl></dd>
1.6       rillig   10043: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10044: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10045: <dd><dl>
1.6       rillig   10046: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10047: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10048: </dl></dd>
1.6       rillig   10049: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10050: <dd><dl>
1.6       rillig   10051: <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>
                   10052: <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.1       dsieger  10053: </dl></dd>
                   10054: </dl>
                   10055: </div>
                   10056: <p>The pkgsrc infrastructure consists of many small Makefile
                   10057:        fragments. Each such fragment needs a properly specified
                   10058:        interface. This chapter explains how such an interface looks
                   10059:        like.</p>
                   10060: <div class="sect1" lang="en">
                   10061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10062: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10063: <p>Whenever a variable is defined in the pkgsrc
                   10064:        infrastructure, the location and the way of definition provide
                   10065:        much information about the intended use of that variable.
                   10066:        Additionally, more documentation may be found in a header
                   10067:        comment or in this pkgsrc guide.</p>
                   10068: <p>A special file is
                   10069:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10070:        variables that are intended to be user-defined. They are either
                   10071:        defined using the <code class="literal">?=</code> operator or they are
                   10072:        left undefined because defining them to anything would
                   10073:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10074:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10075:        file.</p>
                   10076: <p>Outside this file, the following conventions apply:
                   10077:        Variables that are defined using the <code class="literal">?=</code>
                   10078:        operator may be overridden by a package.</p>
                   10079: <p>Variables that are defined using the <code class="literal">=</code>
                   10080:        operator may be used read-only at run-time.</p>
                   10081: <p>Variables whose name starts with an underscore must not be
                   10082:        accessed outside the pkgsrc infrastructure at all. They may
                   10083:        change without further notice.</p>
                   10084: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10085: <h3 class="title">Note</h3>
                   10086: <p>These conventions are currently not applied
                   10087:        consistently to the complete pkgsrc
                   10088:        infrastructure.</p>
                   10089: </div>
                   10090: </div>
                   10091: <div class="sect1" lang="en">
                   10092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10093: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10094: <p>All variables that contain lists of things should default
                   10095:        to being empty. Two examples that do not follow this rule are
                   10096:        <code class="varname">USE_LANGUAGES</code> and
                   10097:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10098:        modified using the <code class="literal">+=</code> operator in package
                   10099:        <code class="filename">Makefile</code>s (or other files included by
                   10100:        them), since there is no guarantee whether the variable is
                   10101:        already set or not, and what its value is. In the case of
                   10102:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10103:        the default value and just define it as in the following
                   10104:        example.</p>
                   10105: <pre class="programlisting">
                   10106: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10107: </pre>
                   10108: <p>Because of the selection of this default value, the same
                   10109:        value appears in many package Makefiles. Similarly for
                   10110:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10111:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10112:        doesn't stand out. Nevertheless it is mentioned in many
                   10113:        files.</p>
                   10114: </div>
                   10115: <div class="sect1" lang="en">
                   10116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10117: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1       dsieger  10118: <div class="sect2" lang="en">
                   10119: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10120: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10121: <p>Variable evaluation takes place either at load time or at
                   10122:        runtime, depending on the context in which they occur. The
                   10123:        contexts where variables are evaluated at load time are:</p>
                   10124: <div class="itemizedlist"><ul type="disc">
                   10125: <li><p>The right hand side of the <code class="literal">:=</code>
                   10126:        and <code class="literal">!=</code> operators,</p></li>
                   10127: <li><p>Make directives like <code class="literal">.if</code> or
                   10128:        <code class="literal">.for</code>,</p></li>
                   10129: <li><p>Dependency lines.</p></li>
                   10130: </ul></div>
                   10131: <p>A special exception are references to the iteration
                   10132:        variables of <code class="literal">.for</code> loops, which are expanded
                   10133:        inline, no matter in which context they appear.</p>
                   10134: <p>As the values of variables may change during load time,
                   10135:        care must be taken not to evaluate them by accident. Typical
                   10136:        examples for variables that should not be evaluated at load time
                   10137:        are <code class="varname">DEPENDS</code> and
                   10138:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10139:        clear, here is an example:</p>
                   10140: <pre class="programlisting">
                   10141: CONFIGURE_ARGS=         # none
                   10142: CFLAGS=                 -O
                   10143: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10144: 
                   10145: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10146: 
                   10147: CFLAGS+=                -Wall
                   10148:        </pre>
                   10149: <p>This code shows how the use of the <code class="literal">:=</code>
                   10150:        operator can quickly lead to unexpected results. The first
                   10151:        paragraph is fairly common code. The second paragraph evaluates
                   10152:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10153:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10154:        <code class="literal">-Wall</code> is appended to the
                   10155:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10156:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10157:        paragraphs from above typically occur in completely unrelated
                   10158:        files.</p>
                   10159: </div>
                   10160: <div class="sect2" lang="en">
                   10161: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10162: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10163: <p>After all the files have been loaded, the values of the
                   10164:        variables cannot be changed anymore. Variables that are used in
                   10165:        the shell commands are expanded at this point.</p>
                   10166: </div>
                   10167: </div>
                   10168: <div class="sect1" lang="en">
                   10169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10170: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10171: <p>There are many ways in which the definition and use of a
                   10172:        variable can be restricted in order to detect bugs and
                   10173:        violations of the (mostly unwritten) policies. See the
                   10174:        <code class="literal">pkglint</code> developer's documentation for further
                   10175:        details.</p>
                   10176: </div>
                   10177: <div class="sect1" lang="en">
                   10178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10179: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10180: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10181:        of the following classes. Cases where a file falls into more
                   10182:        than one class should be avoided as it often leads to subtle
                   10183:        bugs.</p>
                   10184: <div class="sect2" lang="en">
                   10185: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10186: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10187: <p>In a traditional imperative programming language some of
                   10188:        the <code class="filename">.mk</code> files could be described as
1.6       rillig   10189:        procedures. They take some input parameters and&mdash;after
                   10190:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10191:        variables in <code class="filename">Makefile</code>s have global scope
                   10192:        care must be taken not to use parameter names that have already
                   10193:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10194:        bad choice for a parameter name.</p>
                   10195: <p>Procedures are completely evaluated at preprocessing time.
                   10196:        That is, when calling a procedure all input parameters must be
                   10197:        completely resolvable. For example,
                   10198:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10199:        parameter since it is very likely that further text will be
                   10200:        added after calling the procedure, which would effectively apply
                   10201:        the procedure to only a part of the variable. Also, references
                   10202:        to other variables wit will be modified after calling the
                   10203:        procedure.</p>
                   10204: <p>A procedure can declare its output parameters either as
                   10205:        suitable for use in preprocessing directives or as only
                   10206:        available at runtime. The latter alternative is for variables
                   10207:        that contain references to other runtime variables.</p>
                   10208: <p>Procedures shall be written such that it is possible to
                   10209:        call the procedure more than once. That is, the file must not
                   10210:        contain multiple-inclusion guards.</p>
                   10211: <p>Examples for procedures are
                   10212:        <code class="filename">mk/bsd.options.mk</code> and
                   10213:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10214:        that the parameters are evaluated at load time, they should be
                   10215:        assigned using the <code class="literal">:=</code> operator, which should
                   10216:        be used only for this purpose.</p>
                   10217: </div>
                   10218: <div class="sect2" lang="en">
                   10219: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10220: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10221: <p>Action files take some input parameters and may define
                   10222:        runtime variables. They shall not define loadtime variables.
                   10223:        There are action files that are included implicitly by the
                   10224:        pkgsrc infrastructure, while other must be included
                   10225:        explicitly.</p>
                   10226: <p>An example for action files is
                   10227:        <code class="filename">mk/subst.mk</code>.</p>
                   10228: </div>
                   10229: </div>
                   10230: <div class="sect1" lang="en">
                   10231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10232: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10233: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10234:        a set of variable definitions, and include the file
                   10235:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10236:        Before that, they may also include various other
                   10237:        <code class="filename">*.mk</code> files if they need to query the
                   10238:        availability of certain features like the type of compiler or
                   10239:        the X11 implementation. Due to the heavy use of preprocessor
                   10240:        directives like <code class="literal">.if</code> and
                   10241:        <code class="literal">.for</code>, the order in which the files are loaded
                   10242:        matters.</p>
                   10243: <p>This section describes at which point the various files
                   10244:        are loaded and gives reasons for that order.</p>
                   10245: <div class="sect2" lang="en">
                   10246: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10247: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10248: </h3></div></div></div>
                   10249: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10250:        is to define some essential variables like
                   10251:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10252:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10253: <p>Then, the user settings are loaded from the file specified
1.4       rillig   10254:        in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
                   10255:        After that, those variables
1.1       dsieger  10256:        that have not been overridden by the user are loaded from
                   10257:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10258: <p>After the user settings, the system settings and platform
                   10259:        settings are loaded, which may override the user
                   10260:        settings.</p>
                   10261: <p>Then, the tool definitions are loaded. The tool wrappers
                   10262:        are not yet in effect. This only happens when building a
                   10263:        package, so the proper variables must be used instead of the
                   10264:        direct tool names.</p>
                   10265: <p>As the last steps, some essential variables from the
                   10266:        wrapper and the package system flavor are loaded, as well as the
                   10267:        variables that have been cached in earlier phases of a package
                   10268:        build.</p>
                   10269: </div>
                   10270: <div class="sect2" lang="en">
                   10271: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10272: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10273: </h3></div></div></div>
                   10274: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10275: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10276:        loaded, which fill default values for those variables that have
                   10277:        not been defined by the package. These variables may later
                   10278:        be used even in unrelated files.</p>
                   10279: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10280:        provides the target <code class="literal">error-check</code> that is added
                   10281:        as a special dependency to all other targets that use
                   10282:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10283:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10284: <p>Then, the package-specific hacks from
                   10285:        <code class="filename">hacks.mk</code> are included.</p>
                   10286: <p>Then, various other files follow. Most of them don't have
                   10287:        any dependencies on what they need to have included before or
                   10288:        after them, though some do.</p>
                   10289: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10290:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10291:        restricts the use of these variables to all the files that have
                   10292:        been included before. Appearances in later files will be
                   10293:        silently ignored.</p>
                   10294: <p>Then, the files for the main targets are included, in the
                   10295:        order of later execution, though the actual order should not
                   10296:        matter.</p>
                   10297: <p>At last, some more files are included that don't set any
                   10298:        interesting variables but rather just define make targets to be
                   10299:        executed.</p>
                   10300: </div>
                   10301: </div>
                   10302: </div>
                   10303: <div class="chapter" lang="en">
                   10304: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10305: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10306: <div class="toc">
                   10307: <p><b>Table of Contents</b></p>
                   10308: <dl>
1.6       rillig   10309: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10310: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10311: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10312: <dd><dl>
1.6       rillig   10313: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10314: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10315: </dl></dd>
                   10316: </dl>
                   10317: </div>
                   10318: <p>The pkgsrc infrastructure consists of a large codebase,
                   10319:        and there are many corners where every little bit of a file is
                   10320:        well thought out, making pkgsrc likely to fail as soon as
                   10321:        anything is changed near those parts. To prevent most changes
                   10322:        from breaking anything, a suite of regression tests should go
                   10323:        along with every important part of the pkgsrc infrastructure.
                   10324:        This chapter describes how regression tests work in pkgsrc and
                   10325:        how you can add new tests.</p>
                   10326: <div class="sect1" lang="en">
                   10327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10328: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10329: <p></p>
                   10330: </div>
                   10331: <div class="sect1" lang="en">
                   10332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10333: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10334: <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
                   10335:        provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
                   10336:        can simply run that command, which will run all tests in the
                   10337:        <code class="filename">regress</code> category.</p>
                   10338: </div>
                   10339: <div class="sect1" lang="en">
                   10340: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10341: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10342: <p>Every directory in the <code class="filename">regress</code>
                   10343:        category that contains a file called <code class="filename">spec</code>
                   10344:        is considered a regression test. This file is a shell program
                   10345:        that is included by the <span><strong class="command">pkg_regress</strong></span> command.
                   10346:        The following functions can be overridden to suit your
                   10347:        needs.</p>
                   10348: <div class="sect2" lang="en">
                   10349: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10350: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10351: <p>These functions do not take any parameters. They are all
                   10352:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10353:        to check the exitcodes of any commands you run in the
                   10354:        test.</p>
                   10355: <div class="variablelist"><dl>
                   10356: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10357: <dd><p>This function prepares the environment for the
                   10358:        test. By default it does nothing.</p></dd>
                   10359: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10360: <dd><p>This function runs the actual test. By default,
                   10361:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10362:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10363:        error messages into the file
                   10364:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10365: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10366: <dd><p>This function is run after the test and is
                   10367:        typically used to compare the actual output from the one that is
                   10368:        expected. It can make use of the various helper functions from
                   10369:        the next section.</p></dd>
                   10370: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10371: <dd><p>This function cleans everything up after the
                   10372:        test has been run. By default it does nothing.</p></dd>
                   10373: </dl></div>
                   10374: </div>
                   10375: <div class="sect2" lang="en">
                   10376: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10377: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1       dsieger  10378: <div class="variablelist"><dl>
                   10379: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10380: <dd><p>This function compares the exitcode of the
                   10381:        <span><strong class="command">do_test()</strong></span> function with its first parameter.
                   10382:        If they differ, the test will fail.</p></dd>
                   10383: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10384: <dd><p>This function checks for each of its parameters
                   10385:        if the output from <span><strong class="command">do_test()</strong></span> matches the
                   10386:        extended regular expression. If it does not, the test will
                   10387:        fail.</p></dd>
                   10388: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10389: <dd><p>This function checks for each of its parameters
                   10390:        if the output from <span><strong class="command">do_test()</strong></span> does
                   10391:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10392:        If any of the regular expressions matches, the test will
                   10393:        fail.</p></dd>
                   10394: </dl></div>
                   10395: </div>
                   10396: </div>
                   10397: </div>
                   10398: <div class="chapter" lang="en">
                   10399: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10400: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10401: <div class="toc">
                   10402: <p><b>Table of Contents</b></p>
                   10403: <dl>
1.6       rillig   10404: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10405: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10406: </dl>
                   10407: </div>
                   10408: <p>The pkgsrc system has already been ported to many
                   10409:        operating systems, hardware architectures and compilers. This
                   10410:        chapter explains the necessary steps to make pkgsrc even more
                   10411:        portable.</p>
                   10412: <div class="sect1" lang="en">
                   10413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10414: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10415: <p>To port pkgsrc to a new operating system (called
                   10416:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10417:        following files:</p>
                   10418: <div class="variablelist"><dl>
                   10419: <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>
                   10420: <dd><p>This file contains some basic definitions, for
                   10421:        example the name of the C
                   10422:        compiler.</p></dd>
                   10423: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10424: <dd><p>Insert code that defines the variables
                   10425:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10426:        <code class="varname">LOWER_OS_VERSION</code>,
                   10427:        <code class="varname">LOWER_VENDOR</code>,
                   10428:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10429:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10430:        appear in this file.</p></dd>
                   10431: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10432: <dd><p>This file contains the platform-specific
                   10433:        definitions that are used by pkgsrc. Start by copying one of the
                   10434:        other files and edit it to your
                   10435:        needs.</p></dd>
                   10436: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10437: <dd><p>This file contains a list of directories,
                   10438:        together with their permission bits and ownership. These
                   10439:        directories will be created automatically with every package
                   10440:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10441:        be removed.</p></dd>
                   10442: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10443: <dd><p>Just copy one of the pre-existing x11.dist files
                   10444:        to your
                   10445:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10446: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10447: <dd><p>On some operating systems, the tools that are
                   10448:        provided with the base system are not good enough for pkgsrc.
                   10449:        For example, there are many versions of <a 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
                   10450:        narrow limit on the line length they can process. Therefore
                   10451:        pkgsrc brings its own tools, which can be enabled
                   10452:        here.</p></dd>
                   10453: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10454: <dd><p>This file defines the paths to all the tools
                   10455:        that are needed by one or the other package in pkgsrc, as well
                   10456:        as by pkgsrc itself. Find out where these tools are on your
                   10457:        platform and add them.</p></dd>
                   10458: </dl></div>
                   10459: <p>Now, you should be able to build some basic packages, like
                   10460:        <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>
                   10461: </div>
                   10462: <div class="sect1" lang="en">
                   10463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10464: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10465: <p>TODO</p>
                   10466: </div>
                   10467: </div>
                   10468: </div>
                   10469: <div class="appendix" lang="en">
                   10470: <div class="titlepage"><div><div><h2 class="title">
                   10471: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10472: <div class="toc">
                   10473: <p><b>Table of Contents</b></p>
                   10474: <dl>
                   10475: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10476: <dd><dl>
                   10477: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10478: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10479: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                   10480: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                   10481: </dl></dd>
                   10482: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10483: </dl>
                   10484: </div>
                   10485: <p>We checked to find a piece of software that wasn't in the packages
                   10486:     collection, and picked GNU bison. Quite why someone would want to have
                   10487:     <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
                   10488:     present in the tree is beyond us, but it's useful for the purposes of
                   10489:     this exercise.</p>
                   10490: <div class="sect1" lang="en">
                   10491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10492: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10493: <div class="sect2" lang="en">
                   10494: <div class="titlepage"><div><div><h3 class="title">
                   10495: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10496: <pre class="programlisting">
                   10497: # $NetBSD$
                   10498: #
                   10499: 
                   10500: DISTNAME=       bison-1.25
                   10501: CATEGORIES=     devel
                   10502: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10503: 
                   10504: MAINTAINER=     thorpej@NetBSD.org
                   10505: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10506: COMMENT=        GNU yacc clone
                   10507: 
                   10508: GNU_CONFIGURE=  yes
                   10509: INFO_FILES=     bison.info
                   10510: 
                   10511: .include "../../mk/bsd.pkg.mk"
                   10512: </pre>
                   10513: </div>
                   10514: <div class="sect2" lang="en">
                   10515: <div class="titlepage"><div><div><h3 class="title">
                   10516: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10517: <pre class="programlisting">
                   10518: GNU version of yacc.  Can make re-entrant parsers, and numerous other
                   10519: improvements.  Why you would want this when Berkeley <a 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
                   10520: of the NetBSD source tree is beyond me.
                   10521: </pre>
                   10522: </div>
                   10523: <div class="sect2" lang="en">
                   10524: <div class="titlepage"><div><div><h3 class="title">
                   10525: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10526: <pre class="programlisting">
                   10527: @comment $NetBSD$
                   10528: bin/bison
                   10529: man/man1/bison.1.gz
                   10530: share/bison.simple
                   10531: share/bison.hairy
                   10532: </pre>
                   10533: </div>
                   10534: <div class="sect2" lang="en">
                   10535: <div class="titlepage"><div><div><h3 class="title">
                   10536: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
                   10537: </h3></div></div></div>
                   10538: <p>The NetBSD package system comes with
                   10539:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10540:        which helps to check the contents of these
                   10541:        files. After installation it is quite easy to use, just change to the
                   10542:        directory of the package you wish to examine and execute
                   10543:        <span><strong class="command">pkglint</strong></span>:</p>
                   10544: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10545: looks fine.</pre>
                   10546: <p>Depending on the supplied command line arguments (see pkglint(1)),
                   10547:        more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
                   10548:        -Wall</strong></span> for a very thorough check.</p>
                   10549: </div>
                   10550: </div>
                   10551: <div class="sect1" lang="en">
                   10552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10553: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10554: <p>Create the directory where the package lives,
                   10555:       plus any auxiliary directories:</p>
                   10556: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10557: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10558: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10559: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10560: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.6       rillig   10561:       <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1       dsieger  10562:       then continue with fetching the distfile:</p>
                   10563: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10564: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10565: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10566: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10567: ftp: Error retrieving file: 500 Internal error
                   10568: 
                   10569: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10570: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10571: ftp: Error retrieving file: 500 Internal error
                   10572: 
                   10573: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10574: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10575: Successfully retrieved file.</pre>
                   10576: <p>Generate the checksum of the distfile into
                   10577:       <code class="filename">distinfo</code>:</p>
                   10578: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10579: <p>Now compile:</p>
                   10580: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10581: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10582: ===&gt;  Extracting for bison-1.25
                   10583: ===&gt;  Patching for bison-1.25
                   10584: ===&gt;   Ignoring empty patch directory
                   10585: ===&gt;  Configuring for bison-1.25
                   10586: creating cache ./config.cache
                   10587: checking for gcc... cc
                   10588: checking whether we are using GNU C... yes
                   10589: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10590: checking how to run the C preprocessor... cc -E
                   10591: checking for minix/config.h... no
                   10592: checking for POSIXized ISC... no
                   10593: checking whether cross-compiling... no
                   10594: checking for ANSI C header files... yes
                   10595: checking for string.h... yes
                   10596: checking for stdlib.h... yes
                   10597: checking for memory.h... yes
                   10598: checking for working const... yes
                   10599: checking for working alloca.h... no
                   10600: checking for alloca... yes
                   10601: checking for strerror... yes
                   10602: updating cache ./config.cache
                   10603: creating ./config.status
                   10604: creating Makefile
                   10605: ===&gt;  Building for bison-1.25
                   10606: 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
                   10607: 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
                   10608: 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
                   10609: 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
                   10610: 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
                   10611: 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
                   10612: 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
                   10613: 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
                   10614: 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
                   10615: 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
                   10616: 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
                   10617: 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
                   10618: 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
                   10619: 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
                   10620: 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
                   10621: 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
                   10622: 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
                   10623: 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
                   10624: 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
                   10625: 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
                   10626: 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
                   10627: 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
                   10628: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10629: rm -f bison.s1
                   10630: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10631: <p>Everything seems OK, so install the files:</p>
                   10632: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10633: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10634: ===&gt;  Installing for bison-1.25
                   10635: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10636: rm -f /usr/pkg/bin/bison
                   10637: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10638: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10639: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10640: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10641: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10642: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10643: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10644: ===&gt;  Registering installation for bison-1.25</pre>
                   10645: <p>You can now use bison, and also - if you decide so - remove it with
                   10646:       <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
                   10647:       binary package, do this now:</p>
                   10648: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10649: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10650: ===&gt;  Building package for bison-1.25
                   10651: Creating package bison-1.25.tgz
                   10652: Registering depends:.
                   10653: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10654: <p>Now that you don't need the source and object files
                   10655:       any more, clean up:</p>
                   10656: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10657: ===&gt;  Cleaning for bison-1.25</pre>
                   10658: </div>
                   10659: </div>
                   10660: <div class="appendix" lang="en">
                   10661: <div class="titlepage"><div><div><h2 class="title">
                   10662: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10663: <div class="toc">
                   10664: <p><b>Table of Contents</b></p>
                   10665: <dl>
                   10666: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10667: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10668: </dl>
                   10669: </div>
                   10670: <div class="sect1" lang="en">
                   10671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10672: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10673: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10674: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10675: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10676: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10677: =&gt; [172219 bytes]
                   10678: Connected to ftp.plig.net.
                   10679: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10680: 331 Guest login ok, send your complete e-mail address as password.
                   10681: 230-You are user #5 of 500 simultaneous users allowed.
                   10682: 230-
                   10683: 230-  ___ _             _ _
                   10684: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10685: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10686: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10687: 230-         |_|   |_|     |___|         |___|
                   10688: 230-
                   10689: 230-** Welcome to ftp.plig.org **
                   10690: 230-
                   10691: 230-Please note that all transfers from this FTP site are logged. If you
                   10692: 230-do not like this, please disconnect now.
                   10693: 230-
                   10694: 230-This arhive is available via
                   10695: 230-
                   10696: 230-HTTP:  http://ftp.plig.org/
                   10697: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10698: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10699: 230-
                   10700: 230-Please email comments, bug reports and requests for packages to be
                   10701: 230-mirrored to ftp-admin@plig.org.
                   10702: 230-
                   10703: 230-
                   10704: 230 Logged in anonymously.
                   10705: Remote system type is UNIX.
                   10706: Using binary mode to transfer files.
                   10707: 200 Type okay.
                   10708: 250 "/pub" is new cwd.
                   10709: 250-"/pub/figlet" is new cwd.
                   10710: 250-
                   10711: 250-Welcome to the figlet archive at ftp.figlet.org
                   10712: 250-
                   10713: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10714: 250-
                   10715: 250-The official FIGlet web page is:
                   10716: 250-   http://www.figlet.org/
                   10717: 250-
                   10718: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10719: 250-contribute a font or something else, you can email us.
                   10720: 250
                   10721: 250 "/pub/figlet/program" is new cwd.
                   10722: 250 "/pub/figlet/program/unix" is new cwd.
                   10723: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10724: 502 Unimplemented command.
                   10725: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10726: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10727: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10728: 226 Transfer completed.
                   10729: 172219 bytes received in 00:02 (75.99 KB/s)
                   10730: 221 Goodbye.
                   10731: =&gt; Checksum OK for figlet221.tar.gz.
                   10732: ===&gt; Extracting for figlet-2.2.1nb2
                   10733: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10734: ===&gt; Patching for figlet-2.2.1nb2
                   10735: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10736: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10737: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10738: ===&gt; Configuring for figlet-2.2.1nb2
                   10739: ===&gt; Building for figlet-2.2.1nb2
                   10740: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10741: chmod a+x figlet
                   10742: gcc -O2 -o chkfont chkfont.c
                   10743: =&gt; Unwrapping files-to-be-installed.
                   10744: <code class="prompt">#</code>
                   10745: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10746: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10747: ===&gt; Installing for figlet-2.2.1nb2
                   10748: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10749: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10750: mkdir -p /usr/pkg/share/figlet
                   10751: cp figlet /usr/pkg/bin
                   10752: cp chkfont /usr/pkg/bin
                   10753: chmod 555 figlist showfigfonts
                   10754: cp figlist /usr/pkg/bin
                   10755: cp showfigfonts /usr/pkg/bin
                   10756: cp fonts/*.flf /usr/pkg/share/figlet
                   10757: cp fonts/*.flc /usr/pkg/share/figlet
                   10758: cp figlet.6 /usr/pkg/man/man6
                   10759: ===&gt; Registering installation for figlet-2.2.1nb2
                   10760: <code class="prompt">#</code></pre>
                   10761: </div>
                   10762: <div class="sect1" lang="en">
                   10763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10764: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10765: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10766: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10767: ===&gt; Packaging figlet-2.2.1nb2
                   10768: ===&gt; Building binary package for figlet-2.2.1nb2
                   10769: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10770: Using SrcDir value of /usr/pkg
                   10771: Registering depends:.
                   10772: <code class="prompt">#</code></pre>
                   10773: </div>
                   10774: </div>
                   10775: <div class="appendix" lang="en">
                   10776: <div class="titlepage"><div><div><h2 class="title">
                   10777: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10778: <div class="toc">
                   10779: <p><b>Table of Contents</b></p>
                   10780: <dl>
                   10781: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10782: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10783: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10784: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3       rillig   10785: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.8       rillig   10786: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10787: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.1       dsieger  10788: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   10789: source packages</a></span></dt>
                   10790: </dl>
                   10791: </div>
                   10792: <p>As in other big projects, the directory layout of pkgsrc
                   10793:        is quite complex for newbies. This chapter explains where you
                   10794:        find things on the FTP server. The base directory on
                   10795:        <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
                   10796:        On other servers it may be different, but inside this directory,
                   10797:        everything should look the same, no matter on which server you
                   10798:        are. This directory contains some subdirectories, which are
                   10799:        explained below.</p>
                   10800: <div class="sect1" lang="en">
                   10801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10802: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.9     ! rillig   10803: <p>This directory used to contain binary packages of the
        !          10804:        package management tools for various platforms. For those
        !          10805:        package collections that need them, they are now stored near the
        !          10806:        binary packages, so you should look <a href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
        !          10807:        directory</a>.</p>
1.1       dsieger  10808: </div>
                   10809: <div class="sect1" lang="en">
                   10810: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10811: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10812: <p>The directory <code class="filename">distfiles</code> contains lots
                   10813:        of archive files from all pkgsrc packages, which are mirrored
                   10814:        here. The subdirectories are called after their package names
                   10815:        and are used when the distributed files have names that don't
                   10816:        explicitly contain a version number or are otherwise too generic
                   10817:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10818: </div>
                   10819: <div class="sect1" lang="en">
                   10820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10821: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10822: <p>This directory is currently not in use.</p>
                   10823: </div>
                   10824: <div class="sect1" lang="en">
                   10825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10826: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10827: <p>This directory contains things that individual pkgsrc
                   10828:        developers find worth publishing.</p>
                   10829: </div>
                   10830: <div class="sect1" lang="en">
                   10831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3       rillig   10832: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   10833: <p>This directory contains binary packages for the various
                   10834:        platforms that are supported by pkgsrc.
                   10835:        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>
                   10836: <div class="itemizedlist"><ul type="disc">
1.8       rillig   10837: <li><p><code class="varname">OPSYS</code> is the name of the
1.9     ! rillig   10838:        operating system for which the packages have been built. The
        !          10839:        name is taken from the output of the <span><strong class="command">uname</strong></span>
        !          10840:        command, so it may differ from the one you are used to
        !          10841:        hear.</p></li>
1.8       rillig   10842: <li><p><code class="varname">ARCH</code> is the hardware
                   10843:        architecture of the platform for which the packages have been
                   10844:        built.</p></li>
                   10845: <li><p><code class="varname">OSVERSION</code> is the version of
                   10846:        the operating system. For version numbers that change often (for
                   10847:        example NetBSD-current), the often-changing part should be
                   10848:        replaced with an <code class="literal">x</code>, for example
                   10849:        <code class="literal">4.99.x</code>.</p></li>
                   10850: <li><p><code class="varname">TAG</code> is either
                   10851:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10852:        for a stable branch, or <code class="literal">head</code> for packages
                   10853:        built from the HEAD branch. The latter should only be used when
                   10854:        the packages are updated on a regular basis. Otherwise the date
                   10855:        from checking out pkgsrc should be appended, for example
                   10856:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10857: </ul></div>
                   10858: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10859:        can quickly click through the directories on the
                   10860:        server and find the best binary packages for their machines. Since they
                   10861:        usually know the operating system and the hardware architecture, OPSYS
                   10862:        and ARCH are placed first. After these choices, they can select the
                   10863:        best combination of OSVERSION and TAG together, since it is usually the
                   10864:        case that packages stay compatible between different version of the
                   10865:        operating system.</p>
                   10866: <p>In each of these directories, there is a
                   10867:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  10868:        <code class="filename">All</code> which contains all binary packages.
                   10869:        Besides that, there are various category directories that
                   10870:        contain symbolic links to the real binary packages.</p>
                   10871: </div>
                   10872: <div class="sect1" lang="en">
                   10873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.8       rillig   10874: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   10875: <p>Here are the reports from bulk builds, for those who want
                   10876:        to fix packages that didn't build on some of the platforms. The
                   10877:        structure of subdirectories should look like the one in <a href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
                   10878: </div>
                   10879: <div class="sect1" lang="en">
                   10880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10881: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.1       dsieger  10882: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   10883: source packages</h2></div></div></div>
                   10884: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10885:        that is the files that define how to create binary packages from
                   10886:        source archives.</p>
                   10887: <p>The directory <code class="filename">pkgsrc</code> contains a
                   10888:        snapshot of the CVS repository, which is updated regularly. The
                   10889:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10890:        directory, ready to be downloaded as a whole.</p>
                   10891: <p>In the directories for the quarterly branches, there is an
                   10892:        additional file called
                   10893:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10894:        which contains the state of pkgsrc when it was branched.</p>
                   10895: </div>
                   10896: </div>
                   10897: <div class="appendix" lang="en">
                   10898: <div class="titlepage"><div><div><h2 class="title">
                   10899: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</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="#targets">D.1. Make targets</a></span></dt>
                   10904: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10905: </dl>
                   10906: </div>
                   10907: <p>This section contains information on editing the pkgsrc
                   10908:        guide itself.</p>
                   10909: <div class="sect1" lang="en">
                   10910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10911: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10912: <p>The pkgsrc guide's source code is stored in
                   10913:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10914:        are created from it:</p>
                   10915: <div class="itemizedlist"><ul type="disc">
                   10916: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10917: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.2       rillig   10918: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   10919: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1       dsieger  10920:        The PDF version of the pkgsrc guide.</p></li>
1.2       rillig   10921: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1       dsieger  10922:        PostScript version of the pkgsrc guide.</p></li>
                   10923: </ul></div>
                   10924: </div>
                   10925: <div class="sect1" lang="en">
                   10926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10927: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   10928: <p>The procedure to edit the pkgsrc guide is:</p>
                   10929: <div class="procedure"><ol type="1">
                   10930: <li><p>Make sure you have the packages needed to
                   10931:        regenerate the pkgsrc guide (and other XML-based NetBSD
                   10932:        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
                   10933:        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
                   10934:        PostScript and PDF versions. You will need both packages
                   10935:        installed, to make sure documentation is consistent across all
                   10936:        formats.</p></li>
                   10937: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
                   10938:        right directory. All further steps will take place
                   10939:        here.</p></li>
                   10940: <li><p>Edit the XML file(s) in
                   10941:        <code class="filename">files/</code>.</p></li>
                   10942: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
                   10943:        guide for valid XML and to build the final output files. If you
                   10944:        get any errors at this stage, you can just edit the files, as
                   10945:        there are only symbolic links in the working directory, pointing
                   10946:        to the files in <code class="filename">files/</code>.</p></li>
                   10947: <li><p><span><strong class="command">(cd files &amp;&amp; cvs
                   10948:        commit)</strong></span></p></li>
                   10949: <li><p>Run <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span> to
                   10950:        regenerate the output files with the proper RCS
                   10951:        Ids.</p></li>
                   10952: <li>
                   10953: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
                   10954:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10955:        <code class="filename">htdocs</code>.</p>
                   10956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10957: <h3 class="title">Note</h3>
                   10958: <p>If you have added, removed or renamed some chapters,
                   10959:        you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
                   10960:        <span><strong class="command">cvs delete</strong></span> in the htdocs
                   10961:        directory.</p>
                   10962: </div>
                   10963: </li>
                   10964: </ol></div>
                   10965: </div>
                   10966: </div>
                   10967: </div></body>
                   10968: </html>

CVSweb <webmaster@jp.NetBSD.org>