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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.101     rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.104     rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106     rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       118: <dd><dl>
1.103     wiz       119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
                    120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       122: </dl></dd>
1.103     wiz       123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.75      rillig    133: <dd><dl>
1.106     rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
                    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>
1.110     hubertf   166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig    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.75      rillig    169: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.106     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.75      rillig    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.106     rillig    181: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    182: <dd><dl>
1.106     rillig    183: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    184: <dd><dl>
1.106     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.91      rillig    187: </dl></dd>
1.106     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>
1.110     hubertf   231: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig    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.107     rillig    279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     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.107     rillig    364: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     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.87      wiz       374:     emulation</a></span></dt>
1.106     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.77      rillig    377: </dl></dd>
1.106     rillig    378: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    379: </dl></dd>
1.106     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.77      rillig    382: <dd><dl>
1.106     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.85      jmmv      397: </dl></dd>
1.75      rillig    398: </dl></dd>
                    399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    400: <dd><dl>
1.106     rillig    401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    402: <dd><dl>
1.106     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.81      rillig    406: <dd><dl>
1.106     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.81      rillig    409: </dl></dd>
1.106     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.75      rillig    412: <dd><dl>
1.106     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.75      rillig    415: </dl></dd>
1.106     rillig    416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    417: <dd><dl>
1.106     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.75      rillig    420: </dl></dd>
                    421: </dl></dd>
1.106     rillig    422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    423: <dd><dl>
1.106     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.75      rillig    427: <dd><dl>
1.106     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.75      rillig    430: </dl></dd>
                    431: </dl></dd>
1.106     rillig    432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    433: <dd><dl>
1.106     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.75      rillig    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>
1.110     hubertf   445: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig    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>
1.76      rillig    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.102     rillig    460: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.108     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.93      rillig    463: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    464: source packages</a></span></dt>
                    465: </dl></dd>
1.75      rillig    466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    467: <dd><dl>
1.79      rillig    468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    470: </dl></dd>
                    471: </dl>
                    472: </div>
1.82      rillig    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.106     rillig    478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      479: </dt>
1.106     rillig    480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      481: </dt>
1.82      rillig    482: </dl>
                    483: </div>
1.75      rillig    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>
1.82      rillig    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>
1.75      rillig    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>
1.88      wiz       497: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    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>
1.82      rillig    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>
1.75      rillig    511: <p>pkgsrc currently contains several thousand packages,
                    512:       including:</p>
                    513: <div class="itemizedlist"><ul type="disc">
1.91      rillig    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
1.75      rillig    515:          web server</p></li>
1.91      rillig    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
1.75      rillig    517:          web browser</p></li>
1.91      rillig    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
1.75      rillig    519:          Desktop Environment</p></li>
1.91      rillig    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
1.75      rillig    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>
1.82      rillig    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>
1.91      rillig    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.112     weinem    565: &#8212; That means, if a package contains bugs, it's better to find
1.91      rillig    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.112     weinem    572: &#8212; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    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>
1.82      rillig    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>
1.75      rillig    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>
1.82      rillig    587: <div class="table">
                    588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    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>
1.110     hubertf   600: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    601: <td align="center">Aug 1997</td>
                    602: </tr>
                    603: <tr>
1.110     hubertf   604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    605: <td align="center">Mar 1999</td>
                    606: </tr>
                    607: <tr>
1.110     hubertf   608: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    609: <td align="center">Jun 1999</td>
                    610: </tr>
                    611: <tr>
                    612: <td>
1.110     hubertf   613:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    614:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    615:         </td>
                    616: <td align="center">Oct 2001</td>
                    617: </tr>
                    618: <tr>
1.110     hubertf   619: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    620: <td align="center">Nov 2002</td>
                    621: </tr>
                    622: <tr>
1.110     hubertf   623: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    624: <td align="center">Nov 2002</td>
                    625: </tr>
                    626: <tr>
1.110     hubertf   627: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    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>
1.110     hubertf   635: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    636: <td align="center">Dec 2003</td>
                    637: </tr>
                    638: <tr>
                    639: <td>
1.110     hubertf   640:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    641:           (Microsoft Windows Services for Unix)
                    642:         </td>
                    643: <td align="center">Mar 2004</td>
                    644: </tr>
                    645: <tr>
1.110     hubertf   646: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    647: <td align="center">Oct 2004</td>
                    648: </tr>
                    649: <tr>
1.110     hubertf   650: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    651: <td align="center">Nov 2004</td>
                    652: </tr>
1.98      wiz       653: <tr>
1.110     hubertf   654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       655: <td align="center">Apr 2007</td>
                    656: </tr>
1.82      rillig    657: </tbody>
1.91      rillig    658: </table></div>
1.82      rillig    659: </div>
1.91      rillig    660: <br class="table-break">
1.82      rillig    661: </div>
1.75      rillig    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,
1.110     hubertf   667:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    668:        describes how one can use one of the packages in the Package
                    669:        Collection, either by installing a precompiled binary package,
1.93      rillig    670:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   671:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    672:        package so it can be easily built by other NetBSD users without
                    673:        knowing about the package's building details. The third part,
1.110     hubertf   674:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    675:        is intended for those who want to understand how pkgsrc is
                    676:        implemented.</p>
                    677: <p>This document is available in various formats:
1.110     hubertf   678:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    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
1.76      rillig    692:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    693: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       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>
1.75      rillig    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
1.76      rillig    707:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    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
1.76      rillig    716:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    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
1.76      rillig    720:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110     hubertf   721:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75      rillig    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>
1.88      wiz       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>
1.75      rillig    729: </dl></div>
                    730: <div class="sect2" lang="en">
                    731: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       732: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    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
1.110     hubertf   744:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    745:        documentation.</p>
                    746: </dd>
                    747: <dt><span class="term">package maintainers</span></dt>
                    748: <dd><p>A
1.110     hubertf   749:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    750: <dt><span class="term">infrastructure developers</span></dt>
                    751: <dd><p>These people are involved in all those files
1.76      rillig    752:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   753:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    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>
1.97      rillig    780: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    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>
1.82      rillig    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>
1.75      rillig    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>
1.82      rillig    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>
1.75      rillig    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.109     rillig    827: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       828: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       829: <dd><dl>
1.103     wiz       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.88      wiz       833: </dl></dd>
1.103     wiz       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.75      rillig    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.106     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.75      rillig    844: <dd><dl>
1.106     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>
1.110     hubertf   877: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig    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.75      rillig    880: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.106     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.75      rillig    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>
1.97      rillig    901: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    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>
1.91      rillig    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>
1.75      rillig    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
1.112     weinem    927:        <code class="literal">2007Q4</code>.</p>
1.75      rillig    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
1.110     hubertf   935:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75      rillig    936:        number of subdirectories for different purposes, which are
1.110     hubertf   937:        described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75      rillig    938: <p>The tar file for the current branch is in the directory
1.110     hubertf   939:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    940:        It is autogenerated daily.</p>
1.112     weinem    941: <p>The tar file for the stable branch 2007Q4 is in the
                    942:        directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
                    943: <p>To download a pkgsrc stable tarball, run:</p>
                    944: <pre class="screen">
                    945: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
                    946: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    947:        stable branch to be downloaded, for example, 
                    948:        &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;.</p>
                    949: <p>Then, extract it with:</p>
                    950: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
                    951: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    952:        in <code class="filename">/usr/</code> and all the package source will be 
                    953:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    954: <p>To download pkgsrc-current, run:</p>
                    955: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig    956: </div>
                    957: <div class="sect2" lang="en">
                    958: <div class="titlepage"><div><div><h3 class="title">
                    959: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    960: <p>As an alternative to the tar file, you can get pkgsrc via
                    961:        the Software Update Protocol, SUP. To do so, make sure your
                    962:        supfile has a line
1.1       grant     963: 
1.75      rillig    964: </p>
                    965: <pre class="programlisting">
1.100     rillig    966: release=pkgsrc
1.1       grant     967: </pre>
1.75      rillig    968: <p>
1.1       grant     969: 
1.75      rillig    970:        in it, see the examples in
1.76      rillig    971:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    972:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113   ! weinem    973:        run:</p>
        !           974: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.75      rillig    975: </div>
                    976: <div class="sect2" lang="en">
                    977: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    978: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112     weinem    979: <p>To do an initial (full) checkout of pkgsrc, you first
1.75      rillig    980:        have to set some environment variables. For the C-Shell,
                    981:        type:</p>
1.113   ! weinem    982: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
        !           983: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75      rillig    984: </pre>
                    985: <p>Or, the same for the bourne shell:</p>
1.113   ! weinem    986: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
        !           987: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75      rillig    988: </pre>
1.113   ! weinem    989: <p>By default, CVS doesn't do things like most people would
1.112     weinem    990:        expect it to do. But there is a
1.113   ! weinem    991:        way to convince CVS, by creating a file called
1.101     rillig    992:        <code class="filename">.cvsrc</code> in your home directory and saving
                    993:        the following lines to it. This file will save you lots of
                    994:        headache and some bug reports, so we strongly recommend it. You
                    995:        can find an explanation of this file in the CVS
                    996:        documentation.</p>
                    997: <pre class="programlisting">
                    998: # recommended CVS configuration file from the pkgsrc guide
                    999: checkout -P
1.103     wiz      1000: update -dP
1.101     rillig   1001: release -d
1.103     wiz      1002: diff -upN
1.101     rillig   1003: cvs -q -z3
                   1004: rdiff -u
                   1005: </pre>
1.112     weinem   1006: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1007: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113   ! weinem   1008: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.112     weinem   1009: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
                   1010:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;</p>
                   1011: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1012:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1013:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1014: <p>To fetch the pkgsrc current branch, run:</p>
                   1015: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113   ! weinem   1016: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75      rillig   1017: </div>
                   1018: </div>
                   1019: <div class="sect1" lang="en">
                   1020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1021: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1022: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1023:        (which also works if you have first installed it via a tar
                   1024:        file). It saves bandwidth and hard disk activity, compared to
                   1025:        downloading the tar file again.</p>
                   1026: <div class="sect2" lang="en">
                   1027: <div class="titlepage"><div><div><h3 class="title">
                   1028: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1029: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1030: <h3 class="title">Warning</h3>
1.77      rillig   1031: <p>When updating from a tar file, you first need to
                   1032:        completely remove the old pkgsrc directory. Otherwise those
                   1033:        files that have been removed from pkgsrc in the mean time will
                   1034:        not be removed on your local disk, resulting in inconsistencies.
                   1035:        When removing the old files, any changes that you have done to
                   1036:        the pkgsrc files will be lost after updating. Therefore updating
                   1037:        via CVS is strongly recommended.</p>
1.75      rillig   1038: </div>
1.82      rillig   1039: <p>Note that by default the distfiles and the binary packages
                   1040:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1041:        before updating. You can also configure pkgsrc to use other than
                   1042:        the default directories by setting the
                   1043:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1044:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1045: <p>To update pkgsrc from a tar file, download the tar file as
                   1046:        explained above. Then, make sure that you have not made any
                   1047:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1048:        directory and extract the new tar file. Done.</p>
                   1049: </div>
                   1050: <div class="sect2" lang="en">
                   1051: <div class="titlepage"><div><div><h3 class="title">
                   1052: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1053: <p>To update pkgsrc via CVS, make sure the environment
                   1054:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113   ! weinem   1055:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
        !          1056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
        !          1057: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75      rillig   1058: <div class="sect3" lang="en">
                   1059: <div class="titlepage"><div><div><h4 class="title">
                   1060: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1061: <p>When updating pkgsrc, the CVS program keeps track of the
                   1062:        branch you selected. But if you, for whatever reason, want to
                   1063:        switch from the stable branch to the current one, you can do it
                   1064:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1065:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1066:        back to the stable branch, add the
1.113   ! weinem   1067:        &#8220;<span class="quote">-rpkgsrc-2007Q4</span>&#8221; option.</p>
1.75      rillig   1068: </div>
                   1069: <div class="sect3" lang="en">
                   1070: <div class="titlepage"><div><div><h4 class="title">
                   1071: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1072: <p>When you update pkgsrc, the CVS program will only touch
                   1073:        those files that are registered in the CVS repository. That
                   1074:        means that any packages that you created on your own will stay
                   1075:        unmodified. If you change files that are managed by CVS, later
                   1076:        updates will try to merge your changes with those that have been
                   1077:        done by others. See the CVS manual, chapter
                   1078:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1079: </div>
                   1080: </div>
                   1081: </div>
                   1082: </div>
                   1083: <div class="chapter" lang="en">
                   1084: <div class="titlepage"><div><div><h2 class="title">
                   1085: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1086: <div class="toc">
                   1087: <p><b>Table of Contents</b></p>
                   1088: <dl>
1.82      rillig   1089: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1090: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1091: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1092: <dd><dl>
                   1093: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1094: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1095: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1096: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1097: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1098: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1099: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1100: </dl></dd>
                   1101: </dl>
                   1102: </div>
                   1103: <div class="sect1" lang="en">
                   1104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1105: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1106: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1107: </div>
                   1108: <div class="sect1" lang="en">
                   1109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1110: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1111: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1112: <pre class="screen">
                   1113: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1114: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1115: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1116:     </pre>
1.110     hubertf  1117: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87      wiz      1118:     pkgsrc before bootstrapping. The given
1.110     hubertf  1119:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87      wiz      1120:     <code class="filename">/usr/pkg</code> for the
                   1121:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1122:     and <code class="filename">/var/db/pkg</code> for the package database
                   1123:     directory where pkgsrc will do its internal bookkeeping.
                   1124:     However, these can also be set using command-line
                   1125:     arguments.</p>
1.75      rillig   1126: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1127: <h3 class="title">Note</h3>
1.110     hubertf  1128: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1129:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1130:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87      wiz      1131:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1132: </div>
                   1133: </div>
                   1134: <div class="sect1" lang="en">
                   1135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1136: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1137: <p>Here are some platform-specific notes you should be aware of.</p>
                   1138: <div class="sect2" lang="en">
                   1139: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1140: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1141: <p>Darwin 5.x and up are supported. There are two methods of using
1.110     hubertf  1142:        pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1143:          image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1144:          partition</a>.</p>
                   1145: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110     hubertf  1146:       Tools from Apple's Developer Connection.  See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87      wiz      1147:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110     hubertf  1148:       from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87      wiz      1149:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1150: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1151:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1152:       the disk image. It'll be somewhat faster and will mount automatically
                   1153:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1154: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1155: <h3 class="title">Note</h3>
1.85      jmmv     1156: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1157:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75      rillig   1158: </div>
                   1159: <div class="sect3" lang="en">
                   1160: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1161: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1162: <p>Create the disk image:</p>
                   1163: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1164: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1165: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1166: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1167: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1168: <h3 class="title">Note</h3>
1.109     rillig   1169: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journaling.</p>
1.85      jmmv     1170: </div>
1.89      rillig   1171: <p>Allow suid:</p>
                   1172: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105     weinem   1173: <p>Changing the build directory:</p>
                   1174: <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>
                   1175: <pre class="programlisting">
                   1176:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1177:        </pre>
1.75      rillig   1178: </div>
                   1179: <div class="sect3" lang="en">
                   1180: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1181: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1182: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1183:        system, normally HFS+. It is possible to use the default
                   1184:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1185:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1186:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1187:        place the package database directory outside the
                   1188:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1189: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1190: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1191:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1192:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1193:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1194:        to ensure that the partition map correctly reflects
1.89      rillig   1195:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
1.75      rillig   1196: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1197:        disk that is booted from. You can unmount the partition, but even if
                   1198:        you newfs it, the partition type will be incorrect and the
                   1199:        automounter won't mount it. It can be mounted manually, but it won't
                   1200:        appear in Finder.</p>
1.75      rillig   1201: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1202:        the Installation program starts, go up to the menu and select Disk
                   1203:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1204:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1205:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1206:        will appear in Finder.</p>
1.75      rillig   1207: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1208:        by root only.</p>
1.75      rillig   1209: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1210:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1211: </div>
                   1212: </div>
                   1213: <div class="sect2" lang="en">
                   1214: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1215: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1216: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1217:       other versions may work.</p>
1.75      rillig   1218: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1219:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1220: <div class="orderedlist"><ol type="1">
                   1221: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1222:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1223:          recommended that you choose a different location (e.g.
                   1224:          <code class="filename">/usr/pkgdb</code>) by
                   1225:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1226: <li>
                   1227: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1228:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1229: <pre class="screen">
                   1230: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1231: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1232: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1233: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1234: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1235:          </pre>
1.75      rillig   1236: </li>
1.110     hubertf  1237: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1238:          <code class="filename">/etc/mk.conf.example</code> file
                   1239:          when you use the bootstrap script.</p></li>
1.75      rillig   1240: </ol></div>
                   1241: </div>
                   1242: <div class="sect2" lang="en">
                   1243: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1244: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1245: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1246:       providing a Unix-like environment with a tighter kernel integration than
                   1247:       available with Cygwin.  It is part of the Windows Services for Unix
                   1248:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1249:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1250: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1251:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1252:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1253: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1254:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1255:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1256: <div class="sect3" lang="en">
                   1257: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1258: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1259: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1260:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1261: <div class="itemizedlist"><ul type="disc">
                   1262: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1263: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1264: <li><p>Remote Connectivity</p></li>
                   1265: <li><p>Interix SDK</p></li>
                   1266: </ul></div>
                   1267: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1268:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1269:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1270:        pkgsrc (or from a binary package).</p>
1.75      rillig   1271: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1272:        not need to be installed, but Remote Connectivity itself should be
                   1273:        installed in order to have a working inetd.</p>
1.75      rillig   1274: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1275:        behavior for Interix programs, and whether to make pathnames default to
                   1276:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1277:        enabled.  (Without case-sensitivity, a large number of packages including
                   1278:        perl will not build.)</p>
1.75      rillig   1279: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1280:        works (via the Data Execution Prevention feature).  In order to use
                   1281:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1282:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1283:        must be installed.  Hotfixes are available from Microsoft through a
                   1284:        support contract; however, a NetBSD developer has made most Interix
1.110     hubertf  1285:        hotfixes available for personal use from <a class="ulink" href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93      rillig   1286: <p>In addition to the hotfix noted above, it may be necessary to
                   1287:        disable Data Execution Prevention entirely to make Interix functional.
                   1288:        This may happen only with certain types of CPUs; the cause is not fully
                   1289:        understood at this time.  If gcc or other applications still segfault
                   1290:        repeatedly after installing one of the hotfixes note above, the
                   1291:        following option can be added to the appropriate "boot.ini" line on the
                   1292:        Windows boot drive:  /NoExecute=AlwaysOff
                   1293:        (WARNING, this will disable DEP completely, which may be a security
                   1294:        risk if applications are often run as a user in the Administrators
                   1295:        group!)</p>
1.75      rillig   1296: </div>
                   1297: <div class="sect3" lang="en">
                   1298: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1299: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1300: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1301:        with pkgsrc, note the following things.</p>
1.75      rillig   1302: <div class="itemizedlist"><ul type="disc">
                   1303: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1304:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1305:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1306: <li>
                   1307: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1308:            change the following registry key:</p>
1.75      rillig   1309: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1310: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1311: </li>
                   1312: <li>
                   1313: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1314:            following registry key:</p>
1.75      rillig   1315: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1316: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1317: </li>
                   1318: </ul></div>
                   1319: </div>
                   1320: <div class="sect3" lang="en">
                   1321: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1322: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1323: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1324:        running "pkg_add") must be a member of the local Administrators
                   1325:        group.  Such a user must also be used to run the bootstrap.  This is
                   1326:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1327: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1328:        automatically complain if this is not the case.  This ensures that
                   1329:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1330: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1331:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1332:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1333:        the same time as the pkgsrc packages, ensure that you use the proper
                   1334:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1335: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1336:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1337:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1338:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1339: <pre class="programlisting">
1.100     rillig   1340: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1341:        </pre>
1.75      rillig   1342: </div>
                   1343: <div class="sect3" lang="en">
                   1344: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1345: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1346: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1347:        for a full Unix-like platform, it has some drawbacks that should
                   1348:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1349: <div class="itemizedlist"><ul type="disc">
                   1350: <li>
                   1351: <p><span class="strong"><strong>X11:</strong></span></p>
                   1352: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1353:          and can run X11 based applications, but it does
                   1354:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1355:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1356:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1357:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1358:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1359:          and the free X11 server included with
1.110     hubertf  1360:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1361: </li>
                   1362: <li>
                   1363: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1364: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1365:          Win32 applications, it does not currently support various X11
                   1366:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1367:          Most interactive applications to a local X server will run
                   1368:          reasonably fast, but full motion video and other graphics
                   1369:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1370: </li>
                   1371: <li>
                   1372: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1373: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1374:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1375:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1376:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110     hubertf  1377:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1378:          server component.  To output audio via an Interix host, the
1.91      rillig   1379:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1380:          must also be installed.</p>
1.75      rillig   1381: </li>
                   1382: <li>
                   1383: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1384: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1385:          is not currently possible to access CD/DVD drives, USB devices,
                   1386:          or SCSI devices through non-filesystem means.  Among other things,
                   1387:          this makes it impossible to use Interix directly for CD/DVD
                   1388:          burning.</p>
1.75      rillig   1389: </li>
                   1390: <li>
                   1391: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1392: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1393:          drives are also not directly accessible in Interix.  However,
                   1394:          support is in work to make tape drive access possible by using
                   1395:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1396:          esound server).</p>
1.75      rillig   1397: </li>
                   1398: </ul></div>
                   1399: </div>
                   1400: <div class="sect3" lang="en">
                   1401: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1402: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1403: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1404:        Windows system; any member of the local Administrators group will
                   1405:        suffice.  However, some packages currently assume that the user
                   1406:        named "root" is the privileged user.  To accommodate these, you
                   1407:        may create such a user; make sure it is in the local group
                   1408:        Administrators (or your language equivalent).</p>
1.110     hubertf  1409: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1410:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1411:        time being, install packages as the local Administrator (or
                   1412:        your language equivalent), or run the following command after
                   1413:        installing a package to work around the issue:</p>
1.75      rillig   1414: <pre class="screen">
1.87      wiz      1415: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1416:        </pre>
1.75      rillig   1417: </div>
                   1418: </div>
                   1419: <div class="sect2" lang="en">
                   1420: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1421: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1422: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1423:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1424:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1425:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1426: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110     hubertf  1427:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1428:       etc.</p>
1.86      schwarz  1429: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1430:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1431:        you start out using "abi=n32", that's what all your packages will be built
                   1432:        with.</p>
                   1433: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1434:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1435:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1436:       try to link n32 object files with lib64 or vice versa.  Check your
                   1437:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1438: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1439:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1440:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1441:       link over a network-mounted file system.</p>
1.75      rillig   1442: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1443:       as imake(1), but you may want to set some options depending on your local
                   1444:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1445:       course, your compiler's man pages for details.</p>
1.75      rillig   1446: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1447: 
1.87      wiz      1448:       </p>
1.75      rillig   1449: <pre class="programlisting">
1.100     rillig   1450: PKGSRC_COMPILER=        mipspro
1.87      wiz      1451:       </pre>
1.75      rillig   1452: <p>
1.1       grant    1453: 
1.110     hubertf  1454:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1455:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1456:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1457:       default.</p>
1.75      rillig   1458: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1459:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1460:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1461:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1462:       '--preserve-path' flag.</p>
1.75      rillig   1463: </div>
                   1464: <div class="sect2" lang="en">
                   1465: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1466: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1467: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1468:       either libtermcap or libcurses (libncurses).  Installing the
                   1469:       distributions libncurses-dev package (or equivalent) should fix
                   1470:       the problem.</p>
                   1471: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1472:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1473:       i386 have been tested.</p>
1.75      rillig   1474: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1475:       directory:</p>
1.75      rillig   1476: <pre class="programlisting">
1.100     rillig   1477: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1478: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1479:       </pre>
1.75      rillig   1480: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1481: <h3 class="title">Note</h3>
                   1482: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1483: </div>
                   1484: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1485:       function, which icc does not support. #undef'ing __attribute__ has the
                   1486:       unfortunate side-effect of breaking many of the Linux header files, which
                   1487:       cannot be compiled properly without __attribute__. The test must be
                   1488:       overridden so that __attribute__ is assumed supported by the
                   1489:       compiler.</p>
1.75      rillig   1490: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110     hubertf  1491:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1492: <pre class="programlisting">
1.100     rillig   1493: PKGSRC_COMPILER=        icc
1.87      wiz      1494:       </pre>
1.75      rillig   1495: <p>The default installation directory for icc is
1.87      wiz      1496:       <code class="filename">/opt/intel_cc_80</code>, which
                   1497:       is also the pkgsrc default. If you have installed it into a different
                   1498:       directory, set <code class="varname">ICCBASE</code> in
1.110     hubertf  1499:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1500: <pre class="programlisting">
1.100     rillig   1501: ICCBASE=                /opt/icc
1.87      wiz      1502:       </pre>
1.75      rillig   1503: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1504:       provided by icc, so binaries can be run on other systems which do not
                   1505:       have the shared libraries installed.</p>
                   1506: <p>Libtool, however, extracts a list of libraries from the
1.110     hubertf  1507:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1508:       records it, throwing away the -Bstatic and -Bdynamic options
                   1509:       interspersed between the libraries.  This means that
                   1510:       libtool-linked C++ shared libraries will have a runtime
                   1511:       dependency on the icc libraries until this is fixed in
                   1512:       libtool.</p>
1.75      rillig   1513: </div>
                   1514: <div class="sect2" lang="en">
                   1515: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1516: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1517: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1518: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1519:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1520: <div class="orderedlist"><ol type="1">
                   1521: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1522:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1523:          recommended that you choose a different location (e.g.
                   1524:          <code class="filename">/usr/pkgdb</code>) by
                   1525:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1526: <li>
                   1527: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1528:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1529: <pre class="screen">
                   1530: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1531: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1532: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1533: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1534: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1535:          </pre>
1.75      rillig   1536: </li>
                   1537: <li>
1.110     hubertf  1538: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1539:          <code class="filename">/etc/mk.conf.example</code> file
                   1540:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1541:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1542:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1543:          of the file with:</p>
                   1544: <pre class="programlisting">
1.100     rillig   1545: .ifdef BSD_PKG_MK
                   1546: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1547: .else
                   1548: # OpenBSD stuff
                   1549: .endif
1.87      wiz      1550:          </pre>
1.75      rillig   1551: </li>
                   1552: </ol></div>
                   1553: </div>
                   1554: <div class="sect2" lang="en">
                   1555: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1556: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1557: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1558:       You will need a working C compiler. Both gcc 2.95.3 and
                   1559:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1560: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1561:       process and to build packages.</p>
1.75      rillig   1562: <div class="itemizedlist"><ul type="disc">
                   1563: <li><p>SUNWsprot</p></li>
                   1564: <li><p>SUNWarc</p></li>
                   1565: <li><p>SUNWbtool</p></li>
                   1566: <li><p>SUNWtoo</p></li>
                   1567: <li><p>SUNWlibm</p></li>
                   1568: </ul></div>
1.78      rillig   1569: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1570:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1571: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1572:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1573:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1574:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1575: <div class="sect3" lang="en">
                   1576: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1577: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1578: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1579:        for building all packages.</p>
1.75      rillig   1580: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1581:        then either build gcc from
1.91      rillig   1582:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87      wiz      1583:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1584: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1585: </div>
                   1586: <div class="sect3" lang="en">
                   1587: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1588: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1589: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1590:        5.0)</p>
1.75      rillig   1591: <div class="itemizedlist"><ul type="disc">
                   1592: <li><p>SPROcc
1.87      wiz      1593:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1594: <li><p>SPROcpl
1.87      wiz      1595:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1596: <li><p>SPROild
1.87      wiz      1597:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1598: <li><p>SPROlang
1.87      wiz      1599:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1600: </ul></div>
1.96      rillig   1601: <p>You should set the following variables in your
1.110     hubertf  1602:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1603: <pre class="programlisting">
1.100     rillig   1604: CC=     cc
                   1605: CXX=    CC
                   1606: CPP=    cc -E
                   1607: CXXCPP= CC -E
1.96      rillig   1608: </pre>
                   1609: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1610: <h3 class="title">Note</h3>
                   1611: <p>The <code class="varname">CPP</code> setting might break some
                   1612:        packages that use the C preprocessor for processing things other
                   1613:        than C source code.</p>
                   1614: </div>
1.75      rillig   1615: </div>
                   1616: <div class="sect3" lang="en">
                   1617: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1618: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1619: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1620:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1621: <pre class="programlisting">
1.100     rillig   1622: PKGSRC_COMPILER=        sunpro
                   1623: ABI=                    64
1.96      rillig   1624: </pre>
                   1625: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1626: <h3 class="title">Note</h3>
                   1627: <p>This setting has been tested for the SPARC
                   1628:        architecture. Intel and AMD machines need some more
                   1629:        work.</p>
                   1630: </div>
1.75      rillig   1631: </div>
                   1632: <div class="sect3" lang="en">
                   1633: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1634: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110     hubertf  1635: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1636:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1637:       The workaround is to use another shell for the configure
1.91      rillig   1638:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110     hubertf  1639:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1640: <pre class="programlisting">
1.100     rillig   1641: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1642: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1643:       </pre>
1.91      rillig   1644: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1645: </div>
                   1646: </div>
                   1647: </div>
                   1648: </div>
                   1649: <div class="chapter" lang="en">
                   1650: <div class="titlepage"><div><div><h2 class="title">
                   1651: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1652: <div class="toc">
                   1653: <p><b>Table of Contents</b></p>
                   1654: <dl>
                   1655: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1656: <dd><dl>
                   1657: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1658: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1659: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1660: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1661: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1662: <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>
                   1663: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1664: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1665: </dl></dd>
                   1666: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1667: <dd><dl>
                   1668: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1669: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1670: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1671: </dl></dd>
                   1672: </dl>
                   1673: </div>
                   1674: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1675: is to only install the package tools and to use binary packages
                   1676: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1677: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1678: of pkgsrc, too. Then you are able to build your own packages,
                   1679: and you can still use binary packages from someone else.</p>
1.75      rillig   1680: <div class="sect1" lang="en">
                   1681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1682: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1683: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1684:   server and its mirrors, there are collections of binary packages,
                   1685:   ready to be installed. These binary packages have been built using the
                   1686:   default settings for the directories, that is:</p>
                   1687: <div class="itemizedlist"><ul type="disc">
                   1688: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1689: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1690: <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>
                   1691: </ul></div>
                   1692: <p>If you cannot use these directories for whatever reasons (maybe
                   1693:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1694:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.75      rillig   1695: <div class="sect2" lang="en">
                   1696: <div class="titlepage"><div><div><h3 class="title">
                   1697: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1698: <p>To install binary packages, you first need to know from where
                   1699:     to get them. The first place where you should look is on the main
1.110     hubertf  1700:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1701: <p>This directory contains binary packages for multiple
                   1702:     platforms. First, select your operating system. (Ignore the
                   1703:     directories with version numbers attached to it, they just exist for
                   1704:     legacy reasons.) Then, select your hardware architecture, and in the
1.109     rillig   1705:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1706: <p>In this directory, you often find a file called
                   1707:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1708:     management tools. If the file is missing, it is likely that your
                   1709:     operating system already provides those tools. Download the file and
                   1710:     extract it in the <code class="filename">/</code> directory. It will create
                   1711:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1712:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1713:     (the database of installed packages).</p>
1.75      rillig   1714: </div>
                   1715: <div class="sect2" lang="en">
                   1716: <div class="titlepage"><div><div><h3 class="title">
                   1717: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1718: <p>In the directory from the last section, there is a
                   1719:     subdirectory called <code class="filename">All</code>, which contains all the
                   1720:     binary packages that are available for the platform, excluding those
                   1721:     that may not be distributed via FTP or CDROM (depending on which
                   1722:     medium you are using), and the ones that have vulnerabilities and
                   1723:     therefore are considered insecure to install without thinking
                   1724:     before.</p>
                   1725: <p>To install packages directly from an FTP or HTTP server, run
                   1726:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1727:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1728: <pre class="screen">
                   1729: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1730: <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>
                   1731: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1732: </pre>
                   1733: <p>Instead of URLs, you can also use local paths, for example if
                   1734:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1735:     repository. If you want to install packages from multiple sources,
                   1736:     you can separate them by a semicolon in
                   1737:     <code class="varname">PKG_PATH</code>.</p>
                   1738: <p>After these preparations, installing a package is very
                   1739:     easy:</p>
                   1740: <pre class="screen">
                   1741: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1742: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1743: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1744: </pre>
1.75      rillig   1745: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1746:     package in question will be installed, too, assuming they are
                   1747:     present where you install from.</p>
1.109     rillig   1748: <p>As mentioned above, packages for which vulnerabilities get
                   1749:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1750:     They don't get deleted since that could be very frustrating if many
                   1751:     other packages depend on it. Instead, they are moved to the
                   1752:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1753:     this directory to the <code class="varname">PKG_PATH</code> variable. 
                   1754:     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
                   1755:     after installing new packages, and verify that the vulnerabilities
                   1756:     are acceptable for your configuration.</p>
1.75      rillig   1757: <p>After you've installed packages, be sure to have
1.88      wiz      1758:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1759:     <code class="varname">PATH</code> so you can actually start the just
                   1760:     installed program.</p>
1.75      rillig   1761: </div>
                   1762: <div class="sect2" lang="en">
                   1763: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1764: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1765: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1766:     installed from source code or from a binary package. The
1.110     hubertf  1767:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1768:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1769:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1770:     name can be given with or without version number. Wildcards can
                   1771:     also be used to deinstall a set of packages, for example
                   1772:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1773:     so that the shell does not expand them before
                   1774:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1775: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1776:     removes all the packages that require the package in question
                   1777:     and then removes the package itself. For example:
1.82      rillig   1778: 
1.88      wiz      1779:     </p>
1.82      rillig   1780: <pre class="screen">
1.88      wiz      1781: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1782:     </pre>
1.82      rillig   1783: <p>
                   1784: 
1.88      wiz      1785:     will remove jpeg and all the packages that used it; this allows
                   1786:     upgrading the jpeg package.</p>
1.82      rillig   1787: </div>
                   1788: <div class="sect2" lang="en">
                   1789: <div class="titlepage"><div><div><h3 class="title">
                   1790: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1791: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1792:     installed packages or binary package files.</p>
1.82      rillig   1793: </div>
                   1794: <div class="sect2" lang="en">
                   1795: <div class="titlepage"><div><div><h3 class="title">
                   1796: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1797: <p>
1.88      wiz      1798:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1799:       known security vulnerabilities to packages which are (or have been)
                   1800:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1801:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1802:     </p>
1.82      rillig   1803: <p>
1.93      rillig   1804:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88      wiz      1805:       this list can be downloaded
                   1806:       automatically, and a security audit of all packages installed on a system
                   1807:       can take place.
                   1808:     </p>
1.82      rillig   1809: <p>
1.93      rillig   1810:       There are two components to
1.91      rillig   1811:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
1.88      wiz      1812:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1813:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1814:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1815:       installed packages are vulnerable.  If a package is vulnerable, you
                   1816:       will see output similar to the following:
                   1817:     </p>
1.82      rillig   1818: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1819:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1820: <p>
1.91      rillig   1821:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.110     hubertf  1822:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88      wiz      1823:       file daily, and include a package audit in the daily security script.
1.110     hubertf  1824:       Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91      rillig   1825:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88      wiz      1826:     </p>
1.82      rillig   1827: </div>
                   1828: <div class="sect2" lang="en">
                   1829: <div class="titlepage"><div><div><h3 class="title">
                   1830: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1831: <p>
1.112     weinem   1832:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.110     hubertf  1833:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.88      wiz      1834:       argument to check if your packages are up-to-date, e.g.
                   1835:     </p>
                   1836: <pre class="screen">
                   1837: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1838: ...
1.88      wiz      1839: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1840:     </pre>
1.110     hubertf  1841: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1842:     package on your system and rebuild any dependencies.
                   1843:     </p>
1.82      rillig   1844: </div>
                   1845: <div class="sect2" lang="en">
                   1846: <div class="titlepage"><div><div><h3 class="title">
                   1847: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1848: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1849:     administrative functions on the package system.</p>
1.82      rillig   1850: </div>
                   1851: <div class="sect2" lang="en">
                   1852: <div class="titlepage"><div><div><h3 class="title">
                   1853: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1854: <p>Please pay very careful attention to the warnings
1.110     hubertf  1855:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1856:     inherent dangers of installing binary packages which you did
                   1857:     not create yourself, and the security holes that can be
                   1858:     introduced onto your system by indiscriminate adding of such
                   1859:     files.</p>
1.75      rillig   1860: <p>The same warning of course applies to every package you
1.88      wiz      1861:     install from source when you haven't completely read and
                   1862:     understood the source code of the package, the compiler that
                   1863:     is used to build the package and all the other tools that are
                   1864:     involved.</p>
1.75      rillig   1865: </div>
                   1866: </div>
                   1867: <div class="sect1" lang="en">
                   1868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1869: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1870: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1871:   directory now contains a set of packages, organized into
                   1872:   categories. You can browse the online index of packages, or run
1.110     hubertf  1873:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1874:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1875:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1876: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1877:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1878:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1879:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1880:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1881:   system (inside a chroot is an exception). </p>
                   1882: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1883:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1884:   instructions how to create your own packages.</p>
1.75      rillig   1885: <div class="sect2" lang="en">
                   1886: <div class="titlepage"><div><div><h3 class="title">
                   1887: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1888: <p>To build packages from source, you need a working C
1.88      wiz      1889:     compiler. On NetBSD, you need to install the
                   1890:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1891:     sets. If you want to build X11-related packages, the
                   1892:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1893:     sets are required, too.</p>
1.75      rillig   1894: </div>
                   1895: <div class="sect2" lang="en">
                   1896: <div class="titlepage"><div><div><h3 class="title">
                   1897: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1898: <p>The first step for building a package is downloading the
1.88      wiz      1899:     distfiles (i.e. the unmodified source). If they have not yet been
                   1900:     downloaded, pkgsrc will fetch them automatically.</p>
                   1901: <p>If you have all files that you need in the
                   1902:     <code class="filename">distfiles</code> directory,
                   1903:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1904:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1905:     </p>
1.82      rillig   1906: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1907: <p>
1.110     hubertf  1908:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1909: <p>By default a list of distribution sites will be randomly
                   1910:     intermixed to prevent huge load on servers which holding popular
                   1911:     packages (for example, SourceForge.net mirrors). Thus, every
                   1912:     time when you need to fetch yet another distfile all the mirrors
                   1913:     will be tried in new (random) order. You can turn this feature
                   1914:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1915:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1916: <p>You can overwrite some of the major distribution sites to
                   1917:     fit to sites that are close to your own.  By setting one or two
                   1918:     variables you can modify the order in which the master sites are
                   1919:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1920:     delimited list of domain suffixes.
                   1921:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1922:     contains a whitespace delimited list of regular expressions.  It
                   1923:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1924:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1925:     some examples.  This may save some of your bandwidth and
                   1926:     time.</p>
1.75      rillig   1927: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1928:     if you want to keep the settings, by editing the
1.110     hubertf  1929:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1930:     and adding the definitions there.</p>
1.82      rillig   1931: <p>
1.88      wiz      1932:       If a package depends on many other packages (such as
1.93      rillig   1933:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1934:       alternate between periods of
                   1935:       downloading source, and compiling. To ensure you have all the source
                   1936:       downloaded initially you can run the command:
                   1937:       </p>
1.82      rillig   1938: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1939: <p>
1.88      wiz      1940:       which will output and run a set of shell commands to fetch the
                   1941:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1942:       also choose to download the files manually.
                   1943:     </p>
1.75      rillig   1944: </div>
                   1945: <div class="sect2" lang="en">
                   1946: <div class="titlepage"><div><div><h3 class="title">
                   1947: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1948: <p>
1.88      wiz      1949:       Once the software has downloaded, any patches will be applied, then it
                   1950:       will be compiled for you. This may take some time depending on your
                   1951:       computer, and how many other packages the software depends on and their
                   1952:       compile time.
                   1953:     </p>
1.75      rillig   1954: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1955: <h3 class="title">Note</h3>
                   1956: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1957:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88      wiz      1958:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   1959: </div>
1.87      wiz      1960: <p>For example, type</p>
1.88      wiz      1961: <pre class="screen">
                   1962: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1963: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1964:     </pre>
1.75      rillig   1965: <p>at the shell prompt to build the various components of the
1.88      wiz      1966:     package.</p>
1.82      rillig   1967: <p>The next stage is to actually install the newly compiled
1.88      wiz      1968:     program onto your system. Do this by entering:
1.82      rillig   1969: 
1.88      wiz      1970:     </p>
1.82      rillig   1971: <pre class="screen">
1.88      wiz      1972: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1973:     </pre>
1.82      rillig   1974: <p>
                   1975: 
1.88      wiz      1976:     while you are still in the directory for whatever package you
                   1977:     are installing.</p>
1.82      rillig   1978: <p>Installing the package on your system may require you to
1.88      wiz      1979:     be root.  However, pkgsrc has a
                   1980:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1981:     to only become root for the actual installation step.</p>
1.82      rillig   1982: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1983:     You can now enter:
1.82      rillig   1984: 
1.88      wiz      1985:     </p>
1.82      rillig   1986: <pre class="screen">
1.88      wiz      1987: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1988:     </pre>
1.82      rillig   1989: <p>
                   1990: 
1.88      wiz      1991:     to remove the compiled files in the work directory, as you shouldn't need
                   1992:     them any more. If other packages were also added to your system
                   1993:     (dependencies) to allow your program to compile, you can tidy these up
                   1994:     also with the command:</p>
1.82      rillig   1995: <pre class="screen">
1.88      wiz      1996: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1997:     </pre>
1.75      rillig   1998: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1999:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      2000: <p>The program is installed under the default root of the
                   2001:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2002:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2003:     variable in your environment, and it will use that value as the
                   2004:     root of your packages tree. So, to use
                   2005:     <code class="filename">/usr/local</code>, set
                   2006:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2007:     Please note that you should use a directory which is dedicated to
                   2008:     packages and not shared with other programs (i.e., do not try and
                   2009:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2010:     to add any of your own files or directories (such as
                   2011:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2012:     <code class="filename">pkgsrc/</code>) below the
                   2013:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2014:     conflicts between programs and other files installed by the
                   2015:     package system and whatever else may have been installed
                   2016:     there.</p>
1.110     hubertf  2017: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2018:     alter some configuration options at build time.  Have a look at
                   2019:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2020:     of what will be set there by default.  Environment variables such
                   2021:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2022:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2023:     set them each time you want to use pkgsrc.</p>
                   2024: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2025:     covers</span>&#8221; to see what is going on when a package is building
                   2026:     or being installed. This may be for debugging purposes, or out of
                   2027:     simple curiosity. A number of utility values have been added to
                   2028:     help with this.</p>
1.75      rillig   2029: <div class="orderedlist"><ol type="1">
                   2030: <li>
1.110     hubertf  2031: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2032:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2033:        information will be displayed. For example,</p>
1.75      rillig   2034: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2035: <p>will show all the commands that are invoked, up to and
                   2036:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2037: </li>
                   2038: <li>
1.110     hubertf  2039: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2040:        definition, then the <code class="varname">VARNAME</code> definition
                   2041:        should be used, in conjunction with the show-var
1.110     hubertf  2042:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2043:        variable <code class="varname">LOCALBASE</code>:</p>
                   2044: <pre class="screen">
                   2045: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2046: /usr/pkg
                   2047: <code class="prompt">%</code>
1.88      wiz      2048:        </pre>
1.75      rillig   2049: </li>
                   2050: </ol></div>
                   2051: <p>If you want to install a binary package that you've either
1.88      wiz      2052:     created yourself (see next section), that you put into
                   2053:     pkgsrc/packages manually or that is located on a remote FTP
                   2054:     server, you can use the "bin-install" target. This target will
1.110     hubertf  2055:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2056:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2057:     sites searched is kept in the variable
                   2058:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.110     hubertf  2059:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2060:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2061:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2062:     details.</p>
                   2063: <p>A final word of warning: If you set up a system that has a
                   2064:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2065:     set that before any packages are installed, as you cannot use
                   2066:     several directories for the same purpose. Doing so will result in
                   2067:     pkgsrc not being able to properly detect your installed packages,
                   2068:     and fail miserably. Note also that precompiled binary packages are
                   2069:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2070:     <code class="filename">/usr/pkg</code>, and that you should
                   2071:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2072:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2073: </div>
                   2074: </div>
                   2075: </div>
                   2076: <div class="chapter" lang="en">
                   2077: <div class="titlepage"><div><div><h2 class="title">
                   2078: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2079: <div class="toc">
                   2080: <p><b>Table of Contents</b></p>
                   2081: <dl>
                   2082: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2083: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2084: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2085: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2086: <dd><dl>
1.103     wiz      2087: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
                   2088: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2089: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      2090: </dl></dd>
1.103     wiz      2091: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2092: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2093: </dl>
                   2094: </div>
1.104     rillig   2095: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2096: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2097: that file depends on the installation. On NetBSD, when you use
1.110     hubertf  2098: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2099: <code class="filename">/etc/</code>. In all other cases the default location is
                   2100: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2101: bootstrap program to install the binary packages.</p>
                   2102: <p>During the bootstrap, an example configuration file is created. To
                   2103: use that, you have to create the directory
                   2104: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2105: there.</p>
                   2106: <p>The format of the configuration file is that of the usual
                   2107: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2108: is done by setting variables in this file. Note that you can define all
                   2109: kinds of variables, and no special error checking (for example for
                   2110: spelling mistakes) takes place, so you have to try it out to see if it
                   2111: works.</p>
1.75      rillig   2112: <div class="sect1" lang="en">
                   2113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2114: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2115: <p>In this section, you can find some variables that apply to all
1.89      rillig   2116:     pkgsrc packages. A complete list of the variables that can be
                   2117:     configured by the user is available in
                   2118:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2119:     comments that describe each variable's intent.</p>
1.75      rillig   2120: <div class="itemizedlist"><ul type="disc">
                   2121: <li><p><code class="varname">LOCALBASE</code>: Where
                   2122:            packages will be installed. The default is
1.76      rillig   2123:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2124:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2125: <li><p><code class="varname">CROSSBASE</code>: Where
                   2126:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2127:            installed. The default is
1.76      rillig   2128:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2129: <li><p><code class="varname">X11BASE</code>: Where
                   2130:            X11 is installed on the system. The default is
1.76      rillig   2131:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2132: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2133:            downloaded copies of the original source distributions used
                   2134:            for building pkgsrc packages. The default is
1.76      rillig   2135:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2136: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2137:            database about installed packages is stored.  The default is
                   2138:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2139: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2140:            If set, override the packages'
                   2141:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2142: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2143:            Backup location(s) for distribution files and patch files
                   2144:            if not found locally or in
1.76      rillig   2145:            <code class="filename">${MASTER_SITES}</code> or
                   2146:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2147:            The defaults are
1.76      rillig   2148:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2149:            and
1.76      rillig   2150:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2151: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2152:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2153:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2154:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2155:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2156: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2157:            List of acceptable licenses. Whenever you try to build a package
                   2158:            whose license is not in this list, you will get an error message
                   2159:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2160: </ul></div>
                   2161: </div>
                   2162: <div class="sect1" lang="en">
                   2163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2164: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2165: <p>XXX
                   2166:       </p>
                   2167: <div class="itemizedlist"><ul type="disc">
                   2168: <li><p><code class="varname">PACKAGES</code>: The top level
                   2169:            directory for the binary packages. The default is
1.76      rillig   2170:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2171: <li><p><code class="varname">WRKOBJDIR</code>:
                   2172:            The top level directory where, if defined, the separate
                   2173:            working directories will get created, and symbolically
1.76      rillig   2174:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2175:            This is useful for building packages on several
1.76      rillig   2176:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2177:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2178:            is local to every architecture. (It should be noted that
                   2179:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.112     weinem   2180:            &#8212; it is an internal definition which refers to the
1.75      rillig   2181:            root of the pkgsrc tree. It is possible to have many
                   2182:            pkgsrc tree instances.)</p></li>
                   2183: <li><p><code class="varname">LOCALPATCHES</code>:
                   2184:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2185:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2186:            information.</p></li>
1.75      rillig   2187: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2188:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2189:            BSD-style Makefile. If this is not set,
                   2190:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2191:            <code class="filename">/dev/null</code> to avoid picking up
                   2192:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2193: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2194:            By default, dependencies are only installed, and no binary
                   2195:            package is created for them. You can set this variable to
                   2196:            <code class="literal">package</code> to automatically create binary
                   2197:            packages after installing dependencies.</p></li>
1.75      rillig   2198: </ul></div>
                   2199: </div>
                   2200: <div class="sect1" lang="en">
                   2201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2202: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103     wiz      2203: <p>A growing number of packages support installation into a
                   2204:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2205:     to be built, before the actual filesystem is touched. DESTDIR
                   2206:     support exists in two variations:</p>
                   2207: <div class="itemizedlist"><ul type="disc">
                   2208: <li><p>Basic DESTDIR support means that the package
                   2209:       installation and packaging is still run as
                   2210:       root.</p></li>
                   2211: <li><p>Full DESTDIR support can run the complete build,
                   2212:       installation and packaging as normal user. Root privileges are
                   2213:       only needed to add packages.</p></li>
                   2214: </ul></div>
                   2215: <p>To use the DESTDIR support, set either
                   2216:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2217:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2218:     get the full support with fallback to basic
                   2219:     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
                   2220:     newer). It might become the default DESTDIR support later.</p>
                   2221: <p>DESTDIR support changes the behaviour of various targets
                   2222:     slightly. To install a package after building it, use
                   2223:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2224:     <code class="literal">install</code> don't do that any
                   2225:     longer. <code class="literal">package-install</code> can be used as
                   2226:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2227:     will ask for the root password to install the package and fail,
                   2228:     <code class="literal">package-install</code> will ask again.</p>
                   2229: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2230:     clean</code></strong> needs to be run as root.</p>
                   2231: </div>
                   2232: <div class="sect1" lang="en">
                   2233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2234: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2235: <div class="sect2" lang="en">
                   2236: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2237: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2238: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2239:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2240: <div class="variablelist"><dl>
                   2241: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2242: <dd>
                   2243: <p>This is a list of values specifying the chain of
                   2244:          compilers to invoke when building packages.  Valid values
                   2245:          are:</p>
                   2246: <div class="itemizedlist"><ul type="disc">
                   2247: <li><p><code class="varname">distcc</code>:
                   2248:            distributed C/C++ (chainable)</p></li>
                   2249: <li><p><code class="varname">ccache</code>:
                   2250:            compiler cache (chainable)</p></li>
                   2251: <li><p><code class="varname">gcc</code>:
                   2252:            GNU C/C++ Compiler</p></li>
                   2253: <li><p><code class="varname">mipspro</code>:
                   2254:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2255: <li><p><code class="varname">mipspro</code>:
                   2256:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2257: <li><p><code class="varname">sunpro</code>:
                   2258:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2259: </ul></div>
                   2260: <p>The default is
                   2261:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2262:          <code class="varname">ccache</code> and/or
                   2263:          <code class="varname">distcc</code> with an appropriate
                   2264:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2265:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2266:          variable should always be terminated with a value for
                   2267:          a real compiler.  Note that only one real compiler
                   2268:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2269:          is not allowed).</p>
1.89      rillig   2270: </dd>
                   2271: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2272: <dd><p>This specifies the minimum version of GCC to use
                   2273:          when building packages.  If the system GCC doesn't
                   2274:          satisfy this requirement, then pkgsrc will build and
                   2275:          install one of the GCC packages to use instead.</p></dd>
                   2276: </dl></div>
                   2277: </div>
                   2278: <div class="sect2" lang="en">
                   2279: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2280: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2281: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2282:        please make sure to use the <code class="literal">+=</code> operator
                   2283:        instead of the <code class="literal">=</code> operator:</p>
                   2284: <pre class="programlisting">
1.100     rillig   2285: CFLAGS+=        -your -flags
1.78      rillig   2286: </pre>
                   2287: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2288:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2289:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2290:        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
1.78      rillig   2291:        you're interested in optimization for the current CPU.</p>
                   2292: </div>
1.88      wiz      2293: <div class="sect2" lang="en">
                   2294: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2295: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2296: <p>If you want to pass flags to the linker, both in the configure
                   2297: step and the build step, you can do this in two ways.  Either set
                   2298: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2299: between the two is that <code class="varname">LIBS</code> will be appended to
                   2300: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2301: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2302: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2303: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2304: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2305: settings, use the <code class="literal">+=</code> operator:</p>
                   2306: <pre class="programlisting">
1.100     rillig   2307: LDFLAGS+=        -your -linkerflags
1.88      wiz      2308: </pre>
                   2309: </div>
1.78      rillig   2310: </div>
                   2311: <div class="sect1" lang="en">
                   2312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2313: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2314: <p>XXX
                   2315:       </p>
                   2316: <div class="itemizedlist"><ul type="disc">
                   2317: <li>
                   2318: <p><code class="varname">PKG_DEVELOPER</code>:
                   2319:            Run some sanity checks that package developers want:
                   2320:            </p>
                   2321: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2322: <li><p>make sure patches apply with zero
                   2323:              fuzz</p></li>
                   2324: <li><p>run check-shlibs to see that all
                   2325:              binaries will find their shared libs.</p></li>
1.75      rillig   2326: </ul></div>
                   2327: <p>
1.87      wiz      2328:        </p>
1.75      rillig   2329: </li>
1.88      wiz      2330: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2331:        of debugging output which is displayed whilst making and
                   2332:        installing the package.  The default value for this is 0,
                   2333:        which will not display the commands as they are executed
                   2334:        (normal, default, quiet operation); the value 1 will display
                   2335:        all shell commands before their invocation, and the value 2
                   2336:        will display both the shell commands before their invocation,
1.110     hubertf  2337:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2338:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2339: </ul></div>
                   2340: <p>
                   2341:     </p>
                   2342: </div>
                   2343: <div class="sect1" lang="en">
                   2344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2345: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2346: <p>Some packages have build time options, usually to select
                   2347:     between different dependencies, enable optional support for big
                   2348:     dependencies or enable experimental features.</p>
1.75      rillig   2349: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2350:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2351:     show-options</strong></span>, for example:</p>
1.75      rillig   2352: <pre class="programlisting">
                   2353:     The following options are supported by this package:
                   2354:         ssl      Enable SSL support.
                   2355:     Exactly one of the following gecko options is required:
                   2356:         firefox  Use firefox as gecko rendering engine.
                   2357:         mozilla  Use mozilla as gecko rendering engine.
                   2358:     At most one of the following database options may be selected:
                   2359:         mysql    Enable support for MySQL database.
                   2360:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2361: 
1.75      rillig   2362:     These options are enabled by default: firefox
                   2363:     These options are currently enabled: mozilla ssl
1.1       grant    2364: </pre>
1.75      rillig   2365: <p>The following variables can be defined in
1.110     hubertf  2366:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2367:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2368:     which can be used to select or disable options for all packages
                   2369:     that support them, and
                   2370:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2371:     which can be used to select or disable options specifically for
                   2372:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2373:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2374:     are disabled. A few examples:</p>
1.75      rillig   2375: <pre class="screen">
1.110     hubertf  2376: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2377: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2378: PKG_OPTIONS.kdebase=    debug -sasl
                   2379: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2380: <p>It is important to note that options that were specifically
                   2381:     suggested by the package maintainer must be explicitely removed if
                   2382:     you do not wish to include the option.  If you are unsure you can view
                   2383:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2384: <p>The following settings are consulted in the order given, and
                   2385:     the last setting that selects or disables an option is
                   2386:     used:</p>
1.75      rillig   2387: <div class="orderedlist"><ol type="1">
                   2388: <li><p>the default options as suggested by the package
1.88      wiz      2389:       maintainer</p></li>
1.75      rillig   2390: <li><p>the options implied by the settings of legacy
1.88      wiz      2391:       variables (see below)</p></li>
1.75      rillig   2392: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2393: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2394: </ol></div>
                   2395: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2396:     selected is used, all others are automatically disabled.  If an
                   2397:     option of the group is explicitly disabled, the previously
                   2398:     selected option, if any, is used.  It is an error if no option
                   2399:     from a required group of options is selected, and building the
                   2400:     package will fail.</p>
                   2401: <p>Before the options framework was introduced, build options
                   2402:     were selected by setting a variable (often named
                   2403:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2404:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2405:     transition to the options framework for the user, these legacy
                   2406:     variables are converted to the appropriate options setting
                   2407:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2408:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2409:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2410:     directly.  Support for the legacy variables will be removed
                   2411:     eventually.</p>
1.75      rillig   2412: </div>
                   2413: </div>
                   2414: <div class="chapter" lang="en">
                   2415: <div class="titlepage"><div><div><h2 class="title">
                   2416: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2417: <div class="toc">
                   2418: <p><b>Table of Contents</b></p>
                   2419: <dl>
                   2420: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2421: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2422: </dl>
                   2423: </div>
                   2424: <div class="sect1" lang="en">
                   2425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2426: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2427: <p>Once you have built and installed a package, you can create
                   2428:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110     hubertf  2429:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2430:     the same package on a group of hosts and wasting CPU time. It also
                   2431:     provides a simple means for others to install your package, should
                   2432:     you distribute it.</p>
                   2433: <p>To create a binary package, change into the appropriate
1.110     hubertf  2434:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2435:     package</strong></span>:</p>
                   2436: <pre class="screen">
                   2437: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2438: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2439:     </pre>
                   2440: <p>This will build and install your package (if not already done),
                   2441:     and then build a binary package from what was installed. You can
1.110     hubertf  2442:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2443:     it. Binary packages are created by default in
                   2444:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2445:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.91      rillig   2446:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2447: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2448:     such a binary package.</p>
1.75      rillig   2449: </div>
                   2450: <div class="sect1" lang="en">
                   2451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2452: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2453: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2454: </div>
                   2455: </div>
                   2456: <div class="chapter" lang="en">
                   2457: <div class="titlepage"><div><div><h2 class="title">
                   2458: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2459: builds)</h2></div></div></div>
                   2460: <div class="toc">
                   2461: <p><b>Table of Contents</b></p>
                   2462: <dl>
                   2463: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2464: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2465: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2466: <dd><dl>
                   2467: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2468: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2469: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2470: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2471: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2472: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2473: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2474: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2475: </dl></dd>
                   2476: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
                   2477: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
                   2478: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2479: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2480: </dl>
                   2481: </div>
                   2482: <p>When you have multiple machines that should run the same packages,
                   2483: it is wasted time if they all build their packages themselves from
                   2484: source. There are two ways of getting a set of binary packages: The old
                   2485: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2486: system. This chapter describes how to set them up so that the packages
                   2487: are most likely to be usable later.</p>
                   2488: <div class="sect1" lang="en">
                   2489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2490: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2491: <p>Since a bulk build takes several days or even weeks to finish, you
                   2492: should think about the setup before you start everything. Pay attention
                   2493: to at least the following points:</p>
                   2494: <div class="itemizedlist"><ul type="disc">
                   2495: <li>
                   2496: <p>If you want to upload the binary packages to
                   2497: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2498: packages:</p>
                   2499: <div class="itemizedlist"><ul type="circle">
                   2500: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2501: by a NetBSD developer on a trusted machine (that is, where you and only
                   2502: you have root access).</p></li>
                   2503: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2504: the stable branches (like 2007Q1), so that users browsing the available
                   2505: collections can see at a glance how old the packages
                   2506: are.</p></li>
                   2507: <li><p>The packages must be built as root, since some packages
                   2508: require set-uid binaries at runtime, and creating those packages as
                   2509: unprivileged user doesn't work well at the moment.</p></li>
                   2510: </ul></div>
                   2511: </li>
                   2512: <li><p>Make sure that the bulk build cannot break anything in
                   2513: your system. Most bulk builds run as root, so they should be run at least
                   2514: in a chroot environment or something even more restrictive, depending on
                   2515: what the operating system provides. There have been numerous cases where
                   2516: certain packages tried to install files outside the
                   2517: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2518: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2519: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2520: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2521: that you don't need any package during the build.</p></li>
                   2522: </ul></div>
                   2523: </div>
                   2524: <div class="sect1" lang="en">
                   2525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2526: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2527: <p>A complete bulk build requires lots of disk space. Some of the
                   2528: disk space can be read-only, some other must be writable. Some can be on
                   2529: remote filesystems (such as NFS) and some should be local. Some can be
                   2530: temporary filesystems, others must survive a sudden reboot.</p>
                   2531: <div class="itemizedlist"><ul type="disc">
                   2532: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2533: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2534: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2535: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2536: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2537: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2538: </ul></div>
1.75      rillig   2539: </div>
                   2540: <div class="sect1" lang="en">
                   2541: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2542: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
                   2543: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2544: <h3 class="title">Warning</h3>
                   2545: <p>The rest of this section is rather old. Don't rely on it
                   2546: too much.</p>
                   2547: </div>
1.75      rillig   2548: <div class="sect2" lang="en">
                   2549: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2550: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75      rillig   2551: <div class="sect3" lang="en">
                   2552: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2553: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2554: </h4></div></div></div>
1.76      rillig   2555: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2556:        configuration file for bulk builds. You can configure how your
                   2557:        copy of pkgsrc is kept up to date, how the distfiles are
                   2558:        downloaded, how the packages are built and how the report is
                   2559:        generated. You can find an annotated example file in
                   2560:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2561:        it, copy <code class="filename">build.conf-example</code> to
                   2562:        <code class="filename">build.conf</code> and edit it, following the
                   2563:        comments in that file.</p>
1.75      rillig   2564: </div>
                   2565: <div class="sect3" lang="en">
                   2566: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2567: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104     rillig   2568: </h4></div></div></div>
1.110     hubertf  2569: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2570:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2571:        details of the default settings. You will want to ensure that
                   2572:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2573:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104     rillig   2574:        completely bypasses the license check.</p>
1.87      wiz      2575: <pre class="programlisting">
1.100     rillig   2576: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2577: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2578: BSDSRCDIR=      /usr/src
                   2579: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2580: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2581: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2582: PKG_DEVELOPER?= yes
                   2583: _ACCEPTABLE=    yes
                   2584: </pre>
1.75      rillig   2585: <p>Some options that are especially useful for bulk builds
                   2586:        can be found at the top lines of the file
1.76      rillig   2587:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2588:        options of these are briefly described here.</p>
                   2589: <div class="itemizedlist"><ul type="disc">
                   2590: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2591:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2592:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2593: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2594:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2595:          to the directory where all log files are created. Otherwise the
                   2596:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2597: <li><p>Another important variable is
1.87      wiz      2598:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2599:          should be always available while building other
                   2600:          packages.</p></li>
1.75      rillig   2601: </ul></div>
                   2602: <p>Some other options are scattered in the pkgsrc
                   2603:        infrastructure:</p>
                   2604: <div class="itemizedlist"><ul type="disc">
                   2605: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2606:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2607:          builds is creating binary packages, no matter if they are
                   2608:          vulnerable or not. When uploading the packages to a public
                   2609:          server, the vulnerable packages will be put into a directory of
                   2610:          their own. Leaving this variable unset would prevent the bulk
                   2611:          build system from even trying to build them, so possible
                   2612:          building errors would not show up.</p></li>
1.75      rillig   2613: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2614:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2615:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2616:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2617: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2618:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2619:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2620:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2621:          interpreter.</p></li>
1.91      rillig   2622: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2623:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2624:          package's self-test before installing it. Note that some
                   2625:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2626:          numbers, so you need to assure that the machine on which you
                   2627:          are doing the bulk builds is not completely idle. Otherwise
                   2628:          some test programs will seem to hang, while they are just
                   2629:          waiting for new random data to be
                   2630:          available.</p></li>
1.75      rillig   2631: </ul></div>
                   2632: </div>
                   2633: <div class="sect3" lang="en">
                   2634: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2635: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2636: </h4></div></div></div>
1.75      rillig   2637: <p>It is possible to configure the bulk build to perform
1.87      wiz      2638:        certain site-specific tasks at the end of the pre-build
                   2639:        stage.  If the file
                   2640:        <code class="filename">pre-build.local</code> exists in
                   2641:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110     hubertf  2642:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87      wiz      2643:        stage.  An example use of
                   2644:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2645: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2646:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2647: <p>to prevent the system from trying to build a particular package
1.87      wiz      2648:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2649: </div>
                   2650: </div>
                   2651: <div class="sect2" lang="en">
                   2652: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2653: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2654: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2655:       deleted at the start of bulk builds, make sure your login
                   2656:       shell is placed somewhere else. Either drop it into
                   2657:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2658:       shell in the passwd file), or (re-)install it via
1.110     hubertf  2659:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87      wiz      2660:       you can login after a reboot (remember that your current
                   2661:       process won't die if the package is removed, you just can't
                   2662:       start any new instances of the shell any more).  Also, if you
                   2663:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2664:       version of ssh for some reason, be sure to install ssh before
                   2665:       starting it from <code class="filename">rc.local</code>:</p>
                   2666: <pre class="programlisting">
1.100     rillig   2667: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2668: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2669:   /usr/pkg/etc/rc.d/sshd
                   2670: fi
                   2671: </pre>
1.75      rillig   2672: <p>Not doing so will result in you being not able to log in
1.87      wiz      2673:       via ssh after the bulk build is finished or if the machine
                   2674:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2675: </div>
                   2676: <div class="sect2" lang="en">
                   2677: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2678: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2679: <p>Make sure you don't need any of the packages still
1.87      wiz      2680:       installed.</p>
1.75      rillig   2681: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2682: <h3 class="title">Warning</h3>
1.99      rillig   2683: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2684:        configuration files and some more files from
                   2685:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2686:        possibly other locations will be removed! So don't run a bulk
                   2687:        build with privileges that might harm your
                   2688:        system.</em></span></p>
1.75      rillig   2689: </div>
                   2690: <p>Be sure to remove all other things that might
1.87      wiz      2691:       interfere with builds, like some libs installed in
                   2692:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2693: <pre class="screen">
                   2694: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2695: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2696:       </pre>
1.75      rillig   2697: <p>If for some reason your last build didn't complete (power
1.87      wiz      2698:       failure, system panic, ...), you can continue it by
                   2699:       running:</p>
1.75      rillig   2700: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2701: <p>At the end of the bulk build, you will get a summary via mail,
                   2702:       and find build logs in the directory specified by
                   2703:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2704:       file.</p>
1.75      rillig   2705: </div>
                   2706: <div class="sect2" lang="en">
                   2707: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2708: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2709: <p>The bulk builds consist of three steps:</p>
                   2710: <div class="variablelist"><dl>
                   2711: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2712: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2713:            cleans out any broken distfiles, and removes all
                   2714:            packages installed.</p></dd>
1.75      rillig   2715: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2716: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2717:            an optimised order in which packages will be
                   2718:            built. Packages that don't require other packages will
                   2719:            be built first, and packages with many dependencies will
                   2720:            be built later.</p></dd>
1.75      rillig   2721: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2722: <dd><p>Generates a report that's placed in the directory
                   2723:            specified in the <code class="filename">build.conf</code> file
                   2724:            named <code class="filename">broken.html</code>, a short version
                   2725:            of that report will also be mailed to the build's
                   2726:            admin.</p></dd>
1.75      rillig   2727: </dl></div>
1.87      wiz      2728: <p>During the build, a list of broken packages will be compiled
                   2729:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2730:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2731:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2732:       of broken builds can be found in the package's
                   2733:       directory. These files are used by the bulk-targets to mark
                   2734:       broken builds to not waste time trying to rebuild them, and
                   2735:       they can be used to debug these broken package builds
                   2736:       later.</p>
1.75      rillig   2737: </div>
                   2738: <div class="sect2" lang="en">
                   2739: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2740: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2741: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2742:       NetBSD 2.0/i386:</p>
1.75      rillig   2743: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2744: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2745: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2746: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2747: </ul></div>
                   2748: <p>Note that all pkgs will be de-installed as soon as they are
                   2749:       turned into a binary package, and that sources are removed,
                   2750:       so there is no excessively huge demand to disk
                   2751:       space. Afterwards, if the package is needed again, it will
1.110     hubertf  2752:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87      wiz      2753:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2754: </div>
                   2755: <div class="sect2" lang="en">
                   2756: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2757: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2758: <p>If you don't want all the packages nuked from a machine
                   2759:       (rendering it useless for anything but pkg compiling), there
                   2760:       is the possibility of doing the package bulk build inside a
                   2761:       chroot environment.</p>
                   2762: <p>The first step is to set up a chroot sandbox,
                   2763:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2764:       using null mounts, or manually.</p>
                   2765: <p>There is a shell script called
                   2766:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2767:       up the sandbox environment using null mounts. It will also
                   2768:       create a script called <code class="filename">sandbox</code> in the
                   2769:       root of the sandbox environment, which will allow the null
1.110     hubertf  2770:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2771:       mount</strong></span> command and deactivated using the
1.110     hubertf  2772:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2773: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2774:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2775:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2776:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2777:       are present and properly configured:</p>
1.75      rillig   2778: <div class="procedure"><ol type="1">
                   2779: <li>
                   2780: <p>Kernel</p>
                   2781: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2782: </li>
                   2783: <li>
1.76      rillig   2784: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2785: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2786: </li>
                   2787: <li>
1.91      rillig   2788: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75      rillig   2789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2790: </li>
                   2791: <li>
                   2792: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2794: </li>
                   2795: <li>
1.91      rillig   2796: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75      rillig   2797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2798: </li>
                   2799: <li>
1.76      rillig   2800: <p><code class="filename">/usr/src</code> (system sources,
1.112     weinem   2801:          e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75      rillig   2802: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2803:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2804: </li>
                   2805: <li>
1.76      rillig   2806: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2807: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2808: </li>
                   2809: <li>
1.76      rillig   2810: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2811: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2812: </li>
                   2813: <li>
                   2814: <p>Checkout pkgsrc via cvs into
1.87      wiz      2815:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2816: <pre class="screen">
                   2817: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2818: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2819:          </pre>
1.75      rillig   2820: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2821:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2822: </li>
                   2823: <li><p>Make
1.87      wiz      2824:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2825:          <code class="filename">.../distfiles</code> point somewhere
                   2826:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.110     hubertf  2827: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
1.76      rillig   2828: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2829: </ol></div>
                   2830: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2831:       the build with the following steps:</p>
                   2832: <pre class="screen">
                   2833: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2834: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2835:       </pre>
                   2836: <p>This will just jump inside the sandbox and start building.  At
                   2837:        the end of the build, mail will be sent with the results of
                   2838:        the build. Created binary pkgs will be in
                   2839:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2840:       (wherever that points/mounts to/from).</p>
1.75      rillig   2841: </div>
                   2842: <div class="sect2" lang="en">
                   2843: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2844: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2845: <p>In addition to building a complete set of all packages in
                   2846:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2847:       may be used to build a subset of the packages contained in
                   2848:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2849:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75      rillig   2850: <div class="itemizedlist"><ul type="disc">
                   2851: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2852: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2853: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2854: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2855: </ul></div>
1.87      wiz      2856: <p>will define the set of packages which should be built.
                   2857:       The bulk build code will also include any packages which are
                   2858:       needed as dependencies for the explicitly listed packages.</p>
                   2859: <p>One use of this is to do a bulk build with
                   2860:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2861:       periodically to have a complete set of the binary packages
                   2862:       needed for your site available without the overhead of
                   2863:       building extra packages that are not needed.</p>
1.75      rillig   2864: </div>
                   2865: <div class="sect2" lang="en">
                   2866: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2867: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2868: <p>This section describes how pkgsrc developers can upload binary
                   2869:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2870: <p>If you would like to automatically create checksum files for the
                   2871:       binary packages you intend to upload, remember to set
                   2872:       <code class="varname">MKSUMS=yes</code> in your
                   2873:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2874: <p>If you would like to PGP sign the checksum files (highly
                   2875:       recommended!), remember to set
                   2876:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2877:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2878:       your GPG password to sign the files before uploading everything.</p>
                   2879: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2880:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2881:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2882: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2883: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2884:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2885:       is different from your local login, write your login directly
                   2886:       into the variable, e.g. my local account is "feyrer", but for my
                   2887:       login "hubertf", I use:</p>
1.93      rillig   2888: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2889: <p>A separate <code class="filename">upload</code> directory is used
                   2890:       here to allow "closing" the directory during upload. To do
                   2891:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2892: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87      wiz      2893: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2894:       only appropriate for packages for the NetBSD operating
                   2895:       system. Binary packages for other operating systems should go
                   2896:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2897: <p>Before uploading the binary pkgs, ssh authentication needs
                   2898:       to be set up. This example shows how to set up temporary keys
                   2899:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2900:       (assuming that no keys should be present there usually):</p>
                   2901: <pre class="screen">
                   2902: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2903: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2904: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2905: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2906:       </pre>
                   2907: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2908:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2909:       file on ftp.NetBSD.org. You can remove the key after the
                   2910:       upload is done!</p>
                   2911: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2912: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2913: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2914: <p>Now after all this works, you can exit the sandbox and start
                   2915:       the upload:</p>
                   2916: <pre class="screen">
                   2917: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   2918: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      2919: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2920:       </pre>
1.110     hubertf  2921: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2922:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87      wiz      2923:       upload. The upload script will take care of not uploading
                   2924:       restricted packages and putting vulnerable packages into the
                   2925:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2926: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   2927: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      2928:       Gdd:x! </pre>
                   2929: <p>Use whatever is needed to remove the key you've entered
                   2930:       before! Last, move the uploaded packages out of the
                   2931:       <code class="filename">upload</code> directory to have them accessible
                   2932:       to everyone:</p>
                   2933: <pre class="screen">
1.93      rillig   2934: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   2935: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2936: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      2937: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2938:       </pre>
1.75      rillig   2939: </div>
                   2940: </div>
                   2941: <div class="sect1" lang="en">
                   2942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2943: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
                   2944: <div class="sect2" lang="en">
                   2945: <div class="titlepage"><div><div><h3 class="title">
                   2946: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
1.110     hubertf  2947: <p>TODO; see <a class="ulink" href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
1.106     rillig   2948: more information.</p>
                   2949: </div>
                   2950: </div>
                   2951: <div class="sect1" lang="en">
                   2952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2953: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2954: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2955:     create a CD-ROM set of the resulting binary packages to assist
                   2956:     in installing packages on other machines.  The
1.91      rillig   2957:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2958:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2959:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2960:     way that keeps all the dependencies for a given package on the same
                   2961:     CD as that package.</p>
1.75      rillig   2962: <div class="sect2" lang="en">
                   2963: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2964: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2965: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2966:       man page. The following short example assumes that the binary
                   2967:       packages are left in
                   2968:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2969:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2970:       hold the ISO 9660 images.</p>
                   2971: <pre class="screen">
                   2972: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2973: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2974: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2975:       </pre>
                   2976: <p>If you wish to include a common set of files
                   2977:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2978:       etc.) on each CD in the collection, then you need to create a
                   2979:       directory which contains these files. e.g.</p>
                   2980: <pre class="screen">
                   2981: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2982: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2983: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2984: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2985: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2986: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2987: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2988:       </pre>
1.75      rillig   2989: <p>Now create the images:</p>
                   2990: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   2991: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2992:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2993:       in their root directories.</p>
1.75      rillig   2994: </div>
                   2995: </div>
                   2996: </div>
                   2997: <div class="chapter" lang="en">
                   2998: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2999: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3000: <div class="toc">
                   3001: <p><b>Table of Contents</b></p>
                   3002: <dl>
1.106     rillig   3003: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3004: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   3005: </dl>
                   3006: </div>
                   3007: <p>The files that are installed by pkgsrc are organized in a way that
                   3008: is similar to what you find in the <code class="filename">/usr</code> directory
                   3009: of the base system. But some details are different. This is because
                   3010: pkgsrc initially came from FreeBSD and had adopted its file system
                   3011: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3012: which operating system you are using pkgsrc with, you can expect the
                   3013: same layout for pkgsrc.</p>
1.91      rillig   3014: <p>There are mainly four root directories for pkgsrc, which are all
                   3015: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3016: When pkgsrc has been installed as root, the default locations
                   3017: are:</p>
                   3018: <pre class="programlisting">
1.100     rillig   3019: LOCALBASE=              /usr/pkg
                   3020: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3021: VARBASE=                /var
                   3022: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3023: </pre>
                   3024: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3025: user), the default locations are:</p>
                   3026: <pre class="programlisting">
1.100     rillig   3027: LOCALBASE=              ${HOME}/pkg
                   3028: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3029: VARBASE=                ${HOME}/pkg/var
                   3030: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3031: </pre>
                   3032: <p>What these four directories are for, and what they look like is
                   3033: explained below.</p>
1.90      rillig   3034: <div class="itemizedlist"><ul type="disc">
                   3035: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3036: <code class="filename">/usr</code> directory in the base system. It is the
                   3037: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3038: the well-known subdirectories like <code class="filename">bin</code>,
                   3039: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3040: <code class="filename">share</code> and
                   3041: <code class="filename">sbin</code>.</p></li>
                   3042: <li><p><code class="varname">VARBASE</code> corresponds to
                   3043: <code class="filename">/var</code> in the base system. Some programs (especially
                   3044: games, network daemons) need write access to it during normal
                   3045: operation.</p></li>
                   3046: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3047: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3048: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   3049: itself.</p></li>
                   3050: </ul></div>
                   3051: <div class="sect1" lang="en">
                   3052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3053: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3054: </h2></div></div></div>
1.90      rillig   3055: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3056: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3057: <div class="variablelist"><dl>
                   3058: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3059: <dd><p>Contains executable programs that are intended to be
                   3060: directly used by the end user.</p></dd>
                   3061: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3062: <dd><p>Contains files for the emulation layers of various other
                   3063: operating systems, especially for
                   3064: NetBSD.</p></dd>
                   3065: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3066: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3067: <dd><p>Contains
                   3068: the configuration files.</p></dd>
                   3069: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3070: <dd><p>Contains headers for the C and C++ programming
                   3071: languages.</p></dd>
                   3072: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3073: <dd><p>Contains GNU info files of various
                   3074: packages.</p></dd>
                   3075: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3076: <dd><p>Contains shared and static
                   3077: libraries.</p></dd>
                   3078: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3079: <dd><p>Contains data files that don't change after
                   3080: installation. Other data files belong into
                   3081: <code class="filename">${VARBASE}</code>.</p></dd>
                   3082: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3083: <dd><p>Contains programs that are not intended to be used by
                   3084: end users, such as helper programs or network
                   3085: daemons.</p></dd>
                   3086: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3087: <dd><p>Contains programs that are intended to be executed as
                   3088: CGI scripts by a web server.</p></dd>
                   3089: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3090: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3091: <dd><p>Contains brief
                   3092: documentation in form of manual pages.</p></dd>
                   3093: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3094: <dd><p>Contains programs that are intended to be used only by
                   3095: the super-user.</p></dd>
                   3096: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3097: <dd><p>Contains platform-independent data files that don't
                   3098: change after installation.</p></dd>
                   3099: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3100: <dd><p>Contains documentation files provided by the
                   3101: packages.</p></dd>
                   3102: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3103: <dd><p>Contains example files provided by the packages. Among
                   3104: others, the original configuration files are saved here and copied to
                   3105: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3106: installation.</p></dd>
                   3107: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3108: <dd><p>Contains the original files for rc.d
                   3109: scripts.</p></dd>
                   3110: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3111: <code class="filename">${VARBASE}</code>)</span></dt>
                   3112: <dd><p>Contains files
                   3113: that may be modified after
                   3114: installation.</p></dd>
                   3115: </dl></div>
                   3116: </div>
                   3117: <div class="sect1" lang="en">
                   3118: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3119: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3120: </h2></div></div></div>
1.90      rillig   3121: <div class="variablelist"><dl>
                   3122: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3123: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3124: <dd><p>Contains
                   3125: information about the currently installed
                   3126: packages.</p></dd>
                   3127: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3128: <dd><p>Contains highscore
                   3129: files.</p></dd>
                   3130: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3131: <dd><p>Contains log files.</p></dd>
                   3132: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3133: <dd><p>Contains informational files about daemons that are
                   3134: currently running.</p></dd>
                   3135: </dl></div>
                   3136: </div>
                   3137: </div>
                   3138: <div class="chapter" lang="en">
                   3139: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3140: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3141: <div class="toc">
                   3142: <p><b>Table of Contents</b></p>
                   3143: <dl>
1.106     rillig   3144: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3145: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3146: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3147: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3148: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3149: <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>
                   3150: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.110     hubertf  3151: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106     rillig   3152: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   3153: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3154: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.106     rillig   3155: <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>
                   3156: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3157: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   3159: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   3160: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   3161: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig   3162: </dl>
                   3163: </div>
                   3164: <p>This section contains hints, tips &amp; tricks on special things in
                   3165: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3166: it contains items for both pkgsrc users and developers.</p>
                   3167: <div class="sect1" lang="en">
                   3168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3169: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3170: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3171: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  3172: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3173:          This is a general purpose list for most issues regarding
                   3174:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3175:          for pkgsrc configuration, unexpected build failures, using
                   3176:          particular packages, upgrading pkgsrc installations,
                   3177:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3178:          proposals for changes that impact the pkgsrc user community,
                   3179:          e.g. major infrastructure changes, new features, package
                   3180:          removals, etc., may also be posted.</p></li>
1.110     hubertf  3181: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3182:          A list where the results of pkgsrc bulk builds are sent and
                   3183:          discussed.</p></li>
1.110     hubertf  3184: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3185:          This list is for those who are interested in getting a
                   3186:          commit message for every change committed to pkgsrc. It is
                   3187:          also available in digest form, meaning one daily message
                   3188:          containing all commit messages for changes to the package
                   3189:          source tree in that 24 hour period.</p></li>
                   3190: </ul></div>
                   3191: <p>To subscribe, do:</p>
                   3192: <pre class="programlisting">
1.100     rillig   3193: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3194: </pre>
                   3195: <p>Archives for all these mailing lists are available from
1.110     hubertf  3196: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3197: </div>
                   3198: <div class="sect1" lang="en">
                   3199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3200: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3201: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3202: pkgviews User's guide in
1.76      rillig   3203: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3204: </div>
                   3205: <div class="sect1" lang="en">
                   3206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3207: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3208: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3209: a number of useful utilities for both users and developers of pkgsrc.  This
                   3210: section attempts only to make the reader aware of the utilities and when
                   3211: they might be useful, and not to duplicate the documentation that comes
                   3212: with each package.</p>
                   3213: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3214: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   3215:       Symlinks for use by buildlink.</p></li></ul></div>
                   3216: <p>OS tool augmentation (automatically installed when needed):</p>
                   3217: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3218: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3219:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3220: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   3221:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3222: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      3223:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3224: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   3225:       Up-to-date replacement for
1.76      rillig   3226:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3227:       systems where pkg_install is not present.</p></li>
                   3228: </ul></div>
                   3229: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3230: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3231: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3232:       Create a binary package from an
1.110     hubertf  3233:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3234:       save the old package.</p></li>
1.91      rillig   3235: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   3236:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3237:       from multiple locations. It currently supports the following
                   3238:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3239: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75      rillig   3240:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3241: <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
1.75      rillig   3242:       best compiler flags to optimise code for your current CPU and
                   3243:       compiler.</p></li>
                   3244: </ul></div>
                   3245: <p>Utilities for keeping track of installed packages, being up to date,
                   3246: etc:</p>
                   3247: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3248: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3249:       packages whose installed versions do not match the latest pkgsrc
                   3250:       entries.</p></li>
1.91      rillig   3251: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   3252:       dependency graphs of packages, to aid in choosing a strategy for
                   3253:       updating.</p></li>
1.91      rillig   3254: <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
                   3255:       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>
                   3256: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   3257:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3258: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   3259:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3260: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   3261:       packages you have installed.</p></li>
                   3262: </ul></div>
                   3263: <p>Utilities for people maintaining or creating individual packages:</p>
                   3264: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3265: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3266:       making and maintaining patches for a package (includes pkgdiff,
                   3267:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3268: <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>,
                   3269:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   3270:       converting to pkgsrc.</p></li>
1.91      rillig   3271: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75      rillig   3272:       pkgsrc to a Solaris package.</p></li>
                   3273: </ul></div>
                   3274: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3275: utilities)</p>
                   3276: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3277: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3278:       packages in a chrooted area.</p></li>
1.91      rillig   3279: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3280:       kernel version for chrooted cross builds.</p></li>
                   3281: </ul></div>
                   3282: </div>
                   3283: <div class="sect1" lang="en">
                   3284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3285: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3286: <p>If you want to use pkgsrc as non-root user, you can set some
                   3287: variables to make pkgsrc work under these conditions.  At the very least,
                   3288: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3289: will turn on unprivileged mode and set multiple related variables to allow
                   3290: installation of packages as non-root.</p>
                   3291: <p>In case the defaults are not enough, you may want to tune some other
                   3292: variables used.  For example, if the automatic user/group detection leads
                   3293: to incorrect values (or not the ones you would like to use), you can change
                   3294: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3295: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3296: <p>As regards bootstrapping, please note that the
1.110     hubertf  3297: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75      rillig   3298: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3299: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3300: installation targets.  These directories can be overridden by the
1.75      rillig   3301: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3302: that allow finer tuning of the tree layout.</p>
                   3303: </div>
                   3304: <div class="sect1" lang="en">
                   3305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3306: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3307: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3308: enable this feature by adding the option
                   3309: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3310: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3311: distfile is found, pkgsrc will try to resume it.</p>
                   3312: <p>You can also
1.110     hubertf  3313: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.75      rillig   3314: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3315: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3316: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3317: values.</p>
                   3318: <p>For example, if you want to use
1.76      rillig   3319: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3320: like:</p>
                   3321: <pre class="programlisting">
1.100     rillig   3322: FETCH_CMD=             wget
                   3323: FETCH_BEFORE_ARGS=     --passive-ftp
                   3324: FETCH_RESUME_ARGS=     -c
1.110     hubertf  3325: FETCH_OUTPUT_ARGS=     -O -nc
1.1       grant    3326: </pre>
1.75      rillig   3327: </div>
                   3328: <div class="sect1" lang="en">
                   3329: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3330: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3331: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3332: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3333: you will have to add the following line into
1.110     hubertf  3334: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3335: <pre class="programlisting">
1.103     wiz      3336: X11_TYPE=modular
1.1       grant    3337: </pre>
1.75      rillig   3338: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3339: <h3 class="title">Note</h3>
1.103     wiz      3340: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3341: </p>
1.75      rillig   3342: </div>
                   3343: </div>
                   3344: <div class="sect1" lang="en">
                   3345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3346: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3347: <p>If you are sitting behind a firewall which does not allow direct
                   3348: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3349: relevant proxy hosts.  This is done using an environment variable in the
                   3350: form of a URL, e.g. in Amdahl, the machine
                   3351: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3352: port 80 as the proxy port number.  So the proxy environment variables
                   3353: are:</p>
                   3354: <pre class="programlisting">
1.100     rillig   3355: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3356: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3357: </pre>
1.75      rillig   3358: </div>
                   3359: <div class="sect1" lang="en">
                   3360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  3361: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3362: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3363: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3364: the first available command from the following list:</p>
                   3365: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3366: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3367: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3368: </ul></div>
                   3369: <p>On a default NetBSD installation, this will be
1.76      rillig   3370: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3371: connections first, and falls back to active connections if the server
                   3372: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3373: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3374: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3375: <p>Having that option present will prevent
1.76      rillig   3376: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3377: transfers.</p>
                   3378: </div>
                   3379: <div class="sect1" lang="en">
                   3380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3381: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3382: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3383: from work or university, where you can't run a <span class="command"><strong>make
                   3384: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3385: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3386: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3387: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3388: resulting list to your machine at work/school and use it there.  If you
1.110     hubertf  3389: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3390: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3391: URL:</p>
                   3392: <p>At home:</p>
                   3393: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3394: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3395: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3396: <p>At work:</p>
                   3397: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3398: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3399: home.</p>
                   3400: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3401: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3402: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3403: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3404: directly by running:</p>
1.75      rillig   3405: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3406: <p>If you even decide to ignore
                   3407: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3408: by running:</p>
                   3409: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3410: </div>
                   3411: <div class="sect1" lang="en">
                   3412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3413: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3414: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3415: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3416: package, you get the error from make that it doesn't know how to make
1.76      rillig   3417: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3418: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3419: the NetBSD base distribution on your machine.  It is recommended to do
                   3420: that to format man pages.</p>
1.91      rillig   3421: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3422: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3423: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3424: </div>
                   3425: <div class="sect1" lang="en">
                   3426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3427: <a name="bsd.own.mk-missing"></a>9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3428: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3429: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3430: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3431: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3432: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3433: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3434: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3435: -r</strong></span>).</p>
                   3436: </div>
                   3437: <div class="sect1" lang="en">
                   3438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3439: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3440: <p>When installing packages as non-root user and using the just-in-time
1.110     hubertf  3441: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3442: password for each required package installed.  To avoid this, the sudo
                   3443: package can be used, which does password caching over a limited time.  To
                   3444: use it, install sudo (either as binary package or from
1.98      wiz      3445: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3446: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3447: <span class="emphasis"><em>after</em></span> the definition of the
                   3448: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3449: <pre class="programlisting">
1.100     rillig   3450: .if exists(${LOCALBASE}/bin/sudo)
                   3451: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3452: .endif
1.1       grant    3453: </pre>
1.75      rillig   3454: </div>
                   3455: <div class="sect1" lang="en">
                   3456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3457: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3458: <p>As the system administrator, you can choose where configuration files
                   3459: are installed.  The default settings make all these files go into
1.76      rillig   3460: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3461: be suboptimal depending on your expectations (e.g., a read-only,
                   3462: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3463: configuration of the provided packages).</p>
                   3464: <p>In order to change the defaults, you can modify the
                   3465: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3466: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3467: directory; some common examples include <code class="filename">/etc</code> or
                   3468: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3469: <p>Furthermore, you can change this value on a per-package basis by
                   3470: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3471: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3472: package you would like to modify, that is, the contents of
                   3473: <code class="varname">PKGBASE</code>.</p>
                   3474: <p>Note that after changing these settings, you must rebuild and
                   3475: reinstall any affected packages.</p>
                   3476: </div>
                   3477: <div class="sect1" lang="en">
                   3478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3479: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3480: <p>Please be aware that there can often be bugs in third-party software,
                   3481: and some of these bugs can leave a machine vulnerable to exploitation by
                   3482: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3483: maintains a database of known-exploits to packages which have at one time
                   3484: been included in pkgsrc.  The database can be downloaded automatically, and
                   3485: a security audit of all packages installed on a system can take place.  To
1.91      rillig   3486: 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
1.75      rillig   3487: components:</p>
                   3488: <div class="orderedlist"><ol type="1">
                   3489: <li>
1.110     hubertf  3490: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.75      rillig   3491:     download a list of the security vulnerabilities information.  This list
                   3492:     is kept up to date by the NetBSD security officer and the NetBSD
                   3493:     packages team, and is distributed from the NetBSD ftp server:</p>
1.110     hubertf  3494: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3495: </li>
1.110     hubertf  3496: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.75      rillig   3497:     current machine, checking each vulnerability which is known.  If a
                   3498:     vulnerable package is installed, it will be shown by output to stdout,
                   3499:     including a description of the type of vulnerability, and a URL
                   3500:     containing more information.</p></li>
                   3501: </ol></div>
1.91      rillig   3502: <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>
1.75      rillig   3503: package is strongly recommended!  After
                   3504: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3505: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3506: audit-packages</code></strong>.</p>
1.87      wiz      3507: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3508: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.87      wiz      3509: check.</p>
1.75      rillig   3510: </div>
                   3511: <div class="sect1" lang="en">
                   3512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3513: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3514: <p>When you add your own preferences to the
                   3515:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3516:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3517:        environment variables to the <code class="filename">./configure</code>
1.110     hubertf  3518:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3519:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3520:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3521:        package.</p>
                   3522: <p>Currently there is no solution to this problem. If you
                   3523:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3524:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3525:        directory and then inspect any <code class="filename">Makefile</code> and
                   3526:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3527:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3528:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3529:        programmers write so bad code that it only works for the
                   3530:        specific combination of <code class="varname">CFLAGS</code> they have
                   3531:        chosen.</p>
                   3532: </div>
1.80      rillig   3533: <div class="sect1" lang="en">
                   3534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3535: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3536: <div class="procedure"><ol type="1">
                   3537: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3538:        case that occurs often is that people only update pkgsrc in
                   3539:        parts, because of performance reasons. Since pkgsrc is one large
                   3540:        system, not a collection of many small systems, there are
                   3541:        sometimes changes that only work when the whole pkgsrc tree is
                   3542:        updated.</p></li>
                   3543: <li><p>Make sure that you don't have any CVS conflicts.
                   3544:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3545:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3546:        files.</p></li>
                   3547: <li><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3548:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3549:        verify this.</p></li>
                   3550: <li><p>If the problem still exists, write a mail to the
                   3551:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3552: </ol></div>
                   3553: </div>
1.88      wiz      3554: <div class="sect1" lang="en">
                   3555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3556: <a name="faq.rcs-conflicts"></a>9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.89      rillig   3557: <p>You have modified a file from pkgsrc, and someone else has
                   3558: modified that same file afterwards in the CVS repository. Both changes
                   3559: are in the same region of the file, so when you updated pkgsrc, the
                   3560: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3561: file. Because of these markers, the file is no longer a valid
                   3562: <code class="filename">Makefile</code>.</p>
                   3563: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3564: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3565: -dP</strong></span> in that directory to download the current version.</p>
                   3566: </div>
1.75      rillig   3567: </div>
                   3568: </div>
                   3569: <div class="part" lang="en">
                   3570: <div class="titlepage"><div><div><h1 class="title">
                   3571: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3572: <div class="partintro" lang="en">
                   3573: <div></div>
                   3574: <p>This part of the book deals with creating and
                   3575:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3576:        guide on creating a new package. The remaining chapters are more
                   3577:        like a reference manual for pkgsrc.</p>
1.75      rillig   3578: <div class="toc">
                   3579: <p><b>Table of Contents</b></p>
                   3580: <dl>
1.106     rillig   3581: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3582: <dd><dl>
1.106     rillig   3583: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3584: <dd><dl>
1.106     rillig   3585: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3586: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91      rillig   3587: </dl></dd>
1.106     rillig   3588: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3589: <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>
                   3590: </dl></dd>
                   3591: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3592: <dd><dl>
                   3593: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3594: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
                   3595: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3596: <dd><dl>
                   3597: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3598: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3599: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3600: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3601: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3602: </dl></dd>
                   3603: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3604: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3605: <dd><dl>
                   3606: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3607: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3608: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3609: </dl></dd>
                   3610: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3611: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
                   3612: </dl></dd>
                   3613: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3614: <dd><dl>
                   3615: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
                   3616: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3617: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3618: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3619: <dd><dl>
                   3620: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3621: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3622: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3623: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3624: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3625: </dl></dd>
                   3626: </dl></dd>
                   3627: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3628: <dd><dl>
                   3629: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
                   3630: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.110     hubertf  3631: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   3632: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3633: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
                   3634: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3635: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3636: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3637: </dl></dd>
                   3638: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3639: <dd><dl>
                   3640: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
                   3641: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3642: <dd><dl>
                   3643: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3644: <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>
                   3645: </dl></dd>
                   3646: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3647: <dd><dl>
                   3648: <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>
                   3649: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3650: </dl></dd>
                   3651: </dl></dd>
                   3652: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3653: <dd><dl>
                   3654: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3655: <dd><dl>
                   3656: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3657: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3658: </dl></dd>
                   3659: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3660: <dd><dl>
                   3661: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3662: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3663: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3664: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3665: </dl></dd>
                   3666: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3667: <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>
                   3668: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3669: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3670: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3671: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3672: <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>
                   3673: </dl></dd>
                   3674: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3675: <dd><dl>
                   3676: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3677: <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>
                   3678: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3679: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3680: </dl></dd>
                   3681: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3682: <dd><dl>
                   3683: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3684: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3685: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
                   3687: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3688: <dd><dl>
                   3689: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3690: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3691: </dl></dd>
                   3692: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3693: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3694: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3695: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3696: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3697: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3698: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3699: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3700: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3701: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3702: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3703: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3704: </dl></dd>
                   3705: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3706: <dd><dl>
                   3707: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3708: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3709: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3710: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3711: </dl></dd>
                   3712: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3713: <dd><dl>
                   3714: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3715: <dd><dl>
                   3716: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
                   3717: <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>
                   3718: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3719: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3720: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3721: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3722: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3723: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3724: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3725: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3726: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3727: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3728: </dl></dd>
                   3729: <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>
                   3730: <dd><dl>
                   3731: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3732: <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>
                   3733: </dl></dd>
                   3734: <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>
                   3735: <dd><dl>
                   3736: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3737: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3738: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3739: </dl></dd>
                   3740: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3741: <dd><dl>
                   3742: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3745: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3746: </dl></dd>
                   3747: <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>
                   3748: <dd><dl>
                   3749: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3750: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
                   3751: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3752: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3753: </dl></dd>
                   3754: <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>
                   3755: <dd><dl>
                   3756: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3757: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3758: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3759: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3762: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3763: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3764: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     rillig   3765: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3767: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3769: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3770: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3771: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3772: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3773: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3774:     emulation</a></span></dt>
1.106     rillig   3775: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3776: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3777: </dl></dd>
1.106     rillig   3778: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3779: </dl></dd>
1.106     rillig   3780: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3781: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3782: <dd><dl>
1.106     rillig   3783: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3784: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3785: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3786: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3787: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   3788: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                   3789: </dl></dd>
                   3790: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3791: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3792: <dd><dl>
                   3793: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3794: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3795: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3796: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3797: </dl></dd>
1.75      rillig   3798: </dl>
                   3799: </div>
1.77      rillig   3800: </div>
                   3801: <div class="chapter" lang="en">
                   3802: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3803: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3804: <div class="toc">
                   3805: <p><b>Table of Contents</b></p>
                   3806: <dl>
1.106     rillig   3807: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3808: <dd><dl>
1.106     rillig   3809: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3810: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91      rillig   3811: </dl></dd>
1.106     rillig   3812: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3813: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3814: </dl>
                   3815: </div>
1.77      rillig   3816: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3817: most likely have a URL from where you can download the source
                   3818: code. Starting with this URL, creating a package involves only a
                   3819: few steps.</p>
1.77      rillig   3820: <div class="procedure"><ol type="1">
1.91      rillig   3821: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77      rillig   3822: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3823: category in which you want to place your package. You can also create a
                   3824: directory of your own (maybe called <code class="filename">local</code>). In that
                   3825: category directory, create another directory for your package and change
                   3826: into it.</p></li>
1.110     hubertf  3827: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3828: you for a URL. Enter the URL of the distribution file (in most cases a
                   3829: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3830: of your package are created automatically. The distribution file is
                   3831: extracted automatically to fill in some details in the
                   3832: <code class="filename">Makefile</code> that would otherwise have to be done
                   3833: manually.</p></li>
                   3834: <li>
                   3835: <p>Examine the extracted files to determine the dependencies of
                   3836: your package. Ideally, this is mentioned in some
                   3837: <code class="filename">README</code> file, but things may differ. For each of
                   3838: these dependencies, look where it exists in pkgsrc, and if there is a
                   3839: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3840: line to your package <code class="filename">Makefile</code> which includes that
                   3841: file just before the last line. If the
                   3842: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3843: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3844: version of the dependency and where it can be found in pkgsrc. This line
                   3845: should be placed in the third paragraph. If the dependency is only
                   3846: needed for building the package, but not when using it, use
                   3847: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3848: Your package may then look like this:</p>
1.77      rillig   3849: <pre class="programlisting">
1.100     rillig   3850: [...]
1.77      rillig   3851: 
1.100     rillig   3852: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3853: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3854: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3855: 
1.100     rillig   3856: [...]
1.77      rillig   3857: 
1.100     rillig   3858: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3859: .include "../../devel/glib2/buildlink3.mk"
                   3860: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3861: </pre>
                   3862: </li>
1.110     hubertf  3863: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91      rillig   3864: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.110     hubertf  3865: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3866: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3867: -e</strong></span>, which outputs additional
                   3868: explanations.</p></li>
                   3869: <li><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3870: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3871: over there, you can hopefully continue here.</p></li>
1.110     hubertf  3872: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3873: directory from the extracted files. Besides these files, a lot of cache
                   3874: files and other system information has been saved in the working
                   3875: directory, which may become wrong after you edited the
                   3876: <code class="filename">Makefile</code>.</p></li>
1.110     hubertf  3877: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3878: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.91      rillig   3879: <li><p>When the package builds fine, the next step is to install
1.110     hubertf  3880: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3881: everything works.</p></li>
                   3882: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3883: contains a list of the files that are installed by the package, is
1.110     hubertf  3884: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3885: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3886: the file using your preferred text editor to see if the list of
                   3887: files looks plausible.</p></li>
1.110     hubertf  3888: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3889: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110     hubertf  3890: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3891: has been registered in the database of installed files, but with an
1.110     hubertf  3892: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3893: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3894: registered with the list of files from
                   3895: <code class="filename">PLIST</code>.</p></li>
1.110     hubertf  3896: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3897: package from the set of installed files.</p></li>
1.77      rillig   3898: </ol></div>
1.91      rillig   3899: <div class="sect1" lang="en">
                   3900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3901: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91      rillig   3902: <div class="sect2" lang="en">
                   3903: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3904: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3905: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3906: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3907: </div>
                   3908: <div class="sect2" lang="en">
                   3909: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3910: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   3911: <p>KDE applications should always include
                   3912: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3913: settings that are typical of KDE packages.</p>
                   3914: </div>
                   3915: </div>
                   3916: <div class="sect1" lang="en">
                   3917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3918: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91      rillig   3919: <div class="sect2" lang="en">
                   3920: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3921: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91      rillig   3922: <div class="sect3" lang="en">
                   3923: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3924: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3925: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   3926: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   3927: pkgsrc. As the description says it has to do with the web, the obvious
                   3928: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   3929: <pre class="programlisting">
1.100     rillig   3930: <code class="prompt">$</code> mkdir www/nvu
                   3931: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3932: </pre>
                   3933: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3934: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3935: <pre class="programlisting">
1.100     rillig   3936: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3937: </pre>
                   3938: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3939: below the <code class="varname">DISTNAME</code> line, as the package name should
                   3940: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   3941: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3942: <code class="varname">COMMENT</code> fields. Then the package
                   3943: <code class="filename">Makefile</code> looked like that:</p>
                   3944: <pre class="programlisting">
1.100     rillig   3945: # $NetBSD$
                   3946: #
1.91      rillig   3947: 
1.100     rillig   3948: DISTNAME=       nvu-1.0-sources
                   3949: PKGNAME=        nvu-1.0
                   3950: CATEGORIES=     www
                   3951: MASTER_SITES=   http://cvs.nvu.com/download/
                   3952: EXTRACT_SUFX=   .tar.bz2
                   3953: 
                   3954: MAINTAINER=     rillig@NetBSD.org
                   3955: HOMEPAGE=       http://cvs.nvu.com/
                   3956: COMMENT=        Web Authoring System
1.91      rillig   3957: 
1.100     rillig   3958: # url2pkg-marker (please do not remove this line.)
                   3959: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3960: </pre>
                   3961: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3962: source archive:</p>
                   3963: <pre class="programlisting">
1.100     rillig   3964: url2pkg&gt; Running "make makesum" ...
                   3965: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3966: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3967: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3968: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3969: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3970: url2pkg&gt; Running "make extract" ...
                   3971: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3972: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3973: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3974: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3975: ===&gt; Installing dependencies for nvu-1.0
                   3976: ===&gt; Overriding tools for nvu-1.0
                   3977: ===&gt; Extracting for nvu-1.0
                   3978: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3979: 
1.100     rillig   3980: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3981: 
1.100     rillig   3982: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3983: </pre>
                   3984: </div>
                   3985: <div class="sect3" lang="en">
                   3986: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3987: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   3988: <p>Now that the package has been extracted, let's see what's inside
                   3989: it. The package has a <code class="filename">README.txt</code>, but that only
                   3990: says something about mozilla, so it's probably useless for seeing what
                   3991: dependencies this package has. But since there is a GNU configure script
                   3992: in the package, let's hope that it will complain about everything it
                   3993: needs.</p>
                   3994: <pre class="programlisting">
1.100     rillig   3995: <code class="prompt">$</code> bmake
                   3996: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3997: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3998: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3999: ===&gt; Patching for nvu-1.0
                   4000: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4001: ===&gt; Configuring for nvu-1.0
                   4002: [...]
                   4003: configure: error: Perl 5.004 or higher is required.
                   4004: [...]
                   4005: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4006: [...]
1.91      rillig   4007: </pre>
                   4008: <p>That worked quite well. So I opened the package Makefile in my
                   4009: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4010: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4011: package have changed now, and since a perl wrapper is automatically
                   4012: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4013: from scratch.</p>
                   4014: <pre class="programlisting">
1.100     rillig   4015: <code class="prompt">$</code> bmake clean
                   4016: ===&gt; Cleaning for nvu-1.0
                   4017: <code class="prompt">$</code> bmake
                   4018: [...]
                   4019: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4020: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4021: [...]
1.91      rillig   4022: </pre>
                   4023: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4024: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4025: <pre class="programlisting">
1.100     rillig   4026: [...]
                   4027: checking for GTK - version &gt;= 1.2.0... no
                   4028: *** Could not run GTK test program, checking why...
                   4029: [...]
1.91      rillig   4030: </pre>
                   4031: <p>Now to the other dependencies. The first question is: Where is the
                   4032: GTK package hidden in pkgsrc?</p>
                   4033: <pre class="programlisting">
1.100     rillig   4034: <code class="prompt">$</code> echo ../../*/gtk*
                   4035: [many packages ...]
                   4036: <code class="prompt">$</code> echo ../../*/gtk
                   4037: ../../x11/gtk
                   4038: <code class="prompt">$</code> echo ../../*/gtk2
                   4039: ../../x11/gtk2
                   4040: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4041: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4042: </pre>
                   4043: <p>The first try was definitely too broad. The second one had exactly
                   4044: one result, which is very good. But there is one pitfall with GNOME
                   4045: packages. Before GNOME 2 had been released, there were already many
                   4046: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4047: packages, the GNOME 2 packages were imported as separate packages, and
                   4048: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4049: whether this was the case here, and indeed it was.</p>
                   4050: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4051: file, adding the dependency is very easy. I just inserted an
                   4052: <code class="literal">.include</code> line before the last line of the package
                   4053: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4054: <pre class="programlisting">
1.100     rillig   4055: [...]
                   4056: .include "../../x11/gtk2/buildlink3.mk"
                   4057: .include "../../mk/bsd.pkg.mk
1.91      rillig   4058: </pre>
1.110     hubertf  4059: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4060: was:</p>
                   4061: <pre class="programlisting">
1.100     rillig   4062: [...]
                   4063: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4064: checking for GTK - version &gt;= 1.2.0... no
                   4065: *** Could not run GTK test program, checking why...
                   4066: *** The test program failed to compile or link. See the file config.log for the
                   4067: *** exact error that occured. This usually means GTK was incorrectly installed
                   4068: *** or that you have moved GTK since it was installed. In the latter case, you
                   4069: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4070: configure: error: Test for GTK failed.
                   4071: [...]
1.91      rillig   4072: </pre>
                   4073: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4074: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4075: told me that this package really wanted to have the GNOME 1 version of
                   4076: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4077: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4078: So I changed the <code class="literal">x11/gtk2</code> to
                   4079: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4080: and tried again.</p>
                   4081: <pre class="programlisting">
1.100     rillig   4082: [...]
                   4083: 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
                   4084: In file included from xpidl.c:42:
                   4085: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4086: In file included from xpidl.c:42:
                   4087: xpidl.h:132: error: parse error before "IDL_ns"
                   4088: [...]
1.91      rillig   4089: </pre>
                   4090: <p>The package still does not find all of its dependencies. Now the
                   4091: question is: Which package provides the
                   4092: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4093: <pre class="programlisting">
1.100     rillig   4094: <code class="prompt">$</code> echo ../../*/*idl*
                   4095: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4096: <code class="prompt">$</code> echo ../../*/*IDL*
                   4097: ../../net/libIDL
1.91      rillig   4098: </pre>
                   4099: <p>Let's take the one from the second try. So I included the
                   4100: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4101: again. But the error didn't change. After digging through some of the
                   4102: code, I concluded that the build process of the package was broken and
                   4103: couldn't have ever worked, but since the Mozilla source tree is quite
                   4104: large, I didn't want to fix it. So I added the following to the package
                   4105: <code class="filename">Makefile</code> and tried again:</p>
                   4106: <pre class="programlisting">
1.100     rillig   4107: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4108: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4109: </pre>
                   4110: <p>The latter line is needed because the package expects the library
                   4111: <code class="filename">libIDL.so</code>, but only
                   4112: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4113: wrapper to rewrite that on the fly.</p>
                   4114: <p>The next problem was related to a recent change of the FreeType
                   4115: 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>
                   4116: which patch files were relevant for this issue and copied them to the
                   4117: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4118: patches so that they applied cleanly and retried again. This time,
                   4119: everything worked.</p>
                   4120: </div>
                   4121: <div class="sect3" lang="en">
                   4122: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4123: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4124: <pre class="programlisting">
1.100     rillig   4125: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4126: [...]
                   4127: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4128: <code class="prompt">$</code> bmake deinstall
                   4129: <code class="prompt">$</code> bmake install
1.91      rillig   4130: </pre>
                   4131: </div>
                   4132: </div>
                   4133: </div>
1.77      rillig   4134: </div>
1.75      rillig   4135: <div class="chapter" lang="en">
                   4136: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4137: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4138: <div class="toc">
                   4139: <p><b>Table of Contents</b></p>
                   4140: <dl>
1.106     rillig   4141: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4142: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
                   4143: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4144: <dd><dl>
                   4145: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4146: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4147: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4148: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4149: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4150: </dl></dd>
                   4151: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4152: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4153: <dd><dl>
                   4154: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4155: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4156: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4157: </dl></dd>
1.106     rillig   4158: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4159: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4160: </dl>
                   4161: </div>
1.87      wiz      4162: <p>Whenever you're preparing a package, there are a number of
                   4163: files involved which are described in the following
                   4164: sections.</p>
1.75      rillig   4165: <div class="sect1" lang="en">
                   4166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4167: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4168: </h2></div></div></div>
1.75      rillig   4169: <p>Building, installation and creation of a binary package are all
1.87      wiz      4170:   controlled by the package's <code class="filename">Makefile</code>.
                   4171:   The <code class="filename">Makefile</code> describes various things about
                   4172:   a package, for example from where to get it, how to configure,
                   4173:   build, and install it.</p>
1.76      rillig   4174: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4175:   sections that describe the package.</p>
1.75      rillig   4176: <p>In the first section there are the following variables, which
1.87      wiz      4177:   should appear exactly in the order given here.  The order and
                   4178:   grouping of the variables is mostly historical and has no further
                   4179:   meaning.</p>
1.75      rillig   4180: <div class="itemizedlist"><ul type="disc">
                   4181: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4182:     distribution file to be downloaded from the package's
                   4183:     website.</p></li>
1.75      rillig   4184: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4185:     package, as used by pkgsrc. You only need to provide it if
                   4186:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4187:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4188:     directory name together with the version number. It must match the
                   4189:     regular expression
                   4190:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4191:     starts with a letter or digit, and contains only letters, digits,
                   4192:     dashes, underscores, dots and plus signs.</p></li>
                   4193: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4194:     the package file to create if the <code class="varname">PKGNAME</code>
                   4195:     isn't unique on a SVR4 system. The default is
                   4196:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4197:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87      wiz      4198:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4199:     does not produce an unique package name on a SVR4 system.
                   4200:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4201:     characters.</p></li>
1.75      rillig   4202: <li>
                   4203: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4204:     which the package fits in. You can choose any of the top-level
                   4205:     directories of pkgsrc for it.</p>
1.75      rillig   4206: <p>Currently the following values are available for
1.87      wiz      4207:     <code class="varname">CATEGORIES</code>. If more than
                   4208:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4209: <pre class="programlisting">
1.100     rillig   4210: archivers     cross         geography     meta-pkgs     security
                   4211: audio         databases     graphics      misc          shells
                   4212: benchmarks    devel         ham           multimedia    sysutils
                   4213: biology       editors       inputmethod   net           textproc
                   4214: cad           emulators     lang          news          time
                   4215: chat          finance       mail          parallel      wm
                   4216: comms         fonts         math          pkgtools      www
                   4217: converters    games         mbone         print         x11
                   4218: </pre>
1.75      rillig   4219: </li>
1.81      rillig   4220: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4221:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4222:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4223:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.110     hubertf  4224:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4225: </ul></div>
                   4226: <p>The second section contains information about separately
1.87      wiz      4227:   downloaded patches, if any.
                   4228:   </p>
1.75      rillig   4229: <div class="itemizedlist"><ul type="disc">
                   4230: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4231:     Name(s) of additional files that contain distribution patches.
                   4232:     There is no default. pkgsrc will look for them at
                   4233:     <code class="varname">PATCH_SITES</code>.
                   4234:     They will automatically be uncompressed before patching if
                   4235:     the names end with <code class="filename">.gz</code> or
                   4236:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4237: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4238:     Primary location(s) for distribution patch files (see
                   4239:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4240: </ul></div>
                   4241: <p>The third section contains the following variables.
1.87      wiz      4242:   </p>
1.75      rillig   4243: <div class="itemizedlist"><ul type="disc">
                   4244: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87      wiz      4245:     of the person who feels responsible for this package, and who is
                   4246:     most likely to look at problems or questions regarding this
1.110     hubertf  4247:     package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
1.87      wiz      4248:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4249:     making major changes to the package. When packaging a new program,
                   4250:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4251:     maintain the package for future updates, set it to
1.110     hubertf  4252:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.75      rillig   4253: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4254:     find more information about the package.</p></li>
1.75      rillig   4255: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4256:     description of the package (should not include the package
                   4257:     name).</p></li>
1.75      rillig   4258: </ul></div>
                   4259: <p>Other variables that affect the build:
1.87      wiz      4260:   </p>
1.75      rillig   4261: <div class="itemizedlist"><ul type="disc"><li>
                   4262: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4263:       interesting distribution files of the package are found. The
                   4264:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4265:       works for most packages.</p>
1.75      rillig   4266: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4267:       (most GNU software does, for instance), but extracts itself in
                   4268:       the current directory, you should set
                   4269:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4270: <p>If a package doesn't create a subdirectory with the
                   4271:       name of <code class="varname">DISTNAME</code> but some different name,
                   4272:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4273:       <code class="filename">${WRKDIR}</code>, for example
                   4274:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4275:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4276: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4277:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4278:       variable. By default, its value is
                   4279:       <code class="filename">work</code>. If you want to use the same
                   4280:       pkgsrc tree for building different kinds of binary packages,
                   4281:       you can change the variable according to your needs. Two
                   4282:       other variables handle common cases of setting
                   4283:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4284:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4285:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4286:       the host's name is attached to the directory name. If
                   4287:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4288:       is attached, which might look like
                   4289:       <code class="filename">work.i386</code> or
                   4290:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4291: </li></ul></div>
                   4292: <p>Please pay attention to the following gotchas:</p>
                   4293: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4294: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4295:       installed in compressed form by the package.  For packages using
                   4296:       BSD-style makefiles which honor MANZ, there is
                   4297:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4298: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4299:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4300:       below).</p></li>
1.110     hubertf  4301: <li><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4302: </ul></div>
                   4303: </div>
                   4304: <div class="sect1" lang="en">
                   4305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4306: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4307: </h2></div></div></div>
1.76      rillig   4308: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4309:   digest, or checksum, of each distfile needed for the package. This
                   4310:   ensures that the distfiles retrieved from the Internet have not been
                   4311:   corrupted during transfer or altered by a malign force to introduce
                   4312:   a security hole. Due to recent rumor about weaknesses of digest
                   4313:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4314:   message digests, as well as the file size.</p>
1.76      rillig   4315: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4316:   checksums for all the patches found in the
1.110     hubertf  4317:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4318: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4319:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4320:   command.</p>
1.75      rillig   4321: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4322:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87      wiz      4323:   <code class="filename">distinfo</code> file and care should be taken when
                   4324:   upgrading such a package to ensure distfile information is not
                   4325:   lost.</p>
1.75      rillig   4326: </div>
                   4327: <div class="sect1" lang="en">
                   4328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4329: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4330: <p>Many packages still don't work out-of-the box on the various
                   4331:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4332:   patch files are needed to make the package work. These patch files are
                   4333:   found in the <code class="filename">patches/</code> directory.</p>
                   4334: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4335:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4336:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93      rillig   4337:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4338:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4339: <div class="sect2" lang="en">
                   4340: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4341: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4342: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4343:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4344:   problems. (To force patches to apply with fuzz you can set
                   4345:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4346:   should contain only changes for a single file, and no file should be
1.93      rillig   4347:   patched by more than one patch file. This helps to keep future
                   4348:   modifications simple.</p>
                   4349: <p>Each patch file is structured as follows: In the first line,
                   4350:   there is the RCS Id of the patch itself. The second line should be
                   4351:   empty for aesthetic reasons. After that, there should be a comment for
                   4352:   each change that the patch does. There are a number of standard
                   4353:   cases:</p>
                   4354: <div class="itemizedlist"><ul type="disc">
                   4355: <li><p>Patches that replace the <code class="literal">==</code>
1.110     hubertf  4356:   operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111     rillig   4357:   are so common that they don't need a comment at all.</p></li>
1.93      rillig   4358: <li><p>Patches for commonly known vulnerabilities should
                   4359:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4360: <li><p>Patches that change source code should mention the
                   4361:   platform and other environment (for example, the compiler) that the
                   4362:   patch is needed for.</p></li>
                   4363: </ul></div>
                   4364: <p>In all other cases, the patch should be commented so that any
                   4365:   developer who knows the code of the application can make some use of
                   4366:   the patch. Special care should be taken for the upstream developers,
                   4367:   since we generally want that they accept our patches, so we have less
                   4368:   work in the future.</p>
                   4369: </div>
                   4370: <div class="sect2" lang="en">
                   4371: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4372: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4373: <p>One important thing to mention is to pay attention that no RCS
                   4374:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4375:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4376:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   4377:   problems.</p>
1.87      wiz      4378: <p>For even more automation, we recommend using
1.110     hubertf  4379:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4380:   whole set of patches. You just have to backup files before you
                   4381:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4382:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4383:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4384:   you upgrade a package this way, you can easily compare the new
                   4385:   set of patches with the previously existing one with
1.110     hubertf  4386:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87      wiz      4387:   or update from the <code class="filename">work/.newpatches</code>
                   4388:   directory to <code class="filename">patches/</code>.</p>
                   4389: <p>When you have finished a package, remember to generate
1.110     hubertf  4390:   the checksums for the patch files by using the <span class="command"><strong>make
                   4391:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      4392: <p>When adding a patch that corrects a problem in the
                   4393:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4394:   man pages should go), send the patch as a bug report to the
                   4395:   maintainer.  This benefits non-pkgsrc users of the package,
                   4396:   and usually makes it possible to remove the patch in future
                   4397:   version.</p>
1.101     rillig   4398: <p>The file names of the patch files are usually of the form
                   4399:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4400: </div>
                   4401: <div class="sect2" lang="en">
                   4402: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4403: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4404: <p>If you want to share patches between multiple packages
                   4405:   in pkgsrc, e.g. because they use the same distfiles, set
                   4406:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4407:   can be found, e.g.:</p>
                   4408: <pre class="programlisting">
1.100     rillig   4409: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4410: </pre>
1.75      rillig   4411: <p>Patch files that are distributed by the author or other
1.87      wiz      4412:     maintainers can be listed in
                   4413:     <code class="varname">PATCHFILES</code>.</p>
                   4414: <p>If it is desired to store any patches that should not be
                   4415:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4416:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4417:     directory tree there is expected to have the same
                   4418:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4419:     patches are expected to be stored inside these dirs (also
                   4420:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4421:     example, if you want to keep a private patch for
                   4422:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4423:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4424:     files in the named directory are expected to be patch files,
                   4425:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4426:     applied</em></span>.</p>
1.93      rillig   4427: </div>
1.85      jmmv     4428: <div class="sect2" lang="en">
                   4429: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4430: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4431: <p>When fixing a portability issue in the code do not use
                   4432:       preprocessor magic to check for the current operating system nor
                   4433:       platform.  Doing so hurts portability to other platforms because
                   4434:       the OS-specific details are not abstracted appropriately.</p>
                   4435: <p>The general rule to follow is: instead of checking for the
                   4436:       operating system the application is being built on, check for the
                   4437:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4438:       instead of assuming that kqueue is available under NetBSD and
                   4439:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.112     weinem   4440:       kqueue support, add a check that detects kqueue itself &#8212;
1.85      jmmv     4441:       yes, this generally involves patching the
1.110     hubertf  4442:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4443:       that prevents some OSes from adopting interfaces from other OSes
                   4444:       (e.g. Linux implementing kqueue), something that the above checks
                   4445:       cannot take into account.</p>
                   4446: <p>Of course, checking for features generally involves more
                   4447:       work on the developer's side, but the resulting changes are
1.87      wiz      4448:       cleaner and there are chances they will work on many other
1.85      jmmv     4449:       platforms.  Not to mention that there are higher chances of being
                   4450:       later integrated into the mainstream sources.  Remember:
                   4451:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4452: <p>Some typical examples:</p>
                   4453: <div class="table">
1.106     rillig   4454: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4455: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4456: <colgroup>
                   4457: <col>
                   4458: <col>
                   4459: <col>
                   4460: </colgroup>
                   4461: <thead><tr>
                   4462: <th>Where</th>
                   4463: <th>Incorrect</th>
                   4464: <th>Correct</th>
                   4465: </tr></thead>
                   4466: <tbody>
                   4467: <tr>
                   4468: <td>configure script</td>
                   4469: <td>
1.100     rillig   4470: <pre class="programlisting">
                   4471: case ${target_os} in
                   4472: netbsd*) have_kvm=yes ;;
                   4473: *)       have_kvm=no  ;;
                   4474: esac
                   4475: </pre>
1.85      jmmv     4476:              </td>
                   4477: <td>
1.100     rillig   4478: <pre class="programlisting">
                   4479: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4480: </pre>
1.85      jmmv     4481:              </td>
                   4482: </tr>
                   4483: <tr>
                   4484: <td>C source file</td>
                   4485: <td>
1.100     rillig   4486: <pre class="programlisting">
                   4487: #if defined(__NetBSD__)
                   4488: #  include &lt;sys/event.h&gt;
                   4489: #endif
                   4490: </pre>
1.85      jmmv     4491:              </td>
                   4492: <td>
1.100     rillig   4493: <pre class="programlisting">
                   4494: #if defined(HAVE_SYS_EVENT_H)
                   4495: #  include &lt;sys/event.h&gt;
                   4496: #endif
                   4497: </pre>
1.85      jmmv     4498:              </td>
                   4499: </tr>
                   4500: <tr>
                   4501: <td>C source file</td>
                   4502: <td>
1.100     rillig   4503: <pre class="programlisting">
                   4504: int
                   4505: monitor_file(...)
                   4506: {
                   4507: #if defined(__NetBSD__)
                   4508:         int fd = kqueue();
                   4509:         ...
                   4510: #else
                   4511:         ...
                   4512: #endif
                   4513: }
                   4514: </pre>
1.85      jmmv     4515:              </td>
                   4516: <td>
1.100     rillig   4517: <pre class="programlisting">
                   4518: int
                   4519: monitor_file(...)
                   4520: {
                   4521: #if defined(HAVE_KQUEUE)
                   4522:         int fd = kqueue();
                   4523:         ...
                   4524: #else
                   4525:        ...
                   4526: #endif
                   4527: }
                   4528: </pre>
1.85      jmmv     4529:              </td>
                   4530: </tr>
                   4531: </tbody>
1.91      rillig   4532: </table></div>
1.85      jmmv     4533: </div>
1.91      rillig   4534: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4535:       packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4536:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4537:       2</a>).  It summarizes multiple details on how to make
                   4538:       software easier to package; all the suggestions in it were
                   4539:       collected from our experience in pkgsrc work, so they are possibly
                   4540:       helpful when creating patches too.</p>
                   4541: </div>
                   4542: <div class="sect2" lang="en">
                   4543: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4544: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4545: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4546:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4547:       improvements you do to a package to the mainstream developers.
                   4548:       This is the only way to get their attention on portability issues
                   4549:       and to ensure that future versions can be built out-of-the box on
                   4550:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4551:       the fixes straight from the packaged code.</p>
1.93      rillig   4552: <p>This generally involves cleaning up the patches
                   4553:       (because sometimes the patches that are
1.85      jmmv     4554:       added to pkgsrc are quick hacks), filling bug reports in the
                   4555:       appropriate trackers for the projects and working with the
                   4556:       mainstream authors to accept your changes.  It is
                   4557:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4558:       the packages in pkgsrc are kept simple and thus further changes
                   4559:       can be done without much hassle.</p>
                   4560: <p>Support the idea of free software!</p>
                   4561: </div>
1.75      rillig   4562: </div>
                   4563: <div class="sect1" lang="en">
                   4564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4565: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4566: <div class="variablelist"><dl>
1.76      rillig   4567: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4568: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4569:          any credits where they are due.  Please bear in mind that others do not
                   4570:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4571:          will read everything that you write here.</p></dd>
1.76      rillig   4572: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4573: <dd><p>This file governs the files that are installed on your
                   4574:          system: all the binaries, manual pages, etc. There are other
                   4575:          directives which may be entered in this file, to control the
                   4576:          creation and deletion of directories, and the location of
1.110     hubertf  4577:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4578:          information.</p></dd>
1.75      rillig   4579: </dl></div>
                   4580: </div>
                   4581: <div class="sect1" lang="en">
                   4582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4583: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78      rillig   4584: <div class="sect2" lang="en">
                   4585: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4586: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4587: <div class="variablelist"><dl>
1.76      rillig   4588: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110     hubertf  4589: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4590:            First time after package extraction and before files are
                   4591:            moved in place, the second time after the files to install
                   4592:            are moved in place. This can be used to do any custom
                   4593:            procedures not possible with @exec commands in
1.110     hubertf  4594:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4595:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.76      rillig   4596: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4597: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4598:            this script's responsibility to clean up any additional messy details
                   4599:            around the package's installation, since all pkg_delete knows is how to
                   4600:            delete the files created in the original distribution.
1.110     hubertf  4601:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4602:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76      rillig   4603: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4604: <dd>
                   4605: <p>This file is displayed after installation of the package.
1.87      wiz      4606:            Useful for things like legal notices on almost-free
                   4607:            software and hints for updating config files after
                   4608:            installing modules for apache, PHP etc.
                   4609:            Please note that you can modify variables in it easily by using
                   4610:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4611:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4612: <pre class="programlisting">
1.100     rillig   4613: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4614: </pre>
1.75      rillig   4615: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4616:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4617:            performed for <code class="varname">PKGNAME</code>,
                   4618:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4619:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4620:            <code class="varname">X11BASE</code>,
                   4621:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4622:            <code class="varname">ROOT_GROUP</code>, and
                   4623:            <code class="varname">ROOT_GROUP</code>.</p>
                   4624: <p>You can display a different or additional files by
                   4625:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4626:            default is <code class="filename">MESSAGE</code>, if the file
                   4627:            exists.</p>
1.75      rillig   4628: </dd>
1.78      rillig   4629: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4630: <dd><p>FIXME: There is no documentation on the
                   4631:        alternatives framework.</p></dd>
                   4632: </dl></div>
                   4633: </div>
                   4634: <div class="sect2" lang="en">
                   4635: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4636: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4637: <div class="variablelist"><dl>
                   4638: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4639: <dd><p>This file contains arbitrary things that could
                   4640:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4641:        to be used by more than one package. This file should only be
                   4642:        used when the packages that will use the file are known in
                   4643:        advance. For other purposes it is often better to write a
                   4644:        <code class="filename">*.mk</code> file and give it a good name that
                   4645:        describes what it does.</p></dd>
                   4646: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4647: <dd><p>This file contains the dependency information
1.110     hubertf  4648:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4649: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4650: <dd><p>This file contains workarounds for compiler bugs
                   4651:        and similar things. It is included automatically by the pkgsrc
                   4652:        infrastructure, so you don't need an extra
                   4653:        <code class="literal">.include</code> line for
                   4654:        it.</p></dd>
                   4655: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4656: <dd><p>This file contains the code for the
1.110     hubertf  4657:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78      rillig   4658:        selected by the user. If a package has only one or two options,
                   4659:        it is equally acceptable to put the code directly into the
                   4660:        <code class="filename">Makefile</code>.</p></dd>
                   4661: </dl></div>
                   4662: </div>
                   4663: <div class="sect2" lang="en">
                   4664: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4665: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4666: <div class="variablelist"><dl>
                   4667: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4668: <dd><p>These files do not take place in the creation of
                   4669:        a package and thus are purely informative to the package
                   4670:        developer.</p></dd>
                   4671: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4672: <dd><p>This file contains things that need to be done
                   4673:        to make the package even
                   4674:        better.</p></dd>
1.75      rillig   4675: </dl></div>
                   4676: </div>
1.78      rillig   4677: </div>
1.75      rillig   4678: <div class="sect1" lang="en">
                   4679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4680: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4681: </h2></div></div></div>
1.110     hubertf  4682: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4683:     unpacked into the directory denoted by
                   4684:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4685:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4686:     directory is also used to keep various timestamp files.
                   4687:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4688:     The default is <code class="filename">${.CURDIR}/work</code>
                   4689:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4690:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4691: </div>
                   4692: <div class="sect1" lang="en">
                   4693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4694: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4695: </h2></div></div></div>
1.75      rillig   4696: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4697:     to configuration or building, you could place these files here and use
1.110     hubertf  4698:     a <span class="command"><strong>${CP}</strong></span> command in the
1.87      wiz      4699:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4700:     this. Alternatively, you could simply diff the file against
                   4701:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4702:     the creation of this file.</p>
                   4703: <p>If you want to share files in this way with other
                   4704:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4705:     to the other package's <code class="filename">files</code> directory,
                   4706:     e.g.:</p>
                   4707: <pre class="programlisting">
1.100     rillig   4708: FILESDIR=${.CURDIR}/../xemacs/files
                   4709: </pre>
1.75      rillig   4710: </div>
                   4711: </div>
                   4712: <div class="chapter" lang="en">
                   4713: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4714: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4715: <div class="toc">
                   4716: <p><b>Table of Contents</b></p>
                   4717: <dl>
1.106     rillig   4718: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
                   4719: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4720: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4721: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4722: <dd><dl>
                   4723: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4724: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4725: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4726: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4727: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4728: </dl></dd>
                   4729: </dl>
                   4730: </div>
1.76      rillig   4731: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4732:   each of which forms a well-defined part of the pkgsrc system. Using
1.110     hubertf  4733:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4734:   like pkgsrc requires some discipline to keep the code correct and
                   4735:   understandable.</p>
1.76      rillig   4736: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4737:   programming are variables (which are actually macros) and shell
                   4738:   commands. Among these shell commands may even be more complex ones
1.110     hubertf  4739:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4740:   as intended it is necessary to quote all variables correctly when they
                   4741:   are used.</p>
                   4742: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4743:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4744:   with them.</p>
                   4745: <div class="sect1" lang="en">
                   4746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4747: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97      rillig   4748: <div class="itemizedlist"><ul type="disc"><li>
                   4749: <p>When you are creating a file as a
                   4750:     target of a rule, always write the data to a temporary file first
                   4751:     and finally rename that file. Otherwise there might occur an error
                   4752:     in the middle of generating the file, and when the user runs
1.110     hubertf  4753:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4754:     regenerated properly. Example:</p>
                   4755: <pre class="programlisting">
1.100     rillig   4756: wrong:
                   4757:         @echo "line 1" &gt; ${.TARGET}
                   4758:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4759:         @false
                   4760: 
                   4761: correct:
                   4762:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4763:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4764:         @false
                   4765:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4766: </pre>
1.110     hubertf  4767: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4768:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4769:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4770:     correct</strong></span> gives an error message twice, as expected.</p>
1.110     hubertf  4771: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4772:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4773:     happens when it is interrupted, for example by pressing
                   4774:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110     hubertf  4775:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4776: </li></ul></div>
                   4777: </div>
                   4778: <div class="sect1" lang="en">
                   4779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4780: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4781: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4782:     can be processed using the five operators ``='', ``+='', ``?='',
1.110     hubertf  4783:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4784:     page.</p>
                   4785: <p>When a variable's value is parsed from a
1.76      rillig   4786:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4787:     backslash character ``\'' are handled specially. If a backslash is
                   4788:     followed by a newline, any whitespace immediately in front of the
                   4789:     backslash, the backslash, the newline, and any whitespace
                   4790:     immediately behind the newline are replaced with a single space. A
                   4791:     backslash character and an immediately following hash character are
                   4792:     replaced with a single hash character. Otherwise, the backslash is
                   4793:     passed as is. In a variable assignment, any hash character that is
                   4794:     not preceded by a backslash starts a comment that continues upto the
                   4795:     end of the logical line.</p>
                   4796: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4797:     the only way to create a variable consisting of a single backslash
                   4798:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4799: <p>So far for defining variables. The other thing you can do with
                   4800:     variables is evaluating them. A variable is evaluated when it is
                   4801:     part of the right side of the ``:='' or the ``!='' operator, or
                   4802:     directly before executing a shell command which the variable is part
1.110     hubertf  4803:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   4804:     is, variables are not evaluated until there's no other way. The
                   4805:     ``modifiers'' mentioned in the man page also evaluate the
                   4806:     variable.</p>
                   4807: <p>Some of the modifiers split the string into words and then
                   4808:     operate on the words, others operate on the string as a whole. When
                   4809:     a string is split into words, it is split as you would expect
1.110     hubertf  4810:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.112     weinem   4811: <p>No rule without exception&#8212;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4812:     loop does not follow the shell quoting rules but splits at sequences
                   4813:     of whitespace.</p>
                   4814: <p>There are several types of variables that should be handled
                   4815:     differently. Strings and two types of lists.</p>
                   4816: <div class="itemizedlist"><ul type="disc">
                   4817: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4818:       characters. Nevertheless, you should restrict yourself to only
                   4819:       using printable characters. Examples are
                   4820:       <code class="varname">PREFIX</code> and
                   4821:       <code class="varname">COMMENT</code>.</p></li>
                   4822: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4823:       are never exported to any shell command. Their elements are
                   4824:       separated by whitespace. Therefore, the elements themselves cannot
                   4825:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4826:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4827:       Examples are <code class="varname">DEPENDS</code> and
                   4828:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4829: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4830:       may be exported to a shell command. Their elements can contain any
                   4831:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4832:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4833:       <code class="varname">DISTFILES</code> and
                   4834:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4835: </ul></div>
                   4836: <div class="sect2" lang="en">
                   4837: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4838: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4839: <div class="itemizedlist"><ul type="disc">
                   4840: <li><p>All variable names starting with an underscore
                   4841:        are reserved for use by the pkgsrc infrastructure. They shall
                   4842:        not be used by package
1.76      rillig   4843:        <code class="filename">Makefile</code>s.</p></li>
1.110     hubertf  4844: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4845:        lowercase variable names for the iteration
                   4846:        variables.</p></li>
                   4847: <li><p>All list variables should have a ``plural''
                   4848:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4849:        <code class="varname">DISTFILES</code>.</p></li>
                   4850: </ul></div>
                   4851: </div>
                   4852: </div>
                   4853: <div class="sect1" lang="en">
                   4854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4855: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   4856: <p>This section presents you with some code snippets you should
                   4857:     use in your own code. If you don't find anything appropriate here,
                   4858:     you should test your code and add it here.</p>
                   4859: <div class="sect2" lang="en">
                   4860: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4861: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4862: <pre class="programlisting">
1.100     rillig   4863: STRING=                 foo * bar `date`
                   4864: INT_LIST=               # empty
                   4865: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4866: EXT_LIST=               # empty
                   4867: ANOTHER_EXT_LIST=       a=b c=d
                   4868: 
                   4869: INT_LIST+=              ${STRING}               # 1
                   4870: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4871: EXT_LIST+=              ${STRING:Q}             # 3
                   4872: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4873: </pre>
1.75      rillig   4874: <p>When you add a string to an external list (example 3), it
                   4875:       must be quoted. In all other cases, you must not add a quoting
                   4876:       level. You must not merge internal and external lists, unless you
                   4877:       are sure that all entries are correctly interpreted in both
                   4878:       lists.</p>
                   4879: </div>
                   4880: <div class="sect2" lang="en">
                   4881: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4882: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   4883: <pre class="programlisting">
1.100     rillig   4884: EXT_LIST=       # empty
                   4885: .for i in ${INT_LIST}
                   4886: EXT_LIST+=      ${i:Q}""
                   4887: .endfor
1.1       grant    4888: </pre>
1.75      rillig   4889: <p>This code converts the internal list
                   4890:       <code class="varname">INT_LIST</code> into the external list
                   4891:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4892:       are unquoted they must be quoted here. The reason for appending
                   4893:       <code class="varname">""</code> is explained below.</p>
                   4894: </div>
                   4895: <div class="sect2" lang="en">
                   4896: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4897: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4898: <p>Sometimes you may want to print an arbitrary string. There
                   4899:        are many ways to get it wrong and only few that can handle every
                   4900:        nastiness.</p>
1.75      rillig   4901: <pre class="programlisting">
1.100     rillig   4902: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4903: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    4904: 
1.100     rillig   4905: all:
                   4906:         echo ${STRING}                  # 1
                   4907:         echo "${STRING}"                # 2
                   4908:         echo "${STRING:Q}"              # 3
                   4909:         echo ${STRING:Q}                # 4
                   4910:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   4911:         printf "%s\\n" ${STRING:Q}""    # 6
                   4912:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    4913: </pre>
1.75      rillig   4914: <p>Example 1 leads to a syntax error in the shell, as the
                   4915:       characters are just copied.</p>
                   4916: <p>Example 2 leads to a syntax error too, and if you leave out
                   4917:       the last " character from <code class="varname">${STRING}</code>,
1.110     hubertf  4918:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   4919:       variable would be evaluated, too.</p>
                   4920: <p>Example 3 outputs each space character preceded by a
                   4921:       backslash (or not), depending on the implementation of the
1.110     hubertf  4922:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   4923: <p>Example 4 handles correctly every string that does not start
                   4924:       with a dash. In that case, the result depends on the
1.110     hubertf  4925:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   4926:       guarantee that your input does not start with a dash, this form is
                   4927:       appropriate.</p>
                   4928: <p>Example 5 handles even the case of a leading dash
                   4929:       correctly.</p>
1.79      rillig   4930: <p>Example 6 also works with every string and is the
                   4931:       light-weight solution, since it does not involve a pipe, which has
                   4932:       its own problems.</p>
1.75      rillig   4933: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   4934:       because the quoting has already been done when adding elements to
                   4935:       the list.</p>
                   4936: <p>As internal lists shall not be passed to the shell, there is
                   4937:       no example for it.</p>
                   4938: </div>
                   4939: <div class="sect2" lang="en">
                   4940: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4941: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   4942: <p>There are many possible sources of wrongly quoted variables.
                   4943:       This section lists some of the commonly known ones.</p>
                   4944: <div class="itemizedlist"><ul type="disc">
                   4945: <li>
                   4946: <p>Whenever you use the value of a list, think
                   4947:        about what happens to leading or trailing whitespace. If the
                   4948:        list is a well-formed shell expression, you can apply the
                   4949:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   4950:        whitespace from each word. The <code class="varname">:M</code> operator
                   4951:        first splits its argument according to the rules of the shell,
                   4952:        and then creates a new list consisting of all words that match
                   4953:        the shell glob expression <code class="varname">*</code>, that is: all.
                   4954:        One class of situations where this is needed is when adding a
                   4955:        variable like <code class="varname">CPPFLAGS</code> to
                   4956:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   4957:        invokes other configure scripts, it strips the leading and
                   4958:        trailing whitespace from the variable and then passes it to the
                   4959:        other configure scripts. But these configure scripts expect the
                   4960:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   4961:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   4962:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   4963:        here is how we do it:</p>
                   4964: <pre class="programlisting">
1.100     rillig   4965: CPPFLAGS=               # empty
                   4966: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   4967: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4968: 
                   4969: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4970: 
                   4971: all:
                   4972:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4973:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    4974: </pre>
1.75      rillig   4975: </li>
                   4976: <li><p>The example above contains one bug: The
                   4977:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   4978:        expression, but there is the C compiler after it, which also
                   4979:        expects a properly quoted string (this time in C syntax). The
                   4980:        version above is therefore only correct if
                   4981:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   4982:        or double quotes. If you want to allow these, you have to add
                   4983:        another layer of quoting to each variable that is used as a C
                   4984:        string literal. You cannot use the <code class="varname">:Q</code>
                   4985:        operator for it, as this operator only works for the
                   4986:        shell.</p></li>
                   4987: <li>
                   4988: <p>Whenever a variable can be empty, the
                   4989:        <code class="varname">:Q</code> operator can have surprising results. Here
                   4990:        are two completely different cases which can be solved with the
                   4991:        same trick.</p>
                   4992: <pre class="programlisting">
1.100     rillig   4993: EMPTY=                  # empty
                   4994: empty_test:
                   4995:         for i in a ${EMPTY:Q} c; do \
                   4996:             echo "$$i"; \
                   4997:         done
                   4998: 
                   4999: for_test:
                   5000: .for i in a:\ a:\test.txt
                   5001:         echo ${i:Q}
                   5002:         echo "foo"
                   5003: .endfor
1.1       grant    5004: </pre>
1.75      rillig   5005: <p>The first example will only print two of the three lines
                   5006:        we might have expected. This is because
                   5007:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5008:        the shell cannot see. The workaround is to write
                   5009:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5010:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5011:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5012: <p>The second example will only print three lines instead of
                   5013:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5014:        This is because the backslash of the value
                   5015:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110     hubertf  5016:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5017:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   5018:        <code class="varname">${i:Q}""</code>.</p>
                   5019: </li>
                   5020: </ul></div>
                   5021: </div>
                   5022: <div class="sect2" lang="en">
                   5023: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5024: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5025: <p>The pkgsrc bmake program does not handle the following
                   5026:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5027:       contains a ``-'' character, one of the closing braces is included
                   5028:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5029: <pre class="programlisting">
1.100     rillig   5030: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5031: </pre>
1.75      rillig   5032: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5033:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75      rillig   5034:       <code class="varname">bug1</code>.</p>
                   5035: </div>
                   5036: </div>
                   5037: </div>
                   5038: <div class="chapter" lang="en">
                   5039: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5040: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5041: <div class="toc">
                   5042: <p><b>Table of Contents</b></p>
                   5043: <dl>
1.106     rillig   5044: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
                   5045: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.110     hubertf  5046: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106     rillig   5047: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5048: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
                   5049: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5050: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5051: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5052: </dl>
                   5053: </div>
1.87      wiz      5054: <p>The <code class="filename">PLIST</code> file contains a package's
                   5055:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5056:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5057:   directory it's been installed in) plus some additional statements
1.110     hubertf  5058:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      5059:   This chapter addresses some issues that need attention when
                   5060:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5061:   below!).</p>
1.75      rillig   5062: <div class="sect1" lang="en">
                   5063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5064: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5065: <p>Be sure to add a RCS ID line as the first thing in any
                   5066:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5067: <pre class="programlisting">
1.100     rillig   5068: @comment $NetBSD$
1.87      wiz      5069:     </pre>
1.75      rillig   5070: </div>
                   5071: <div class="sect1" lang="en">
                   5072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5073: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5074: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5075:     to output a PLIST that matches any new files since the package
1.110     hubertf  5076:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      5077:     more information on this target.</p>
1.75      rillig   5078: </div>
                   5079: <div class="sect1" lang="en">
                   5080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5081: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5082: </h2></div></div></div>
1.87      wiz      5083: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5084:     <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
                   5085:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5086:     <code class="varname">@comment</code>s instead of real
                   5087:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5088:     specific directories and files, so that the results of that
                   5089:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5090:     lot</em></span> during the update of packages.</p>
                   5091: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5092:     of AWK patterns and actions that are used to filter the output of
                   5093:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5094:     scripting you like to it, but be careful with quoting.</p>
                   5095: <p>For example, to get all files inside the
                   5096:     <code class="filename">libdata/foo</code> directory removed from the
                   5097:     resulting PLIST:</p>
                   5098: <pre class="programlisting">
1.100     rillig   5099: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5100:     </pre>
                   5101: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5102:     to a specific (shared) directory converted to
                   5103:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5104: <pre class="programlisting">
1.100     rillig   5105: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5106:     </pre>
1.75      rillig   5107: </div>
                   5108: <div class="sect1" lang="en">
                   5109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5110: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5111: <p>A number of variables are substituted automatically in
                   5112:     PLISTs when a package is installed on a system. This includes the
                   5113:     following variables:</p>
1.75      rillig   5114: <div class="variablelist"><dl>
                   5115: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5116: <dd>
                   5117: <p>Some packages like emacs and perl embed information
1.87      wiz      5118:          about which architecture they were built on into the
                   5119:          pathnames where they install their files. To handle this
                   5120:          case, PLIST will be preprocessed before actually used, and
                   5121:          the symbol
                   5122:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.110     hubertf  5123:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5124:          same is done if the string
                   5125:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5126:          PLIST somewhere - use this on packages that have GNU
                   5127:          autoconf-created configure scripts.</p>
1.75      rillig   5128: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5129: <h3 class="title">Legacy note</h3>
                   5130: <p>There used to be a symbol
1.87      wiz      5131:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.110     hubertf  5132:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5133:            -m</strong></span>, but that's no longer supported and has
                   5134:            been removed.</p>
1.75      rillig   5135: </div>
                   5136: </dd>
                   5137: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5138: <dd>
                   5139: <p>Some packages want to embed the OS name and version
1.87      wiz      5140:          into some paths.  To do this, use these variables in the
                   5141:          <code class="filename">PLIST</code>:
                   5142:          </p>
1.75      rillig   5143: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  5144: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</p></li>
1.75      rillig   5145: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.110     hubertf  5146: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</p></li>
1.75      rillig   5147: </ul></div>
                   5148: </dd>
                   5149: </dl></div>
1.87      wiz      5150: <p>For a complete list of values which are replaced by
                   5151:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5152:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5153: <p>If you want to change other variables not listed above, you
                   5154:     can add variables and their expansions to this variable in the
1.110     hubertf  5155:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   5156: <pre class="programlisting">
1.100     rillig   5157: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5158:     </pre>
1.75      rillig   5159: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5160:     in the <code class="filename">PLIST</code> with
                   5161:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5162: </div>
                   5163: <div class="sect1" lang="en">
                   5164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5165: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5166: <p>Man pages should be installed in compressed form if
1.87      wiz      5167:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5168:     and uncompressed otherwise. To handle this in the
                   5169:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5170:     appended/removed automatically for man pages according to
                   5171:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5172:     or not, see above for details. This modification of the
                   5173:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5174:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5175: </div>
                   5176: <div class="sect1" lang="en">
                   5177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5178: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5179: </h2></div></div></div>
1.76      rillig   5180: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5181:     in generating the binary package, set the variable
                   5182:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110     hubertf  5183:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5184:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5185:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5186: </div>
                   5187: <div class="sect1" lang="en">
                   5188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5189: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5190: <p>Some packages decide to install a different set of files based on
1.87      wiz      5191:     the operating system being used. These differences can be
                   5192:     automatically handled by using the following files:</p>
1.75      rillig   5193: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5194: <li><p><code class="filename">PLIST.common</code></p></li>
                   5195: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5196: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5197: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5198: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5199: </ul></div>
                   5200: </div>
                   5201: <div class="sect1" lang="en">
                   5202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5203: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5204: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5205:     multiple (and unrelated) packages install files.  These
                   5206:     directories are problematic because you have to add special tricks
                   5207:     in the PLIST to conditionally remove them, or have some
                   5208:     centralized package handle them.</p>
                   5209: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5210:     is shared by a few unrelated packages, it's often not worth to add
                   5211:     an extra package to remove it.  Therefore, one simply does:</p>
                   5212: <pre class="programlisting">
1.100     rillig   5213: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5214:     </pre>
                   5215: <p>in the PLISTs of all affected packages, instead of the
                   5216:     regular "@dirrm" line.</p>
                   5217: <p>However, if the directory is shared across many packages, two
                   5218:     different solutions are available:</p>
1.75      rillig   5219: <div class="orderedlist"><ol type="1">
1.87      wiz      5220: <li><p>If the packages have a common dependency, the directory
                   5221:        can be removed in that.  For example, see
1.91      rillig   5222:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87      wiz      5223:        removes the shared directory
                   5224:        <code class="filename">share/omf</code>.</p></li>
                   5225: <li><p>If the packages using the directory are not related at
                   5226:        all (they have no common dependencies), a *-dirs package is
                   5227:        used.</p></li>
1.75      rillig   5228: </ol></div>
1.87      wiz      5229: <p>From now on, we'll discuss the second solution.  To get an
                   5230:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5231: <pre class="programlisting">
1.100     rillig   5232: <code class="prompt">%</code> cd .../pkgsrc
                   5233: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5234:     </pre>
                   5235: <p>Their use from other packages is very simple.  The
                   5236:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5237:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5238:     version number (always pick the latest one when writing new
                   5239:     packages).</p>
                   5240: <p>For example, if a package installs files under
                   5241:     <code class="filename">share/applications</code>, it should have the
                   5242:     following line in it:</p>
                   5243: <pre class="programlisting">
1.100     rillig   5244: USE_DIRS+=      xdg-1.1
1.87      wiz      5245:     </pre>
1.110     hubertf  5246: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87      wiz      5247:     print-PLIST</strong></span>, you should get the right (commented out)
                   5248:     lines.</p>
                   5249: <p>Note that even if your package is using
                   5250:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5251:     *-x11-dirs packages.  Just specify the name without that part and
                   5252:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5253:     care of it.</p>
1.75      rillig   5254: </div>
                   5255: </div>
                   5256: <div class="chapter" lang="en">
                   5257: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5258: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5259: <div class="toc">
                   5260: <p><b>Table of Contents</b></p>
                   5261: <dl>
1.106     rillig   5262: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
                   5263: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5264: <dd><dl>
1.106     rillig   5265: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5266: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5267: </dl></dd>
1.106     rillig   5268: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5269: <dd><dl>
1.106     rillig   5270: <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>
                   5271: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5272: </dl></dd>
                   5273: </dl>
                   5274: </div>
                   5275: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5276:   are seen by a package's configure and build processes.  This is implemented
                   5277:   in a two step process:</p>
1.75      rillig   5278: <div class="orderedlist"><ol type="1">
                   5279: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5280:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5281:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5282: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5283:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5284:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5285:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5286:       native compiler on some operating systems look like GCC, so that
                   5287:       packages that expect GCC won't require modifications to build with
                   5288:       those native compilers.</p></li>
1.75      rillig   5289: </ol></div>
                   5290: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5291:   package may be built consistently despite what other software may be
                   5292:   installed. Please note that the normal system header and library paths,
                   5293:   e.g. <code class="filename">/usr/include</code>,
                   5294:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5295:   designed to insulate the package build from non-system-supplied
                   5296:   software.</p>
1.75      rillig   5297: <div class="sect1" lang="en">
                   5298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5299: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5300: <p>The process of converting packages to use the buildlink3
1.87      wiz      5301:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5302:     The things to keep in mind are:</p>
1.75      rillig   5303: <div class="orderedlist"><ol type="1">
1.87      wiz      5304: <li><p>Ensure that the build always calls the wrapper scripts
                   5305:        instead of the actual toolchain.  Some packages are tricky,
                   5306:        and the only way to know for sure is the check
                   5307:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5308:        wrappers are being invoked.</p></li>
                   5309: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5310:        the package Makefile, e.g. Java VMs, standalone shells,
                   5311:        etc., because the code to symlink files into
                   5312:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5313:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5314:        </p></li>
                   5315: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5316:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5317:        package's Makefile are added as dependencies for that package.
                   5318:        </p></li>
1.75      rillig   5319: </ol></div>
1.87      wiz      5320: <p>If a dependency on a particular package is required for its libraries and
                   5321:     headers, then we replace:</p>
1.75      rillig   5322: <pre class="programlisting">
1.100     rillig   5323: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5324: </pre>
1.75      rillig   5325: <p>with</p>
                   5326: <pre class="programlisting">
1.100     rillig   5327: .include "../../category/foo/buildlink3.mk"
                   5328: </pre>
1.75      rillig   5329: <p>The buildlink3.mk files usually define the required dependencies.
                   5330:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5331:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5332: <pre class="programlisting">
1.100     rillig   5333: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5334: .include "../../category/foo/buildlink3.mk"
                   5335: </pre>
1.76      rillig   5336: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5337:     files in <code class="filename">pkgsrc/mk</code>
                   5338:     that handle special package issues:</p>
1.75      rillig   5339: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5340: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5341:        the native or a pkgsrc Berkeley DB implementation based on
                   5342:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5343:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5344: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5345:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5346:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76      rillig   5347: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5348:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5349:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5350:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5351: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5352:        system-provided Motif installation or adds a dependency on
1.91      rillig   5353:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.88      wiz      5354:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5355:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5356:        which Motif version will be used.</p></li>
1.76      rillig   5357: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5358:        variables that may be used by packages that use the
                   5359:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5360: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5361:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5362:        the file for more information.</p></li>
1.76      rillig   5363: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5364:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5365:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76      rillig   5366: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5367:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5368:        library.</p></li>
1.75      rillig   5369: </ul></div>
1.76      rillig   5370: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5371:     files provide a more complete
                   5372:     description of how to use them properly.</p>
1.75      rillig   5373: </div>
                   5374: <div class="sect1" lang="en">
                   5375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5376: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5377: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5378:     included by Makefiles to indicate the need to compile and link
                   5379:     against header files and libraries provided by the package.  A
                   5380:     <code class="filename">buildlink3.mk</code> file should always provide
                   5381:     enough information to add the correct type of dependency
                   5382:     relationship and include any other
                   5383:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5384:     headers and libraries that it needs in turn.</p>
                   5385: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5386:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5387:     package is highly recommended.  For most packages, the following
                   5388:     command will generate a good starting point for
                   5389:     <code class="filename">buildlink3.mk</code> files:</p>
                   5390: <pre class="screen">
                   5391: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5392: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5393:     </pre>
1.75      rillig   5394: <div class="sect2" lang="en">
                   5395: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5396: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5397: <p>The following real-life example
1.87      wiz      5398:       <code class="filename">buildlink3.mk</code> is taken
                   5399:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5400: <pre class="programlisting">
1.100     rillig   5401: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5402: 
1.100     rillig   5403: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5404: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5405: 
1.100     rillig   5406: .if ${BUILDLINK_DEPTH} == "+"
                   5407: BUILDLINK_DEPENDS+=     tiff
                   5408: .endif
1.87      wiz      5409: 
1.100     rillig   5410: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5411: BUILDLINK_PACKAGES+=    tiff
1.87      wiz      5412: 
1.100     rillig   5413: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5414: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5415: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5416: .endif  # TIFF_BUILDLINK3_MK
1.87      wiz      5417: 
1.100     rillig   5418: .include "../../devel/zlib/buildlink3.mk"
                   5419: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      5420: 
1.100     rillig   5421: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5422: </pre>
1.87      wiz      5423: <p>The header and footer manipulate
                   5424:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5425:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5426:       at what depth we are including
                   5427:       <code class="filename">buildlink3.mk</code> files.</p>
                   5428: <p>The first section controls if the dependency on
                   5429:       <em class="replaceable"><code>pkg</code></em> is added.
                   5430:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5431:       packages for which dependencies are added by
                   5432:       buildlink3.</p>
                   5433: <p>The second section advises pkgsrc that the
                   5434:       <code class="filename">buildlink3.mk</code> file for
                   5435:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5436:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5437:       packages for which <code class="filename">buildlink3.mk</code> files
                   5438:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5439:       appended to within a <code class="filename">buildlink3.mk</code>
                   5440:       file.</p>
                   5441: <p>The third section is protected from multiple inclusion
                   5442:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5443:       added.  Several important variables are set in the section:</p>
                   5444: <div class="itemizedlist"><ul type="disc">
                   5445: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5446:          is the actual dependency recorded in the installed
                   5447:          package; this should always be set using
1.110     hubertf  5448:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5449:          we're appending to any pre-existing list of values.  This
                   5450:          variable should be set to the first version of the
                   5451:          package that had an API change.
                   5452:          </p></li>
                   5453: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5454:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5455:          pkgsrc directory.</p></li>
                   5456: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5457:          (not shown above) controls whether we use
                   5458:          <code class="varname">BUILD_DEPENDS</code> or
                   5459:          <code class="varname">DEPENDS</code> to add the dependency on
                   5460:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5461:          selected by setting
                   5462:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5463:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5464:          used.</p></li>
                   5465: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5466:            and
                   5467:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5468:            (not shown above) are lists of subdirectories of
1.76      rillig   5469:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5470:            to add to the header and library search paths.  These
                   5471:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5472:          respectively.</p></li>
                   5473: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5474:            (not shown above) is the list of preprocessor flags to add
                   5475:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5476:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5477:            should be avoided and instead be handled using
                   5478:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5479:          above.</p></li>
1.75      rillig   5480: </ul></div>
1.87      wiz      5481: <p>The following variables are all optionally defined within
                   5482:       this second section (protected against multiple inclusion) and
                   5483:       control which package files are symlinked into
                   5484:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5485:       transformed during the symlinking:</p>
1.75      rillig   5486: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5487: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5488:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5489:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5490:            to be symlinked into
1.76      rillig   5491:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5492:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5493: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5494:            (not shown above) is a shell pipeline that
                   5495:            outputs to stdout a list of files relative to
                   5496:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5497:            The resulting files are to be symlinked
                   5498:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5499:            this takes the <code class="filename">+CONTENTS</code> of a
                   5500:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5501:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5502: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5503:            (not shown above) is a filter command that filters
1.76      rillig   5504:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5505:            relative to
1.76      rillig   5506:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5507:            on stdout.  By default for overwrite packages,
                   5508:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5509:            outputs the contents of the <code class="filename">include</code>
                   5510:            and <code class="filename">lib</code> directories in the package
                   5511:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5512:            it outputs any libtool archives in
1.87      wiz      5513:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5514: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5515:            (not shown above) is a list of sed arguments used to
                   5516:            transform the name of the source filename into a
1.110     hubertf  5517:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5518:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5519: </ul></div>
1.87      wiz      5520: <p>The last section includes any
                   5521:       <code class="filename">buildlink3.mk</code> needed for
                   5522:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5523:       Including these <code class="filename">buildlink3.mk</code> files
                   5524:       means that the headers and libraries for these
                   5525:       dependencies are also symlinked into
                   5526:       <code class="filename">${BUILDLINK_DIR}</code>
                   5527:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5528:       <code class="filename">buildlink3.mk</code>
                   5529:       file is included.</p>
1.75      rillig   5530: </div>
                   5531: <div class="sect2" lang="en">
                   5532: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5533: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87      wiz      5534: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5535:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5536:        after a package update is when the API or interface to the
1.87      wiz      5537:       header files change.</p>
                   5538: <p>In this case,
                   5539:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5540:       should be adjusted to require at least the new package
                   5541:       version.  In some cases, the packages that depend on this new
                   5542:       version may need their <code class="varname">PKGREVISION</code>s
                   5543:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5544:       files, their
                   5545:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5546:       adjusted, too.  This is needed so pkgsrc will require the
                   5547:       correct package dependency and not settle for an older one
                   5548:       when building the source.</p>
                   5549: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5550:        should be increased when the binary interface or sonames
                   5551:        (major number of the library version) of any installed
                   5552:        shared libraries change.  This is needed so that binary
                   5553:        packages made using it will require the correct package
                   5554:        dependency and not settle for an older one which will not
1.87      wiz      5555:       contain the necessary shared libraries.</p>
1.110     hubertf  5556: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5557:        more information about dependencies on other packages,
                   5558:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5559:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5560: <p>Please take careful consideration before adjusting
                   5561:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5562:       or
                   5563:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5564:       as we don't want to cause unneeded package deletions and
                   5565:       rebuilds.  In many cases, new versions of packages work just
                   5566:       fine with older dependencies.</p>
                   5567: <p>Also it is not needed to set
1.75      rillig   5568:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5569:        when it is identical to
1.87      wiz      5570:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5571: </div>
                   5572: </div>
                   5573: <div class="sect1" lang="en">
                   5574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5575: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5576: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5577:       coincide with headers and libraries present in the base system.
1.76      rillig   5578:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5579:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5580:       file that includes the necessary checks to decide whether using
                   5581:       the built-in software or the pkgsrc software is
1.87      wiz      5582:     appropriate.</p>
                   5583: <p>The only requirements of a builtin.mk file for
                   5584:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5585: <div class="orderedlist"><ol type="1">
1.87      wiz      5586: <li><p>It should set
                   5587:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5588:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5589:        after it is included.</p></li>
                   5590: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5591:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5592:        which is already set before the
                   5593:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5594: <li><p>It should be written to allow multiple inclusion.  This
                   5595:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5596:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5597: </ol></div>
                   5598: <div class="sect2" lang="en">
                   5599: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5600: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5601: <p>The following is the recommended template for builtin.mk
1.87      wiz      5602:       files:</p>
1.75      rillig   5603: <pre class="programlisting">
1.100     rillig   5604: .if !defined(IS_BUILTIN.foo)
                   5605: #
                   5606: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5607: # genuinely exists in the system or not.
                   5608: #
                   5609: IS_BUILTIN.foo?=        no
                   5610: 
                   5611: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5612: # version can be determined.
                   5613: #
                   5614: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5615: BUILTIN_PKG.foo?=       foo-1.0
                   5616: .  endif
                   5617: .endif  # IS_BUILTIN.foo
                   5618: 
                   5619: .if !defined(USE_BUILTIN.foo)
                   5620: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5621: .  if defined(BUILTIN_PKG.foo)
                   5622: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5623: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5624: USE_BUILTIN.foo!=                                                       \
                   5625:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5626:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5627: .      endif
                   5628: .    endfor
                   5629: .  endif
                   5630: .endif  # USE_BUILTIN.foo
                   5631: 
                   5632: CHECK_BUILTIN.foo?=     no
                   5633: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5634: #
                   5635: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5636: # "yes" or "no".
                   5637: #
                   5638: .endif  # CHECK_BUILTIN.foo
                   5639: </pre>
1.87      wiz      5640: <p>The first section sets
                   5641:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5642:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5643:       in the base system.  This should not be a base system software
                   5644:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5645:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5646:       included as part of the base system.  This variable is only
                   5647:       used internally within the <code class="filename">builtin.mk</code>
                   5648:       file.</p>
                   5649: <p>The second section sets
                   5650:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5651:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5652:       system if it exists (if
                   5653:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5654:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5655:       within the <code class="filename">builtin.mk</code> file.</p>
                   5656: <p>The third section sets
                   5657:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5658:       and is <span class="emphasis"><em>required</em></span> in all
                   5659:       <code class="filename">builtin.mk</code> files.  The code in this
                   5660:       section must make the determination whether the built-in
                   5661:       software is adequate to satisfy the dependencies listed in
                   5662:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5663:       This is typically done by comparing
                   5664:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5665:       against each of the dependencies in
                   5666:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5667:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5668:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5669:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5670:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5671:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5672:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5673:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5674:       that the built-in version of the software is similar enough to
                   5675:       be used as a replacement.</p>
                   5676: <p>The last section is guarded by
                   5677:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5678:       and includes code that uses the value of
                   5679:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5680:       set in the previous section.  This typically includes, e.g.,
                   5681:       adding additional dependency restrictions and listing additional
                   5682:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5683:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5684: </div>
                   5685: <div class="sect2" lang="en">
                   5686: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5687: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5688: <p>When building packages, it's possible to choose whether to set
                   5689:        a global preference for using either the built-in (native)
                   5690:        version or the pkgsrc version of software to satisfy a
                   5691:        dependency.  This is controlled by setting
                   5692:        <code class="varname">PREFER_PKGSRC</code> and
                   5693:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5694:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5695:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5696:        use the pkgsrc versions of software, while
                   5697:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5698:        built-in versions.  Preferences are determined by the most
                   5699:        specific instance of the package in either
                   5700:        <code class="varname">PREFER_PKGSRC</code> or
                   5701:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5702:        in neither or in both variables, then
                   5703:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5704:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5705:        using pkgsrc versions of software for all but the most basic
                   5706:       bits on a NetBSD system, you can set:</p>
                   5707: <pre class="programlisting">
1.100     rillig   5708: PREFER_PKGSRC=  yes
                   5709: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5710: </pre>
1.87      wiz      5711: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5712:       <code class="filename">builtin.mk</code>
                   5713:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5714:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5715: </div>
                   5716: </div>
                   5717: </div>
                   5718: <div class="chapter" lang="en">
                   5719: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5720: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5721: <div class="toc">
                   5722: <p><b>Table of Contents</b></p>
                   5723: <dl>
1.106     rillig   5724: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5725: <dd><dl>
1.106     rillig   5726: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5727: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5728: </dl></dd>
1.106     rillig   5729: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5730: <dd><dl>
1.106     rillig   5731: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5732: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5733: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5734: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5735: </dl></dd>
                   5736: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5737: <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>
                   5738: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5739: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5740: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5741: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5742: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5743: </dl>
                   5744: </div>
                   5745: <p>This chapter describes the framework known as
                   5746: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5747: <div class="itemizedlist"><ul type="disc">
                   5748: <li><p>Generic installation and manipulation of directories and files
                   5749:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5750: <li><p>Automatic handling of configuration files during installation,
                   5751:     provided that packages are correctly designed.</p></li>
                   5752: <li><p>Generation and installation of system startup scripts.</p></li>
                   5753: <li><p>Registration of system users and groups.</p></li>
                   5754: <li><p>Registration of system shells.</p></li>
                   5755: <li><p>Automatic updating of fonts databases.</p></li>
                   5756: </ul></div>
                   5757: <p>The following sections inspect each of the above points in detail.</p>
                   5758: <p>You may be thinking that many of the things described here could be
                   5759: easily done with simple code in the package's post-installation target
                   5760: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5761: as the code in them is only executed when building from source.  Machines
                   5762: using binary packages could not benefit from it at all (as the code itself
                   5763: could be unavailable).  Therefore, the only way to achieve any of the items
                   5764: described above is by means of the installation scripts, which are
                   5765: automatically generated by pkginstall.</p>
                   5766: <div class="sect1" lang="en">
                   5767: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5768: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5769: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5770: of files and directories that belong to a package.  The names used in it
1.76      rillig   5771: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5772: which means that it cannot register files outside this directory (absolute
                   5773: path names are not allowed).  Despite this restriction, some packages need
                   5774: to install files outside this location; e.g., under
1.76      rillig   5775: <code class="filename">${VARBASE}</code> or
1.87      wiz      5776: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5777: is to create such files during installation time by using
                   5778: installation scripts.</p>
                   5779: <p>The generic installation scripts are shell scripts that can
                   5780: contain arbitrary code.  The list of scripts to execute is taken from
                   5781: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5782: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5783: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5784: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5785: commands, so they have the potential to create and manage files
                   5786: anywhere in the file system.</p>
                   5787: <p>Using these general installation files is not recommended, but
                   5788: may be needed in some special cases.  One reason for avoiding them is
                   5789: that the user has to trust the packager that there is no unwanted or
                   5790: simply erroneous code included in the installation script. Also,
                   5791: previously there were many similar scripts for the same functionality,
                   5792: and fixing a common error involved finding and changing all of
                   5793: them.</p>
                   5794: <p>The pkginstall framework offers another, standardized way.  It
                   5795: provides generic scripts to abstract the manipulation of such files
                   5796: and directories based on variables set in the package's
                   5797: <code class="filename">Makefile</code>.  The rest of this section describes
                   5798: these variables.</p>
1.75      rillig   5799: <div class="sect2" lang="en">
                   5800: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5801: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5802: <p>The following variables can be set to request the creation of
                   5803: directories anywhere in the file system:</p>
                   5804: <div class="itemizedlist"><ul type="disc">
                   5805: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5806:     contain a list of directories that should be created and should attempt
                   5807:     to be destroyed by the installation scripts.  The difference between
                   5808:     the two is that the latter prompts the administrator to remove any
                   5809:     directories that may be left after deinstallation (because they were
                   5810:     not empty), while the former does not.</p></li>
                   5811: <li>
                   5812: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5813:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5814:     which directories should be created and should attempt to be destroyed
                   5815:     by the installation scripts.  Each tuple holds the following values,
                   5816:     separated by spaces: the directory name, its owner, its group and its
                   5817:     numerical mode.  For example:</p>
                   5818: <pre class="programlisting">
1.100     rillig   5819: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5820: </pre>
1.75      rillig   5821: <p>The difference between the two is exactly the same as their
                   5822:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5823: </li>
                   5824: </ul></div>
                   5825: </div>
                   5826: <div class="sect2" lang="en">
                   5827: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5828: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5829: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5830: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5831: To overcome this problem, the only solution is to extract the file in the
                   5832: known place (i.e., inside the installation prefix) and copy it to the
                   5833: appropriate location during installation (done by the installation scripts
                   5834: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5835: file</em></span> in the following paragraphs, which describe the variables
                   5836: that can be used to automatically and consistently handle files outside the
                   5837: installation prefix:</p>
                   5838: <div class="itemizedlist"><ul type="disc">
                   5839: <li>
                   5840: <p><code class="varname">CONF_FILES</code> and
                   5841:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5842:     During installation time, the master file is copied to the target one
                   5843:     if and only if the latter does not exist.  Upon deinstallation, the
                   5844:     target file is removed provided that it was not modified by the
                   5845:     installation.</p>
                   5846: <p>The difference between the two is that the latter prompts the
                   5847:     administrator to remove any files that may be left after
                   5848:     deinstallation (because they were not empty), while the former does
                   5849:     not.</p>
                   5850: </li>
                   5851: <li>
                   5852: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5853:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5854:     files as well as their target locations.  For each of them, it also
                   5855:     specifies their owner, their group and their numeric permissions, in
                   5856:     this order.  For example:</p>
                   5857: <pre class="programlisting">
1.100     rillig   5858: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5859: </pre>
1.75      rillig   5860: <p>The difference between the two is exactly the same as their
                   5861:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5862: </li>
                   5863: </ul></div>
                   5864: </div>
                   5865: </div>
                   5866: <div class="sect1" lang="en">
                   5867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5868: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5869: <p>Configuration files are special in the sense that they are installed
                   5870: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5871: need special treatment during installation (most of which is automated by
                   5872: pkginstall).  The main concept you must bear in mind is that files marked
                   5873: as configuration files are automatically copied to the right place (somewhere
                   5874: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5875: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5876: be removed if they have local modifications.  This ensures that
                   5877: administrators never lose any custom changes they may have made.</p>
                   5878: <div class="sect2" lang="en">
                   5879: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5880: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5881: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5882: specifies where configuration files shall be installed.  Its contents are
                   5883: set based upon the following variables:</p>
                   5884: <div class="itemizedlist"><ul type="disc">
                   5885: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5886:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5887:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5888:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5889:     Packages must not use it directly.</p></li>
                   5890: <li>
                   5891: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5892:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5893:     for the package being built shall be installed.  The definition of this
                   5894:     variable only makes sense in the package's
1.76      rillig   5895:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5896: <p>As an example, consider the Apache package,
1.91      rillig   5897:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75      rillig   5898:     configuration files under the
1.76      rillig   5899:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5900:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5901:     Makefile.</p>
                   5902: </li>
                   5903: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   5904:     variable that holds this package's configuration directory (if
                   5905:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5906:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5907:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   5908: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   5909:     directory where the configuration files for the package identified by
                   5910:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5911: </ul></div>
                   5912: <p>Based on the above variables, pkginstall determines the value of
                   5913: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5914: variable that can be used within a package to refer to its configuration
                   5915: directory.  The algorithm used to set its value is basically the
                   5916: following:</p>
                   5917: <div class="orderedlist"><ol type="1">
                   5918: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   5919:     its value is used.</p></li>
                   5920: <li><p>If the previous variable is not defined but
                   5921:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5922:     <code class="filename">Makefile</code>, the resulting value is
                   5923:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   5924: <li><p>Otherwise, it is set to
1.76      rillig   5925:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5926: </ol></div>
1.76      rillig   5927: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.110     hubertf  5928: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.</p>
1.75      rillig   5929: </div>
                   5930: <div class="sect2" lang="en">
                   5931: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5932: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5933: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5934: known place, you need to teach each package where it shall install its
                   5935: files.  In some cases you will have to patch the package Makefiles to
                   5936: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5937: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5938: generated files:</p>
                   5939: <pre class="programlisting">
1.100     rillig   5940: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5941: </pre>
1.75      rillig   5942: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5943: for</em></span> its configuration files, not where they will be originally
                   5944: installed (although the difference is never explicit,
                   5945: unfortunately).</p>
                   5946: </div>
                   5947: <div class="sect2" lang="en">
                   5948: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5949: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5950: <p>As said before, pkginstall automatically handles configuration files.
                   5951: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5952: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5953: directly</strong></span>.  Bad news is that many software installation scripts
                   5954: will, out of the box, mess with the contents of that directory.  So what is
                   5955: the correct procedure to fix this issue?</p>
                   5956: <p>You must teach the package (usually by manually patching it) to
                   5957: install any configuration files under the examples hierarchy,
1.76      rillig   5958: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5959: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5960: has the original copies available.</p>
                   5961: <p>Once the required configuration files are in place (i.e., under the
                   5962: examples hierarchy), the pkginstall framework can use them as master copies
                   5963: during the package installation to update what is in
1.76      rillig   5964: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5965: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5966: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   5967: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   5968: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   5969: <pre class="programlisting">
1.100     rillig   5970: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5971: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5972: </pre>
1.75      rillig   5973: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5974: package and has no meaning outside it.</p>
                   5975: </div>
                   5976: <div class="sect2" lang="en">
                   5977: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5978: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5979: <p>The automatic copying of config files can be toggled by setting the
                   5980: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5981: installation.</p>
                   5982: </div>
                   5983: </div>
                   5984: <div class="sect1" lang="en">
                   5985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5986: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5987: <p>System startup scripts are special files because they must be
                   5988: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5989: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   5990: can be used.  However, pkginstall provides a special mechanism to handle
                   5991: these files.</p>
                   5992: <p>In order to provide system startup scripts, the package has
                   5993: to:</p>
                   5994: <div class="orderedlist"><ol type="1">
1.76      rillig   5995: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5996:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   5997:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   5998:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   5999: <li>
                   6000: <p>Tell pkginstall to handle it, appending the name of the script,
                   6001:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6002:     Continuing the previous example:</p>
                   6003: <pre class="programlisting">
1.100     rillig   6004: RCD_SCRIPTS+=   cupsd
1.1       grant    6005: </pre>
1.75      rillig   6006: </li>
                   6007: </ol></div>
                   6008: <p>Once this is done, pkginstall will do the following steps for each
                   6009: script in an automated fashion:</p>
                   6010: <div class="orderedlist"><ol type="1">
                   6011: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6012:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6013:     variable.</p></li>
                   6014: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6015:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6016:     that this master file must be explicitly registered in the
1.76      rillig   6017:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6018: <li><p>Add code to the installation scripts to copy the startup script
                   6019:     from the examples hierarchy into the system-wide startup scripts
                   6020:     directory.</p></li>
                   6021: </ol></div>
                   6022: <div class="sect2" lang="en">
                   6023: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6024: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6025: <p>The automatic copying of config files can be toggled by setting the
                   6026: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6027: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6028: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6029: matter what the value of this variable is.</p>
                   6030: </div>
                   6031: </div>
                   6032: <div class="sect1" lang="en">
                   6033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6034: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6035: <p>If a package needs to create special users and/or groups during
                   6036: installation, it can do so by using the pkginstall framework.</p>
                   6037: <p>Users can be created by adding entries to the
                   6038: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6039: syntax:</p>
                   6040: <pre class="programlisting">
1.100     rillig   6041: user:group
1.1       grant    6042: </pre>
1.87      wiz      6043: <p>Further specification of user details may be done by setting
                   6044: per-user variables.
                   6045: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6046: numeric UID for the user.
                   6047: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6048: user's description or comment.
                   6049: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6050: user's home directory, and defaults to
                   6051: <code class="filename">/nonexistent</code> if not specified.
                   6052: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6053: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6054: not specified.</p>
1.75      rillig   6055: <p>Similarly, groups can be created by adding entries to the
                   6056: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6057: <pre class="programlisting">
1.100     rillig   6058: group
1.1       grant    6059: </pre>
1.93      rillig   6060: <p>The numeric GID of the group may be set by defining
1.75      rillig   6061: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6062: <p>If a package needs to create the users and groups at an earlier
                   6063: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6064: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6065: indicate the phase before which the users and groups are created.  In
                   6066: this case, the numeric UIDs and GIDs of the created users and groups
                   6067: are automatically hardcoded into the final installation scripts.</p>
                   6068: </div>
                   6069: <div class="sect1" lang="en">
                   6070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6071: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6072: <p>Packages that install system shells should register them in the shell
1.76      rillig   6073: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6074: administrator.  This must be done from the installation scripts to keep
                   6075: binary packages working on any system.  pkginstall provides an easy way to
                   6076: accomplish this task.</p>
                   6077: <p>When a package provides a shell interpreter, it has to set the
                   6078: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6079: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6080: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   6081: <pre class="programlisting">
1.100     rillig   6082: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6083: </pre>
1.75      rillig   6084: <div class="sect2" lang="en">
                   6085: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6086: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6087: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6088: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6089: environment variable to <code class="literal">NO</code>.</p>
                   6090: </div>
                   6091: </div>
                   6092: <div class="sect1" lang="en">
                   6093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6094: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6095: <p>Packages that install X11 fonts should update the database files
                   6096: that index the fonts within each fonts directory.  This can easily be
                   6097: accomplished within the pkginstall framework.</p>
                   6098: <p>When a package installs X11 fonts, it must list the directories in
                   6099: which fonts are installed in the
                   6100: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6101: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6102: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6103: installation scripts to run the appropriate commands to update the fonts
                   6104: database files within each of those directories.  For convenience, if the
                   6105: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6106: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   6107: <pre class="programlisting">
1.100     rillig   6108: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6109: </pre>
1.75      rillig   6110: <div class="sect2" lang="en">
                   6111: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6112: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6113: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6114: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6115: environment variable to <code class="literal">NO</code>.</p>
                   6116: </div>
                   6117: </div>
                   6118: </div>
                   6119: <div class="chapter" lang="en">
                   6120: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6121: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6122: <div class="toc">
                   6123: <p><b>Table of Contents</b></p>
                   6124: <dl>
1.106     rillig   6125: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   6126: <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>
                   6127: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6128: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6129: </dl>
                   6130: </div>
                   6131: <p>Many packages have the ability to be built to support different
1.76      rillig   6132: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6133: in pkgsrc that provides generic handling of those options that
                   6134: determine different ways in which the packages can be built.  It's
                   6135: possible for the user to specify exactly which sets of options will be
                   6136: built into a package or to allow a set of global default options
                   6137: apply.</p>
1.107     rillig   6138: <p>There are two broad classes of behaviors that one might want to
                   6139: control via options.  One is whether some particular feature is
                   6140: enabled in a program that will be built anyway, often by including or
                   6141: not including a dependency on some other package.  The other is
                   6142: whether or not an additional program will be built as part of the
                   6143: package.  Generally, it is better to make a split package for such
                   6144: additional programs instead of using options, because it enables
                   6145: binary packages to be built which can then be added separately.  For
                   6146: example, the foo package might have minimal dependencies (those
                   6147: packages without which foo doesn't make sense), and then the foo-gfoo
                   6148: package might include the GTK frontend program gfoo.  This is better
                   6149: than including a gtk option to foo that adds gfoo, because either that
                   6150: option is default, in which case binary users can't get foo without
                   6151: gfoo, or not default, in which case they can't get gfoo.  With split
                   6152: packages, they can install foo without having GTK, and later decide to
                   6153: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6154: source users too, avoiding the need for rebuilds.</p>
                   6155: <p>Plugins with widely varying dependencies should usually be split
                   6156: instead of options.</p>
                   6157: <p>It is often more work to maintain split packages, especially if
                   6158: the upstream package does not support this.  The decision of split
                   6159: vs. option should be made based on the likelihood that users will want
                   6160: or object to the various pieces, the size of the dependencies that are
                   6161: included, and the amount of work.</p>
                   6162: <p>A further consideration is licensing.  Non-free parts, or parts
                   6163: that depend on non-free dependencies (especially plugins) should
                   6164: almost always be split if feasible.</p>
1.75      rillig   6165: <div class="sect1" lang="en">
                   6166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6167: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6168: <p>Global default options are listed in
                   6169: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6170: that should be built into every package if that option is supported.
1.110     hubertf  6171: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6172: </div>
                   6173: <div class="sect1" lang="en">
                   6174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6175: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6176: </h2></div></div></div>
1.75      rillig   6177: <p>The following example shows how
1.76      rillig   6178: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6179: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6180: <code class="filename">Makefile</code>, or in a file,
                   6181: e.g. <code class="filename">options.mk</code>, that is included by the
                   6182: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6183: <pre class="programlisting">
1.100     rillig   6184: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6185: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6186: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6187: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6188: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6189: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6190: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6191: 
                   6192: .include "../../mk/bsd.prefs.mk"
                   6193: 
                   6194: # this package was previously named wibble2
                   6195: .if defined(PKG_OPTIONS.wibble2)
                   6196: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6197: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6198:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6199: .endif
                   6200: 
                   6201: .include "../../mk/bsd.options.mk"
                   6202: 
                   6203: # Package-specific option-handling
                   6204: 
                   6205: ###
                   6206: ### FOO support
                   6207: ###
                   6208: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6209: CONFIGURE_ARGS+=    --enable-foo
                   6210: .endif
                   6211: 
                   6212: ###
                   6213: ### LDAP support
                   6214: ###
                   6215: .if !empty(PKG_OPTIONS:Mldap)
                   6216: .  include "../../databases/openldap-client/buildlink3.mk"
                   6217: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6218: .endif
                   6219: 
                   6220: ###
                   6221: ### database support
                   6222: ###
                   6223: .if !empty(PKG_OPTIONS:Mmysql)
                   6224: .  include "../../mk/mysql.buildlink3.mk"
                   6225: .endif
                   6226: .if !empty(PKG_OPTIONS:Mpgsql)
                   6227: .  include "../../mk/pgsql.buildlink3.mk"
                   6228: .endif
1.75      rillig   6229: </pre>
                   6230: <p>The first section contains the information about which build
                   6231: options are supported by the package, and any default options settings
                   6232: if needed.</p>
                   6233: <div class="orderedlist"><ol type="1">
                   6234: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110     hubertf  6235: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6236: options.  It should be set to
1.78      rillig   6237: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6238: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6239: at the point where the options are processed.</p></li>
1.75      rillig   6240: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6241: build options supported by the package.</p></li>
                   6242: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6243: list of names of groups of mutually exclusive options.  The options in
                   6244: each group are listed in
                   6245: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6246: The most specific setting of any option from the group takes
                   6247: precedence over all other options in the group.  Options from the
                   6248: groups will be automatically added to
                   6249: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6250: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6251: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6252: packages will fail if no option from the group is
                   6253: selected.</p></li>
                   6254: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6255: of names of sets of options.  At least one option from each set must
                   6256: be selected.  The options in each set are listed in
                   6257: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6258: Options from the sets will be automatically added to
                   6259: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6260: fail if no option from the set is selected.</p></li>
                   6261: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6262: build options which are enabled by default.</p></li>
                   6263: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6264: of
                   6265: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.110     hubertf  6266: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6267: their option counterparts.  Pairs should be added with
                   6268: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6269: warning will be issued if the user uses a legacy
                   6270: variable.</p></li>
                   6271: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6272: of
                   6273: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6274: pairs that map options that have been renamed to their new
                   6275: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6276: the listing of global legacy options.  A warning will be issued if
                   6277: the user uses a legacy option.</p></li>
                   6278: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6279: options implied by deprecated variables used.  This can be used for
                   6280: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6281: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6282: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6283: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6284: a list of warnings about deprecated variables or options used, and
                   6285: what to use instead.</p></li>
                   6286: </ol></div>
                   6287: <p>A package should never modify
                   6288: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6289: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6290: To suggest a default set of options, use
                   6291: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6292: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6293: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6294: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6295: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6296: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6297: happen with platform-specific options if none of them is supported on
                   6298: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6299: empty list and the package is otherwise treated as not using the
                   6300: options framework.</p>
1.76      rillig   6301: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6302: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6303: build options, properly filtered to remove unsupported and duplicate
                   6304: options.</p>
                   6305: <p>The remaining sections contain the logic that is specific to
                   6306: each option.  The correct way to check for an option is to check
                   6307: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6308: <pre class="programlisting">
1.100     rillig   6309: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6310: </pre>
                   6311: </div>
                   6312: <div class="sect1" lang="en">
                   6313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6314: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6315: <p>Options that enable similar features in different packages (like
                   6316: optional support for a library) should use a common name in all
                   6317: packages that support it (like the name of the library).  If another
                   6318: package already has an option with the same meaning, use the same
                   6319: name.</p>
                   6320: <p>Options that enable features specific to one package, where it's
                   6321: unlikely that another (unrelated) package has the same (or a similar)
                   6322: optional feature, should use a name prefixed with
                   6323: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6324: <p>If a group of related packages share an optional feature
                   6325: specific to that group, prefix it with the name of the
                   6326: &#8220;<span class="quote">main</span>&#8221; package
                   6327: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6328: <p>For new options, add a line to
1.76      rillig   6329: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6330: fields, separated by tab.  The first field is the option name, the
                   6331: second its description.  The description should be a whole sentence
                   6332: (starting with an uppercase letter and ending with a period) that
                   6333: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6334: support.</span>&#8221; The file is sorted by option names.</p>
                   6335: </div>
1.107     rillig   6336: <div class="sect1" lang="en">
                   6337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6338: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6339: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6340: different dependencies based on the options with which the package was
                   6341: built. For querying these options, the file
                   6342: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6343: typical example looks like this:</p>
                   6344: <pre class="programlisting">
                   6345: pkgbase := libpurple
                   6346: .include "../../mk/pkg-build-options.mk"
                   6347: 
                   6348: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6349: ...
                   6350: .endif
                   6351: </pre>
                   6352: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6353: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6354: options of the libpurple package, which can then be queried like
                   6355: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6356: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6357: details.</p>
                   6358: </div>
1.75      rillig   6359: </div>
                   6360: <div class="chapter" lang="en">
                   6361: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6362: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6363: <div class="toc">
                   6364: <p><b>Table of Contents</b></p>
                   6365: <dl>
1.106     rillig   6366: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6367: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6368: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6369: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
                   6370: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6371: <dd><dl>
                   6372: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6373: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6374: </dl></dd>
                   6375: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6376: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6377: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6378: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6379: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6380: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6381: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6382: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6383: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6384: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6385: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6386: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6387: </dl>
                   6388: </div>
                   6389: <div class="sect1" lang="en">
                   6390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6391: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6392: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6393:     built. Building a package is separated into different
                   6394:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6395:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6396:     described in the following sections. Each phase is splitted into
                   6397:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6398:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6399:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6400:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6401:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6402: <p>Never override the regular targets (like
                   6403:     <code class="varname">fetch</code>), if you have to, override the
                   6404:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6405: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6406:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6407:     the local system and then extracted. After any pkgsrc-specific patches
                   6408:     to compile properly are applied, the software can be configured, then
                   6409:     built (usually by compiling), and finally the generated binaries, etc.
                   6410:     can be put into place on the system.</p>
1.97      rillig   6411: <p>To get more details about what is happening at each step,
                   6412:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6413:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6414:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6415: </div>
                   6416: <div class="sect1" lang="en">
                   6417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6418: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6419: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6420:     the next section, here's a brief discussion on where programs are
                   6421:     installed, and which variables influence this.</p>
1.75      rillig   6422: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6423:     where all files of the final program shall be installed. It is
                   6424:     usually set to <code class="varname">LOCALBASE</code>
                   6425:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6426:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6427:     <code class="varname">PREFIX</code> needs to be put
                   6428:     into the various places in the program's source where paths to
1.110     hubertf  6429:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6430: <p>When choosing which of these variables to use,
1.87      wiz      6431:     follow the following rules:</p>
1.75      rillig   6432: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6433: <li><p><code class="varname">PREFIX</code> always points to the location
                   6434:        where the current pkg will be installed.  When referring to a
                   6435:        pkg's own installation path, use
                   6436:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6437: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6438:        are installed.  If you need to construct a -I or -L argument
                   6439:        to the compiler to find includes and libraries installed by
                   6440:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6441:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6442:        installed all packages in <code class="filename">/usr/local</code>. As
                   6443:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6444:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6445: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6446:        distribution (from xsrc, etc.) is installed. When looking for
                   6447:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6448:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6449: <li>
                   6450: <p>X11-based packages are special in that they may be
                   6451:        installed in either <code class="varname">X11BASE</code> or
                   6452:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6453: <p>Usually, X11 packages should be installed under
1.88      wiz      6454:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6455:        will need to include
                   6456:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6457:        request the presence of X11 and to get the right compilation
                   6458:        flags.</p>
1.75      rillig   6459: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6460:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6461:        files. These packages are special and they must be placed under
                   6462:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6463:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6464:        your package.</p>
1.75      rillig   6465: <p>Some notes: If you need
1.87      wiz      6466:        to find includes or libraries installed by a pkg that has
                   6467:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6468:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6469:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6470:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6471:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6472:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87      wiz      6473:        is enabled by default.</p>
1.75      rillig   6474: </li>
1.88      wiz      6475: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6476:        the installed location of an X11
                   6477:        package. <code class="varname">X11PREFIX</code> will be set to
                   6478:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6479:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6480:        installed.</p></li>
                   6481: <li>
                   6482: <p>If xpkgwedge is installed, it is possible to have some
                   6483:        packages installed in <code class="varname">X11BASE</code> and some in
                   6484:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6485:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6486:        definition can be used. It takes pairs in the format
1.110     hubertf  6487:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6488:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6489:        of the installed package &lt;package&gt;, or
                   6490:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6491:        installed.</p>
1.75      rillig   6492: <p>This is best illustrated by example.</p>
                   6493: <p>The following lines are taken from
1.87      wiz      6494:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6495: <pre class="programlisting">
1.100     rillig   6496: EVAL_PREFIX+=           GTKDIR=gtk+
                   6497: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6498: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6499: CONFIGURE_ARGS+=        --enable-multibyte
                   6500: </pre>
1.88      wiz      6501: <p>Specific defaults can be defined for the packages
                   6502:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6503:        definition of the form:</p>
1.75      rillig   6504: <pre class="programlisting">
1.100     rillig   6505: GTKDIR_DEFAULT= ${LOCALBASE}
                   6506: </pre>
1.75      rillig   6507: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6508:        to the first definition in
                   6509:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6510: </li>
1.76      rillig   6511: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110     hubertf  6512:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6513:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6514:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6515: </ul></div>
                   6516: </div>
                   6517: <div class="sect1" lang="en">
                   6518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6519: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.75      rillig   6520: <p>When building a package, a number of directories is used to store
1.87      wiz      6521:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6522:     directories are explained here.</p>
1.75      rillig   6523: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6524:     are two common base directories for these relative directories:
                   6525:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6526:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6527:     inside the package itself.</p>
1.75      rillig   6528: <div class="variablelist"><dl>
                   6529: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6530: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6531:       root directory. Generally, you don't need
                   6532:       it.</p></dd>
1.97      rillig   6533: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6534: <dd><p>This is an absolute pathname that points to the
                   6535:       current package.</p></dd>
1.75      rillig   6536: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6537: <dd><p>This is a pathname relative to
1.87      wiz      6538:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6539:       package.</p></dd>
1.75      rillig   6540: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6541: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6542:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6543:       directory. It also contains temporary directories and log files used by
                   6544:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6545:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6546: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6547: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6548:       where the distfiles are extracted. It is usually a direct subdirectory
                   6549:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6550:       that isn't hidden. This variable may be changed by a package
                   6551:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6552: </dl></div>
                   6553: </div>
                   6554: <div class="sect1" lang="en">
                   6555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6556: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6557: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6558:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6559:     phase. This will automatically run all phases that are required for this
                   6560:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6561:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6562:     the package will be built, but not installed.</p>
1.75      rillig   6563: </div>
                   6564: <div class="sect1" lang="en">
                   6565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6566: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6567: <p>The first step in building a package is to fetch the
1.88      wiz      6568:     distribution files (distfiles) from the sites that are providing
                   6569:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6570:     phase.</p>
1.81      rillig   6571: <div class="sect2" lang="en">
                   6572: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6573: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6574: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6575:       defines all URLs from where the distfile, whose name is
                   6576:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6577:       fetched. The more complicated cases are described
                   6578:       below.</p>
                   6579: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6580:       the list of distfiles that have to be fetched. Its value
                   6581:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6582:       so that most packages don't need to define it at all.
                   6583:       <code class="varname">EXTRACT_SUFX</code> is
                   6584:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6585:       freely. Note that if your package requires additional
                   6586:       distfiles to the default one, you cannot just append the
                   6587:       additional filenames using the <code class="literal">+=</code>
                   6588:       operator, but you have write for example:</p>
1.81      rillig   6589: <pre class="programlisting">
1.100     rillig   6590: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6591: </pre>
1.88      wiz      6592: <p>Each distfile is fetched from a list of sites, usually
                   6593:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6594:       <code class="varname">DISTFILES</code> or multiple
                   6595:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6596:       set
                   6597:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6598:       to the list of URLs where the file
                   6599:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6600:       (including the suffix) can be found.</p>
                   6601: <pre class="programlisting">
1.100     rillig   6602: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6603: DISTFILES+=     foo-file.tar.gz
                   6604: SITES.foo-file.tar.gz= \
                   6605: http://www.somewhere.com/somehow/ \
                   6606: http://www.somewhereelse.com/mirror/somehow/
                   6607: </pre>
1.81      rillig   6608: <p>When actually fetching the distfiles, each item from
1.88      wiz      6609:       <code class="varname">MASTER_SITES</code> or
                   6610:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6611:       appended to it, without an intermediate slash. Therefore,
                   6612:       all site values have to end with a slash or other separator
                   6613:       character. This allows for example to set
                   6614:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6615:       that gets the name of the distfile as a parameter. In this
                   6616:       case, the definition would look like:</p>
1.81      rillig   6617: <pre class="programlisting">
1.100     rillig   6618: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6619: </pre>
1.81      rillig   6620: <p>There are some predefined values for
1.88      wiz      6621:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6622:       packages.  The names of the variables should speak for
                   6623:       themselves.</p>
                   6624: <pre class="programlisting">
1.100     rillig   6625: ${MASTER_SITE_APACHE}
                   6626: ${MASTER_SITE_BACKUP}
                   6627: ${MASTER_SITE_CYGWIN}
                   6628: ${MASTER_SITE_DEBIAN}
                   6629: ${MASTER_SITE_FREEBSD}
                   6630: ${MASTER_SITE_FREEBSD_LOCAL}
                   6631: ${MASTER_SITE_GENTOO}
                   6632: ${MASTER_SITE_GNOME}
                   6633: ${MASTER_SITE_GNU}
                   6634: ${MASTER_SITE_GNUSTEP}
                   6635: ${MASTER_SITE_IFARCHIVE}
                   6636: ${MASTER_SITE_KDE}
                   6637: ${MASTER_SITE_MOZILLA}
                   6638: ${MASTER_SITE_MYSQL}
                   6639: ${MASTER_SITE_OPENOFFICE}
                   6640: ${MASTER_SITE_PERL_CPAN}
                   6641: ${MASTER_SITE_PGSQL}
                   6642: ${MASTER_SITE_R_CRAN}
                   6643: ${MASTER_SITE_SOURCEFORGE}
                   6644: ${MASTER_SITE_SOURCEFORGE_JP}
                   6645: ${MASTER_SITE_SUNSITE}
                   6646: ${MASTER_SITE_SUSE}
                   6647: ${MASTER_SITE_TEX_CTAN}
                   6648: ${MASTER_SITE_XCONTRIB}
                   6649: ${MASTER_SITE_XEMACS}
                   6650: </pre>
1.88      wiz      6651: <p>Some explanations for the less self-explaining ones:
                   6652:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110     hubertf  6653:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   6654:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6655: <p>If you choose one of these predefined sites, you may
                   6656:       want to specify a subdirectory of that site. Since these
                   6657:       macros may expand to more than one actual site, you
                   6658:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6659:       specify a subdirectory:</p>
1.81      rillig   6660: <pre class="programlisting">
1.100     rillig   6661: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6662: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6663: </pre>
1.81      rillig   6664: <p>Note the trailing slash after the subdirectory
1.88      wiz      6665:       name.</p>
1.81      rillig   6666: </div>
                   6667: <div class="sect2" lang="en">
                   6668: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6669: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6670: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6671:       all the distfiles exist in a local directory
1.93      rillig   6672:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6673:       user). If the files do not exist, they are fetched using
                   6674:       commands of the form</p>
1.75      rillig   6675: <pre class="programlisting">
1.100     rillig   6676: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6677: </pre>
1.88      wiz      6678: <p>where <code class="literal">${site}</code> varies through
                   6679:       several possibilities in turn: first,
                   6680:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6681:       sites specified in either <code class="varname">SITES.file</code> if
                   6682:       defined, else <code class="varname">MASTER_SITES</code> or
                   6683:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6684:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6685:       all except the first and the last can be optionally sorted
                   6686:       by the user, via setting either
                   6687:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6688:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6689:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97      rillig   6690: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6691:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6692:       distfiles, if they are freely distributable.  Packages setting
                   6693:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6694:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6695:       mirrored.</p>
1.81      rillig   6696: </div>
1.75      rillig   6697: </div>
                   6698: <div class="sect1" lang="en">
                   6699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6700: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6701: <p>After the distfile(s) are fetched, their checksum is
                   6702:     generated and compared with the checksums stored in the
                   6703:     distinfo file. If the checksums don't match, the build is
                   6704:     aborted. This is to ensure the same distfile is used for
                   6705:     building, and that the distfile wasn't changed, e.g. by some
                   6706:     malign force, deliberately changed distfiles on the master
                   6707:     distribution site or network lossage.</p>
1.75      rillig   6708: </div>
                   6709: <div class="sect1" lang="en">
                   6710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6711: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6712: <p>When the distfiles are present on the local system, they
1.88      wiz      6713:     need to be extracted, as they usually come in the form of some
                   6714:     compressed archive format.</p>
1.75      rillig   6715: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6716:     extracted. If you only need some of them, you can set the
                   6717:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6718:     files.</p>
                   6719: <p>Extracting the files is usually done by a little
1.93      rillig   6720:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6721:     already knows how to extract various archive formats, so most
                   6722:     likely you will not need to change anything here. But if you
                   6723:     need, the following variables may help you:</p>
1.75      rillig   6724: <div class="variablelist"><dl>
                   6725: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6726: <dd><p>Use these variables to override the default
1.88      wiz      6727:       options for an extract command, which are defined in
1.93      rillig   6728:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6729: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6730: <dd><p>This variable can be set to
1.93      rillig   6731:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6732:       default value), <code class="literal">pax</code>, or an
1.88      wiz      6733:       absolute pathname pointing to the command with which tar
                   6734:       archives should be
                   6735:       extracted.</p></dd>
1.75      rillig   6736: </dl></div>
1.88      wiz      6737: <p>If the <code class="filename">extract</code> program doesn't
                   6738:     serve your needs, you can also override the
                   6739:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6740:     command used for extracting the files. This command is
                   6741:     executed in the <code class="filename">${WRKSRC}</code>
                   6742:     directory. During execution of this command, the shell
                   6743:     variable <code class="varname">extract_file</code> holds the absolute
                   6744:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6745: <p>And if that still does not suffice, you can override the
1.88      wiz      6746:     <code class="varname">do-extract</code> target in the package
                   6747:     Makefile.</p>
1.75      rillig   6748: </div>
                   6749: <div class="sect1" lang="en">
                   6750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6751: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6752: <p>After extraction, all the patches named by the
1.88      wiz      6753:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6754:     subdirectory of the package as well as in
                   6755:     $LOCALPATCHES/$PKGPATH (e.g.
                   6756:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6757:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6758:     <code class="filename">.gz</code> are uncompressed before they are
                   6759:     applied, files ending in <code class="filename">.orig</code> or
                   6760:     <code class="filename">.rej</code> are ignored. Any special options to
1.110     hubertf  6761:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
                   6762:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
                   6763: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6764:     it fail if the patches apply with some lines of fuzz. Please
                   6765:     fix (regen) the patches so that they apply cleanly. The
                   6766:     rationale behind this is that patches that don't apply cleanly
                   6767:     may end up being applied in the wrong place, and cause severe
                   6768:     harm there.</p>
1.75      rillig   6769: </div>
                   6770: <div class="sect1" lang="en">
                   6771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6772: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6773: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88      wiz      6774:     </p>
1.75      rillig   6775: </div>
                   6776: <div class="sect1" lang="en">
                   6777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6778: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6779: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6780:     linkers. The following variables can be used to tweak the
                   6781:     wrappers.</p>
1.75      rillig   6782: <div class="variablelist"><dl>
                   6783: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6784: <dd><p>The command used to print progress
1.88      wiz      6785:       messages. Does nothing by default. Set to
                   6786:       <code class="literal">${ECHO}</code> to see the progress
                   6787:       messages.</p></dd>
1.75      rillig   6788: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6789: <dd><p>This variable can be set to
1.88      wiz      6790:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6791:       depending on whether you want additional information in the
                   6792:       wrapper log file.</p></dd>
1.75      rillig   6793: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6794: <dd><p>This variable can be set to
1.88      wiz      6795:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6796:       on whether the wrapper should use its cache, which will
                   6797:       improve the speed. The default value is
                   6798:       <code class="literal">yes</code>, but is forced to
                   6799:       <code class="literal">no</code> if the platform does not support
                   6800:       it.</p></dd>
1.75      rillig   6801: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6802: <dd><p>A list of reordering commands. A reordering
                   6803:       command has the form
                   6804:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6805:       It ensures that that
                   6806:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6807:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6808:       </p></dd>
1.75      rillig   6809: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6810: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6811:       investigate further]</p></dd>
1.75      rillig   6812: </dl></div>
                   6813: </div>
                   6814: <div class="sect1" lang="en">
                   6815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6816: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6817: <p>Most pieces of software need information on the header
                   6818:     files, system calls, and library routines which are available
                   6819:     on the platform they run on. The process of determining this
                   6820:     information is known as configuration, and is usually
                   6821:     automated. In most cases, a script is supplied with the
                   6822:     distfiles, and its invocation results in generation of header
                   6823:     files, Makefiles, etc.</p>
                   6824: <p>If the package contains a configure script, this can be
                   6825:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6826:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6827:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6828:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6829:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6830: <pre class="programlisting">
1.100     rillig   6831: .for d in ${CONFIGURE_DIRS}
                   6832:         cd ${WRKSRC} \
                   6833:         &amp;&amp; cd ${d} \
                   6834:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6835: .endfor
                   6836: </pre>
1.88      wiz      6837: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6838:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6839:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6840:     configure script is run with the environment
                   6841:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6842:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6843:     <code class="varname">CONFIGURE_ENV</code>,
                   6844:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6845:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6846:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6847:     package.</p>
                   6848: <p>If the program uses an <code class="filename">Imakefile</code>
                   6849:     for configuration, the appropriate steps can be invoked by
                   6850:     setting <code class="varname">USE_IMAKE</code> to
                   6851:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6852:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   6853:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6854:     xmkmf's environment by adding them to the
                   6855:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6856: <p>If the program uses <code class="filename">cmake</code>
                   6857:     for configuration, the appropriate steps can be invoked by
                   6858:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   6859:     You can add variables to cmake's environment by adding them to the
                   6860:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6861:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6862:     The top directory argument is given by the
                   6863:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   6864:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6865: <p>If there is no configure step at all, set
                   6866:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6867: </div>
                   6868: <div class="sect1" lang="en">
                   6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6870: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6871: <p>For building a package, a rough equivalent of the
                   6872:     following code is executed.</p>
1.75      rillig   6873: <pre class="programlisting">
1.100     rillig   6874: .for d in ${BUILD_DIRS}
                   6875:         cd ${WRKSRC} \
                   6876:         &amp;&amp; cd ${d} \
                   6877:         &amp;&amp; env ${MAKE_ENV} \
                   6878:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6879:                 -f ${MAKE_FILE} \
                   6880:                 ${BUILD_TARGET}
                   6881: .endfor
                   6882: </pre>
1.88      wiz      6883: <p><code class="varname">BUILD_DIRS</code> (default:
                   6884:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6885:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6886:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6887:     <code class="varname">MAKE_ENV</code> and arguments
                   6888:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6889:     <code class="varname">MAKE_ENV</code>,
                   6890:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6891:     <code class="varname">MAKE_FILE</code> and
                   6892:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6893:     package.</p>
1.75      rillig   6894: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6895:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6896:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6897:     default value of <code class="varname">MAKE_FILE</code> is
                   6898:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6899:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   6900: <p>If there is no build step at all, set
                   6901:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6902: </div>
                   6903: <div class="sect1" lang="en">
                   6904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6905: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6906: <p>[TODO]</p>
                   6907: </div>
                   6908: <div class="sect1" lang="en">
                   6909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6910: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6911: <p>Once the build stage has completed, the final step is to
1.88      wiz      6912:     install the software in public directories, so users can
                   6913:     access the programs and files.</p>
1.75      rillig   6914: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6915:     equivalent of the following code is executed. Additionally,
                   6916:     before and after this code, much magic is performed to do
                   6917:     consistency checks, registering the package, and so on.</p>
                   6918: <pre class="programlisting">
1.100     rillig   6919: .for d in ${INSTALL_DIRS}
                   6920:         cd ${WRKSRC} \
                   6921:         &amp;&amp; cd ${d} \
                   6922:         &amp;&amp; env ${MAKE_ENV} \
                   6923:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6924:                 -f ${MAKE_FILE} \
                   6925:                 ${INSTALL_TARGET}
                   6926: .endfor
                   6927: </pre>
1.75      rillig   6928: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6929:     <span class="emphasis"><em>build</em></span> phase.
                   6930:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6931:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   6932:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   6933:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   6934:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6935:     defined.</p>
1.75      rillig   6936: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6937:     variables are useful. They are all variations of the
1.110     hubertf  6938:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6939:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6940:     install command. The specialized variants, together with their
                   6941:     intended use, are:</p>
1.75      rillig   6942: <div class="variablelist"><dl>
                   6943: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6944: <dd><p>directories that contain
                   6945:       binaries</p></dd>
1.75      rillig   6946: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6947: <dd><p>directories that contain
                   6948:       scripts</p></dd>
1.75      rillig   6949: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6950: <dd><p>directories that contain shared and static
                   6951:       libraries</p></dd>
1.75      rillig   6952: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6953: <dd><p>directories that contain data
                   6954:       files</p></dd>
1.75      rillig   6955: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6956: <dd><p>directories that contain man
                   6957:       pages</p></dd>
1.75      rillig   6958: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6959: <dd><p>binaries that can be stripped from debugging
                   6960:       symbols</p></dd>
1.75      rillig   6961: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6962: <dd><p>binaries that cannot be
                   6963:       stripped</p></dd>
1.75      rillig   6964: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6965: <dd><p>game
                   6966:       binaries</p></dd>
1.75      rillig   6967: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6968: <dd><p>shared and static
                   6969:       libraries</p></dd>
1.75      rillig   6970: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6971: <dd><p>data files</p></dd>
                   6972: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6973: <dd><p>data files for
                   6974:       games</p></dd>
1.75      rillig   6975: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6976: <dd><p>man pages</p></dd>
                   6977: </dl></div>
                   6978: <p>Some other variables are:</p>
                   6979: <div class="variablelist"><dl>
                   6980: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6981: <dd><p>A list of directories relative to
1.88      wiz      6982:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6983:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6984:       The package is supposed to create all needed directories itself
                   6985:       before installing files to it and list all other directories here.
                   6986:       </p></dd>
1.75      rillig   6987: </dl></div>
1.97      rillig   6988: <p>In the rare cases that a package shouldn't install anything,
                   6989:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   6990:     mostly relevant for packages in the <code class="filename">regress</code>
                   6991:     category.</p>
1.75      rillig   6992: </div>
                   6993: <div class="sect1" lang="en">
                   6994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6995: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6996: <p>Once the install stage has completed, a binary package of
                   6997:     the installed files can be built.  These binary packages can be
                   6998:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6999:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7000:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7001: <p>By default, the binary packages are created in
                   7002:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7003:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7004:     one for each category in the <code class="varname">CATEGORIES</code>
                   7005:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7006:     <code class="filename">pkgsrc/packages</code>.</p>
1.97      rillig   7007: <p>If there should be no binary package, set
                   7008:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7009:     This should only be used in rare cases, like when a package
                   7010:     definitely is only usable on the machine where it is built and even
                   7011:     then, a binary package can be useful.</p>
1.88      wiz      7012: </div>
                   7013: <div class="sect1" lang="en">
                   7014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7015: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7016: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7017:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7018:     to clean the work directories of all dependencies too, use
1.110     hubertf  7019:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7020: </div>
                   7021: <div class="sect1" lang="en">
                   7022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7023: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7024: <div class="variablelist"><dl>
                   7025: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7026: <dd><p>For any of the main targets described in the
                   7027:          previous section, two auxiliary targets exist with
1.87      wiz      7028:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7029:          prefix for the main target's name.  These targets are
1.88      wiz      7030:          invoked before and after the main target is called,
                   7031:          allowing extra configuration or installation steps be
                   7032:          performed from a package's Makefile, for example, which
                   7033:          a program's configure script or install target
                   7034:          omitted.</p></dd>
1.75      rillig   7035: <dt><span class="term">do-*</span></dt>
1.88      wiz      7036: <dd><p>Should one of the main targets do the wrong thing,
                   7037:          and should there be no variable to fix this, you can
                   7038:          redefine it with the do-* target.  (Note that redefining
                   7039:          the target itself instead of the do-* target is a bad
                   7040:          idea, as the pre-* and post-* targets won't be called
                   7041:          anymore, etc.) You will not usually need to do
                   7042:          this.</p></dd>
1.75      rillig   7043: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7044: <dd>
1.110     hubertf  7045: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7046:          you noticed some file was not installed properly, you
                   7047:          can repeat the installation with this target, which will
                   7048:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7049: <p>This is the default value of
                   7050:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7051:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7052:          package</strong></span>, where the defaults are
                   7053:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7054:          respectively.</p>
                   7055: </dd>
1.75      rillig   7056: <dt><span class="term">deinstall</span></dt>
                   7057: <dd>
1.110     hubertf  7058: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      7059:          current directory, effectively de-installing the
                   7060:          package. The following variables can be used to tune the
                   7061:          behaviour:</p>
1.75      rillig   7062: <div class="variablelist"><dl>
                   7063: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110     hubertf  7064: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   7065: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7066: <dd><p>Remove all packages that require (depend on)
                   7067:                the given package.  This can be used to remove any
                   7068:                packages that may have been pulled in by a given
1.110     hubertf  7069:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7070:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7071:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7072:                likely to remove whole KDE. Works by adding
1.110     hubertf  7073:                &#8220;<span class="quote">-R</span>&#8221; to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      7074:                command line.</p></dd>
1.75      rillig   7075: </dl></div>
                   7076: </dd>
1.88      wiz      7077: <dt><span class="term">bin-install</span></dt>
                   7078: <dd><p>Install a binary package from local disk and via FTP
                   7079:          from a list of sites (see the
                   7080:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7081:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7082:          available anywhere.  The arguments given to
1.110     hubertf  7083:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7084:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7085:          operation, etc.</p></dd>
1.75      rillig   7086: <dt><span class="term">update</span></dt>
                   7087: <dd>
1.88      wiz      7088: <p>This target causes the current package to be
                   7089:          updated to the latest version.  The package and all
                   7090:          depending packages first get de-installed, then current
                   7091:          versions of the corresponding packages get compiled and
                   7092:          installed.  This is similar to manually noting which
                   7093:          packages are currently installed, then performing a
1.110     hubertf  7094:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7095:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7096:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7097:          packages.</p>
                   7098: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.110     hubertf  7099:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7100:          update</strong></span> was interrupted for some reason.
                   7101:          However, in this case, make sure you don't call
1.110     hubertf  7102:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7103:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7104:          Otherwise, you lose the ability to automatically update
                   7105:          the current package along with the dependent packages
                   7106:          you have installed.</p>
1.110     hubertf  7107: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7108:          update</strong></span> will only work as long as the package
                   7109:          tree remains unchanged.  If the source code for one of
                   7110:          the packages to be updated has been changed, resuming
1.110     hubertf  7111:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7112:          fail!</p>
                   7113: <p>The following variables can be used either on the
1.110     hubertf  7114:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7115:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7116:          update</strong></span>:</p>
1.75      rillig   7117: <div class="variablelist"><dl>
                   7118: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7119: <dd><p>Install target to recursively use for the
                   7120:                updated package and the dependent packages.
                   7121:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7122:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.110     hubertf  7123:                <span class="command"><strong>make update</strong></span>.  Other good
1.88      wiz      7124:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7125:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7126:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7127:                endless loop!</p></dd>
1.75      rillig   7128: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7129: <dd><p>Don't clean up after updating.  Useful if
                   7130:                you want to leave the work sources of the updated
                   7131:                packages around for inspection or other purposes.
                   7132:                Be sure you eventually clean up the source tree
                   7133:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7134:                or you may run into troubles with old source code
                   7135:                still lying around on your next
1.110     hubertf  7136:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7137:                update</strong></span>.</p></dd>
1.75      rillig   7138: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7139: <dd><p>Deinstall each package before installing
                   7140:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7141:                may be necessary if the
                   7142:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.110     hubertf  7143:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7144:                update</strong></span>.</p></dd>
1.75      rillig   7145: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7146: <dd><p>Allows you to disable recursion and hardcode
                   7147:                the target for packages.  The default is
                   7148:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7149:                facilitating a recursive update of prerequisite
                   7150:                packages.  Only set
                   7151:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7152:                disable recursive updates. Use
                   7153:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7154:                set a specific target for each package to be
1.110     hubertf  7155:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7156:                (see above).</p></dd>
1.75      rillig   7157: </dl></div>
                   7158: </dd>
                   7159: <dt><span class="term">clean-update</span></dt>
                   7160: <dd>
1.88      wiz      7161: <p>Clean the source tree for all packages that would
1.110     hubertf  7162:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7163:          from the current directory.  This target should not be
                   7164:          used if the current package (or any of its depending
                   7165:          packages) have already been de-installed (e.g., after
1.110     hubertf  7166:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7167:          some packages you intended to update. As a rule of
                   7168:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7169:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7170:          and only if you have a dirty package tree (e.g., if you
                   7171:          used <code class="varname">NOCLEAN</code>).</p>
                   7172: <p>If you are unsure about whether your tree is
1.110     hubertf  7173:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7174:          clean</strong></span> at the top of the tree, or use the
                   7175:          following sequence of commands from the directory of the
                   7176:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7177:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7178:          time, otherwise you lose all the packages you wanted to
                   7179:          update!):</p>
1.87      wiz      7180: <pre class="screen">
                   7181: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7182: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7183: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7184:          </pre>
1.88      wiz      7185: <p>The following variables can be used either on the
1.110     hubertf  7186:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7187:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.75      rillig   7188: <div class="variablelist"><dl>
                   7189: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7190: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7191:                reconstruct the list of directories to update for
1.110     hubertf  7192:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7193:                update</strong></span> successfully installed all
                   7194:                packages you wanted to update.  Normally, this is
1.110     hubertf  7195:                done automatically on <span class="command"><strong>make
1.88      wiz      7196:                update</strong></span>, but may have been suppressed by
                   7197:                the <code class="varname">NOCLEAN</code> variable (see
                   7198:                above).</p></dd>
1.75      rillig   7199: </dl></div>
                   7200: </dd>
1.88      wiz      7201: <dt><span class="term">replace</span></dt>
                   7202: <dd>
                   7203: <p>Update the installation of the current package.  This
                   7204:          differs from update in that it does not replace dependent
1.93      rillig   7205:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7206:          target to work.</p>
                   7207: <p><span class="emphasis"><em>Be careful when using this
                   7208:          target!</em></span> There are no guarantees that dependent
                   7209:          packages will still work, in particular they will most
1.110     hubertf  7210:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7211:          library package whose shared library major version changed
                   7212:          between your installed version and the new one.  For this
                   7213:          reason, this target is not officially supported and only
                   7214:          recommended for advanced users.</p>
                   7215: </dd>
1.75      rillig   7216: <dt><span class="term">info</span></dt>
1.110     hubertf  7217: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7218:          package. You can use this to check which version of a
                   7219:          package is installed.</p></dd>
                   7220: <dt><span class="term">index</span></dt>
                   7221: <dd>
                   7222: <p>This is a top-level command, i.e. it should be used in
                   7223:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7224:          database of all packages in the local pkgsrc tree, including
                   7225:          dependencies, comment, maintainer, and some other useful
                   7226:          information.  Individual entries are created by running
1.110     hubertf  7227:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7228:          directories.  This index file is saved as
                   7229:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7230:          verbose format by running <span class="command"><strong>make
1.88      wiz      7231:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7232:          <span class="command"><strong>make search
1.88      wiz      7233:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7234:          extract a list of all packages that depend on a particular
1.110     hubertf  7235:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7236:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7237: <p>Running this command takes a very long time, some
                   7238:          hours even on fast machines!</p>
                   7239: </dd>
1.75      rillig   7240: <dt><span class="term">readme</span></dt>
1.88      wiz      7241: <dd>
                   7242: <p>This target generates a
                   7243:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7244:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7245:          contain references to any packages which are in the
                   7246:          <code class="varname">PACKAGES</code> directory on the local
                   7247:          host. The generated files can be made to refer to URLs
                   7248:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7249:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7250:          wanted to generate <code class="filename">README.html</code>
                   7251:          files which pointed to binary packages on the local
                   7252:          machine, in the directory
                   7253:          <code class="filename">/usr/packages</code>, set
                   7254:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7255:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7256:          <code class="varname">${PACKAGES}</code> directory and its
                   7257:          subdirectories will be searched for all the binary
                   7258:          packages.</p>
                   7259: <p>The target can be run at the toplevel or in category
                   7260:          directories, in which case it descends recursively.</p>
                   7261: </dd>
1.75      rillig   7262: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7263: <dd><p>This is a top-level command, run it in
                   7264:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7265:          file <code class="filename">README-all.html</code> which contains a
                   7266:          list of all packages currently available in the NetBSD
                   7267:          Packages Collection, together with the category they belong
                   7268:          to and a short description. This file is compiled from the
                   7269:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7270:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7271:          readme</strong></span>.</p></dd>
1.75      rillig   7272: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7273: <dd><p>This is very much the same as the
                   7274:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7275:          used when generating a pkgsrc tree to be written to a
                   7276:          CD-ROM.  This target also produces
                   7277:          <code class="filename">README.html</code> files, and can be made
                   7278:          to refer to URLs based on
                   7279:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7280:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7281: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7282: <dd><p>This target shows which distfiles and patchfiles
                   7283:          are needed to build the package
                   7284:          (<code class="varname">ALLFILES</code>, which contains all
                   7285:          <code class="varname">DISTFILES</code> and
1.87      wiz      7286:          <code class="varname">PATCHFILES</code>, but not
                   7287:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7288: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7289: <dd><p>This target shows nothing if the package is not
                   7290:          installed. If a version of this package is installed,
                   7291:          but is not the version provided in this version of
                   7292:          pkgsrc, then a warning message is displayed. This target
                   7293:          can be used to show which of your installed packages are
                   7294:          downlevel, and so the old versions can be deleted, and
                   7295:          the current ones added.</p></dd>
1.75      rillig   7296: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7297: <dd><p>This target shows the directory in the pkgsrc
                   7298:          hierarchy from which the package can be built and
                   7299:          installed. This may not be the same directory as the one
                   7300:          from which the package was installed. This target is
                   7301:          intended to be used by people who may wish to upgrade
                   7302:          many packages on a single host, and can be invoked from
                   7303:          the top-level pkgsrc Makefile by using the
1.87      wiz      7304:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7305: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7306: <dd><p>This target shows which installed packages match
                   7307:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7308:          if out of date dependencies are causing build
                   7309:          problems.</p></dd>
1.75      rillig   7310: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7311: <dd><p>After a package is installed, check all its
                   7312:          binaries and (on ELF platforms) shared libraries to see
                   7313:          if they find the shared libs they need.  Run by default
1.110     hubertf  7314:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   7315: <dt><span class="term">print-PLIST</span></dt>
                   7316: <dd>
                   7317: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7318:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7319:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7320:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7321:          to care for shared libs etc., but it is
1.87      wiz      7322:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7323:          result before putting it into
                   7324:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7325:          diff the output of this command against an already
                   7326:          existing <code class="filename">PLIST</code> file.</p>
1.110     hubertf  7327: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7328:          other methods that don't update file access times, be
                   7329:          sure to add these files manually to your
1.87      wiz      7330:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7331:          -newer</span>&#8221; command used by this target won't catch
                   7332:          them!</p>
1.110     hubertf  7333: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      7334:          information on this target.</p>
1.75      rillig   7335: </dd>
                   7336: <dt><span class="term">bulk-package</span></dt>
                   7337: <dd>
1.88      wiz      7338: <p>Used to do bulk builds. If an appropriate binary
                   7339:          package already exists, no action is taken. If not, this
                   7340:          target will compile, install and package it (and its
                   7341:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7342:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7343:          After creating the binary package, the sources, the
                   7344:          just-installed package and its required packages are
                   7345:          removed, preserving free disk space.</p>
                   7346: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7347:          all packages installed on a system!</em></span></p>
1.75      rillig   7348: </dd>
                   7349: <dt><span class="term">bulk-install</span></dt>
                   7350: <dd>
1.88      wiz      7351: <p>Used during bulk-installs to install required
                   7352:          packages. If an up-to-date binary package is available,
1.110     hubertf  7353:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
                   7354:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7355:          but the installed binary won't be removed.</p>
1.88      wiz      7356: <p>A binary package is considered
                   7357:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.110     hubertf  7358:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88      wiz      7359: <div class="itemizedlist"><ul type="disc">
                   7360: <li><p>None of the package's files
                   7361:              (<code class="filename">Makefile</code>, ...) were modified
                   7362:              since it was built.</p></li>
                   7363: <li><p>None of the package's required (binary)
                   7364:              packages were modified since it was built.</p></li>
1.75      rillig   7365: </ul></div>
1.88      wiz      7366: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7367:          all packages installed on a system!</em></span></p>
1.75      rillig   7368: </dd>
                   7369: </dl></div>
                   7370: </div>
                   7371: </div>
                   7372: <div class="chapter" lang="en">
                   7373: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7374: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7375: <div class="toc">
                   7376: <p><b>Table of Contents</b></p>
                   7377: <dl>
1.106     rillig   7378: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7379: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7380: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7381: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7382: </dl>
                   7383: </div>
1.87      wiz      7384: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7385: by pkgsrc and also for individual packages to define what commands
                   7386: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7387: or for later run-time of an installed packaged (such as
                   7388: <code class="varname">DEPENDS</code>).
                   7389: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7390: package will not be used.</p>
                   7391: <p>When building a package, the replacement tools are
1.75      rillig   7392: made available in a directory (as symlinks or wrapper scripts)
                   7393: that is early in the executable search path. Just like the buildlink
1.87      wiz      7394: system, this helps with consistent builds.</p>
                   7395: <p>A tool may be needed to help build a specific package. For example,
                   7396: perl, GNU make (gmake) or yacc may be needed.</p>
                   7397: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7398: tool may be inefficient for building a package with pkgsrc.
                   7399: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7400: yacc) or a better sed.</p>
                   7401: <p>The tools used by a package can be listed by running
1.110     hubertf  7402: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75      rillig   7403: <div class="sect1" lang="en">
                   7404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7405: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7406: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7407: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7408: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7409: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7410: These can be seen by running:
1.110     hubertf  7411: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7412: <p>If a package needs a specific program to build
1.75      rillig   7413: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7414: to define the tools needed.</p>
1.75      rillig   7415: </div>
                   7416: <div class="sect1" lang="en">
                   7417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7418: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7419: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7420: and not the native version for a build dependency.
                   7421: And the :run means that it is used for a
                   7422: run-time dependencies also (and becomes a DEPENDS).
                   7423: The default is a build dependency which can be set with
                   7424: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7425: and pkg-config:build.)</p>
1.75      rillig   7426: <pre class="programlisting">
                   7427: USE_TOOLS+=     mktemp:pkgsrc
                   7428: USE_TOOLS+=     gmake perl:run pkg-config
                   7429: </pre>
1.87      wiz      7430: <p>When using the tools framework, a
1.75      rillig   7431: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7432: which contains the full path to the appropriate tool. For example,
                   7433: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7434: on Linux systems.</p>
                   7435: <p>If you always need a pkgsrc version of the
1.75      rillig   7436: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7437: </p>
                   7438: </div>
                   7439: <div class="sect1" lang="en">
                   7440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7441: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7442: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7443: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7444: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7445: the name of the common tools. For example:</p>
                   7446: <pre class="programlisting">
                   7447: .if exists(/usr/bin/bzcat)
                   7448: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7449: .elif exists(/usr/bin/bzip2)
                   7450: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7451: .endif
1.69      rillig   7452: 
1.75      rillig   7453: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7454: </pre>
                   7455: </div>
1.97      rillig   7456: <div class="sect1" lang="en">
                   7457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7458: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97      rillig   7459: <div class="qandaset">
                   7460: <dl>
1.106     rillig   7461: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7462: </dt>
1.106     rillig   7463: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7464:        tools?</a>
                   7465: </dt>
1.106     rillig   7466: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7467:        package is using while being built? I want to know whether it
                   7468:        uses sed or not.</a>
                   7469: </dt>
                   7470: </dl>
                   7471: <table border="0" summary="Q and A Set">
                   7472: <col align="left" width="1%">
                   7473: <tbody>
                   7474: <tr class="question">
                   7475: <td align="left" valign="top">
1.113   ! weinem   7476: <a name="tools.new"></a><a name="id2727813"></a><p><b>18.4.1.</b></p>
1.97      rillig   7477: </td>
                   7478: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7479: </tr>
                   7480: <tr class="answer">
                   7481: <td align="left" valign="top"></td>
                   7482: <td align="left" valign="top"><p>TODO</p></td>
                   7483: </tr>
                   7484: <tr class="question">
                   7485: <td align="left" valign="top">
1.113   ! weinem   7486: <a name="tools.listall"></a><a name="id2727822"></a><p><b>18.4.2.</b></p>
1.97      rillig   7487: </td>
                   7488: <td align="left" valign="top"><p>How do I get a list of all available
                   7489:        tools?</p></td>
                   7490: </tr>
                   7491: <tr class="answer">
                   7492: <td align="left" valign="top"></td>
                   7493: <td align="left" valign="top"><p>TODO</p></td>
                   7494: </tr>
                   7495: <tr class="question">
                   7496: <td align="left" valign="top">
1.113   ! weinem   7497: <a name="tools.used"></a><a name="id2727833"></a><p><b>18.4.3.</b></p>
1.97      rillig   7498: </td>
                   7499: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7500:        package is using while being built? I want to know whether it
                   7501:        uses sed or not.</p></td>
                   7502: </tr>
                   7503: <tr class="answer">
                   7504: <td align="left" valign="top"></td>
                   7505: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7506:        to do it.)</p></td>
                   7507: </tr>
                   7508: </tbody>
                   7509: </table>
                   7510: </div>
                   7511: </div>
1.75      rillig   7512: </div>
                   7513: <div class="chapter" lang="en">
                   7514: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7515: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7516: <div class="toc">
                   7517: <p><b>Table of Contents</b></p>
                   7518: <dl>
1.106     rillig   7519: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7520: <dd><dl>
1.106     rillig   7521: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
                   7522: <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>
                   7523: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7524: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7525: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7526: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7527: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7528: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7529: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7530: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7531: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7532: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7533: </dl></dd>
                   7534: <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>
                   7535: <dd><dl>
                   7536: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7537: <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>
                   7538: </dl></dd>
                   7539: <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>
                   7540: <dd><dl>
                   7541: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7542: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7543: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7544: </dl></dd>
                   7545: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7546: <dd><dl>
                   7547: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7548: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7549: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7550: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7551: </dl></dd>
                   7552: <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>
                   7553: <dd><dl>
                   7554: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7555: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
                   7556: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7557: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7558: </dl></dd>
                   7559: <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>
                   7560: <dd><dl>
                   7561: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7562: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7563: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7564: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7565: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7566: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7567: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7568: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7569: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106     rillig   7570: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   7571: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7572: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7573: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7574: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7575: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7576: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7577: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7578: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7579:     emulation</a></span></dt>
1.106     rillig   7580: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7581: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7582: </dl></dd>
1.106     rillig   7583: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7584: </dl>
                   7585: </div>
                   7586: <div class="sect1" lang="en">
                   7587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7588: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75      rillig   7589: <div class="sect2" lang="en">
                   7590: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7591: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7592: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7593:     different platforms. As a result, it is important to ensure,
                   7594:     where possible, that packages in pkgsrc are portable. This
                   7595:     chapter mentions some particular details you should pay
                   7596:     attention to while working on pkgsrc.</p>
1.78      rillig   7597: </div>
                   7598: <div class="sect2" lang="en">
                   7599: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7600: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7601: </h3></div></div></div>
1.78      rillig   7602: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7603:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7604:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7605:     want to use those variables in the preprocessor directives of
1.110     hubertf  7606:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7607:     <code class="literal">.for</code>), you need to include the file
                   7608:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7609:     loads the user preferences.</p>
1.78      rillig   7610: <p>But note that some variables may not be completely defined
1.87      wiz      7611:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7612:     included, as they may contain references to variables that are
                   7613:     not yet defined. In shell commands this is no problem, since
                   7614:     variables are actually macros, which are only expanded when they
                   7615:     are used. But in the preprocessor directives mentioned above and
                   7616:     in dependency lines (of the form <code class="literal">target:
                   7617:     dependencies</code>) the variables are expanded at load
                   7618:     time.</p>
1.78      rillig   7619: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7620: <h3 class="title">Note</h3>
                   7621: <p>Currently there is no exhaustive list of all
1.87      wiz      7622:     variables that tells you whether they can be used at load time
                   7623:     or only at run time, but it is in preparation.</p>
1.78      rillig   7624: </div>
                   7625: </div>
                   7626: <div class="sect2" lang="en">
                   7627: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7628: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7629: <p>Occasionally, packages require interaction from the user,
                   7630:     and this can be in a number of ways:</p>
1.78      rillig   7631: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7632: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7633:        interaction such as entering username/password or accepting a
                   7634:        license on a web page.</p></li>
1.88      wiz      7635: <li><p>When extracting the distfiles, some packages may ask for
                   7636:        passwords.</p></li>
1.78      rillig   7637: <li><p>help to configure the package before it is built</p></li>
                   7638: <li><p>help during the build process</p></li>
                   7639: <li><p>help during the installation of a package</p></li>
                   7640: </ul></div>
1.88      wiz      7641: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7642:     provided to notify the pkgsrc mechanism of an interactive stage
                   7643:     which will be needed, and this should be set in the package's
                   7644:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7645: <pre class="programlisting">
1.100     rillig   7646: INTERACTIVE_STAGE=      build
1.87      wiz      7647:     </pre>
1.78      rillig   7648: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7649: <pre class="programlisting">
1.100     rillig   7650: INTERACTIVE_STAGE=      configure install
1.87      wiz      7651:     </pre>
1.88      wiz      7652: <p>The user can then decide to skip this package by setting the
                   7653:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7654: </div>
                   7655: <div class="sect2" lang="en">
                   7656: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7657: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7658: <p>Authors of software can choose the licence under which
                   7659:     software can be copied.  This is due to copyright law, and reasons
                   7660:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7661:     system recognizes that there are a number of licenses which some
                   7662:     users may find objectionable or difficult or impossible to comply
                   7663:     with.  The Free Software Foundation has declared some licenses
                   7664:     "Free", and the Open Source Initiative has a definition of "Open
                   7665:     Source".  The pkgsrc system, as a policy choice, does not label
                   7666:     packages which have licenses that are Free or Open Source.
                   7667:     However, packages without a license meeting either of those tests
                   7668:     are labeled with a license tag denoting the license.  Note that a
                   7669:     package with no license to copy trivially does not meet either the
                   7670:     Free or Open Source test.</p>
                   7671: <p>For packages which are not Free or Open Source, pkgsrc will
                   7672:     not build the package unless the user has indicated to pkgsrc that
                   7673:     packages with that particular license may be built.  Note that
                   7674:     this documentation avoids the term "accepted the license".  The
                   7675:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7676:     accidentally building a package with a non-free license;
1.98      wiz      7677:     judgement and responsibility remain with the user.  (Installation
                   7678:     of binary packages are not currently subject to this mechanism;
                   7679:     this is a bug.)</p>
                   7680: <p>One might want to only install packages with a BSD license,
                   7681:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7682:     does not provide a way to do this.  It might be possible to put in
                   7683:     tags for free licenses, and have a default
                   7684:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7685:     widely viewed as having a very poor ratio of benefit to
                   7686:     work.</p>
1.78      rillig   7687: <p>The license tag mechanism is intended to address
1.87      wiz      7688:     copyright-related issues surrounding building, installing and
                   7689:     using a package, and not to address redistribution issues (see
                   7690:     <code class="varname">RESTRICTED</code> and
                   7691:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7692:     definition of licenses for which tags are not needed implies
                   7693:     that packages with redistribution restrictions should have
1.98      wiz      7694:     tags, because Free or Open Source programs do not have
                   7695:     redistribution restrictions.</p>
                   7696: <p>Denoting that a package may be copied according to a
                   7697:     particular license is done by placing the license in
1.87      wiz      7698:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7699:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7700:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7701: <pre class="programlisting">
1.100     rillig   7702: LICENSE=        xv-license
1.87      wiz      7703:     </pre>
                   7704: <p>When trying to build, the user will get a notice that the
1.98      wiz      7705:     package is covered by a license which has not been placed in the
                   7706:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7707: <pre class="programlisting">
1.100     rillig   7708: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7709: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7710: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7711: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7712: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7713: *** Error code 1
1.87      wiz      7714:     </pre>
1.110     hubertf  7715: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7716:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7717:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7718:     convey to pkgsrc that it should not in the future fail because of
                   7719:     that license:</p>
1.78      rillig   7720: <pre class="programlisting">
1.100     rillig   7721: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7722:     </pre>
1.98      wiz      7723: <p>When adding a package with a new license, the license text
                   7724:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7725:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7726:     directory.</p>
1.98      wiz      7727: <p>When the license changes (in a way other than formatting),
                   7728:     please make sure that the new license has a different name (e.g.,
                   7729:     append the version number if it exists, or the date).  Just
                   7730:     because a user told pkgsrc to build programs under a previous
                   7731:     version of a license does not mean that pkgsrc should build
1.99      rillig   7732:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7733:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7734:     test is a mechanistic test of whether a particular text has been
                   7735:     approved by either of two bodies.</p>
1.78      rillig   7736: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7737:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7738:     is deprecated because it does not crisply refer to a particular
                   7739:     license text.  Another problem with such usage is that it does not
                   7740:     enable a user to tell pkgsrc to proceed for a single package
                   7741:     without also telling pkgsrc to proceed for all packages with that
                   7742:     tag.</p>
1.75      rillig   7743: </div>
                   7744: <div class="sect2" lang="en">
                   7745: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7746: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7747: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7748:     Because a license tag is required unless the package is Free or
                   7749:     Open Source, all packages with restrictions should have license
                   7750:     tags.  By declaring the restrictions, package tools can
                   7751:     automatically refrain from e.g. placing binary packages on FTP
                   7752:     sites.</p>
                   7753: <p>There are four restrictions that may be encoded, which are
                   7754:     the cross product of sources (distfiles) and binaries not being
                   7755:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7756:     language in any license, and because non-Free licenses tend to be
                   7757:     different from each other, pkgsrc adopts a definition of FTP and
                   7758:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7759:     should not be made available over the Internet at no charge.
                   7760:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7761:     made available on some kind of media, together with other source
                   7762:     and binary packages, and which is sold for a distribution charge.
                   7763:     </p>
                   7764: <p>In order to encode these restrictions, the package system
1.87      wiz      7765:     defines five make variables that can be set to note these
                   7766:     restrictions:</p>
1.75      rillig   7767: <div class="itemizedlist"><ul type="disc">
                   7768: <li>
                   7769: <p><code class="varname">RESTRICTED</code></p>
                   7770: <p>This variable should be set whenever a restriction
1.87      wiz      7771:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7772:        string containing the reason for the restriction.  It should
                   7773:        be understood that those wanting to understand the restriction
                   7774:        will have to read the license, and perhaps seek advice of
                   7775:        counsel.</p>
1.75      rillig   7776: </li>
                   7777: <li>
                   7778: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7779: <p>Binaries may not be placed on CD-ROM containing other
                   7780:        binary packages, for which a distribution charge may be made.
                   7781:        In this case, set this variable to
                   7782:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7783: </li>
                   7784: <li>
                   7785: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7786: <p>Binaries may not made available on the Internet without
                   7787:        charge.  In this case, set this variable to
                   7788:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7789:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7790: </li>
                   7791: <li>
                   7792: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7793: <p>Distfiles may not be placed on CD-ROM, together with
                   7794:        other distfiles, for which a fee may be charged.  In this
                   7795:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7796:        </p>
1.75      rillig   7797: </li>
                   7798: <li>
                   7799: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7800: <p>Distfiles may not made available via FTP at no charge.
                   7801:        In this case, set this variable to
                   7802:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7803:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7804: </li>
                   7805: </ul></div>
                   7806: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7807:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7808:     generic make variables to denote restrictions is deprecated,
                   7809:     because they unconditionally prevent users from generating
                   7810:     binary packages!</p>
1.75      rillig   7811: </div>
                   7812: <div class="sect2" lang="en">
                   7813: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7814: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7815: <p>Your package may depend on some other package being present
1.88      wiz      7816:     - and there are various ways of expressing this dependency.
                   7817:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7818:     <code class="varname">DEPENDS</code> definitions, the
                   7819:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7820:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7821:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7822:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7823: <p>The basic difference between the two variables is as
1.87      wiz      7824:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7825:     that pre-requisite in the binary package so it will be pulled in
                   7826:     when the binary package is later installed, whilst the
                   7827:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7828:     dependency that is only needed for building the package.</p>
1.75      rillig   7829: <p>This means that if you only need a package present whilst
1.87      wiz      7830:     you are building, it should be noted as a
                   7831:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7832: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7833:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7834: <pre class="programlisting">
1.100     rillig   7835: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7836:     </pre>
1.75      rillig   7837: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7838:     may include any of the wildcard version numbers recognized by
1.110     hubertf  7839:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75      rillig   7840: <div class="orderedlist"><ol type="1">
                   7841: <li>
                   7842: <p>If your package needs another package's binaries or
1.87      wiz      7843:        libraries to build or run, and if that package has a
                   7844:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7845: <pre class="programlisting">
1.100     rillig   7846: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7847:        </pre>
1.75      rillig   7848: </li>
                   7849: <li>
                   7850: <p>If your package needs to use another package to build
1.87      wiz      7851:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7852:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7853:        definition:</p>
1.75      rillig   7854: <pre class="programlisting">
1.100     rillig   7855: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      7856:        </pre>
1.75      rillig   7857: </li>
                   7858: <li>
                   7859: <p>If your package needs a library with which to link and
1.76      rillig   7860:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7861:        available, this is specified using the
                   7862:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7863: <pre class="programlisting">
1.100     rillig   7864: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      7865:        </pre>
1.109     rillig   7866: <p>You can also use wildcards in package dependencies:</p>
1.75      rillig   7867: <pre class="programlisting">
1.100     rillig   7868: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      7869:        </pre>
1.75      rillig   7870: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7871:        creating binary packages.  The dependency is checked when
                   7872:        installing the binary package and any package which matches
                   7873:        the pattern will be used.  Wildcard dependencies should be
                   7874:        used with care.</p>
1.75      rillig   7875: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7876:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7877:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7878:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7879: <p>Wildcards can also be used to specify that a package
1.87      wiz      7880:        will only build against a certain minimum version of a
                   7881:        pre-requisite:</p>
1.75      rillig   7882: <pre class="programlisting">
1.100     rillig   7883: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      7884:        </pre>
1.75      rillig   7885: <p>This means that the package will build against version
1.87      wiz      7886:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7887:        be warranted if, for example, the API of the library has
                   7888:        changed with version 3.5.4 and a package would not compile
                   7889:        against an earlier version of tiff.</p>
1.75      rillig   7890: <p>Please note that such dependencies should only be
1.87      wiz      7891:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7892:        not to denote recommendations such as
1.87      wiz      7893:        ABI changes that do not prevent a package from building
                   7894:        correctly.  Such recommendations can be expressed using
                   7895:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7896: <pre class="programlisting">
1.100     rillig   7897: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      7898:        </pre>
1.75      rillig   7899: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7900:        line, this denotes that while a package will build against
                   7901:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7902:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7903:        dependencies unless explicitly ignored (in which case a
                   7904:        warning will be printed).</p>
1.75      rillig   7905: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7906:        use the required <code class="varname">DEPENDS</code>, set
                   7907:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7908:        it easier and faster to update packages built using pkgsrc,
                   7909:        since older compatible dependencies can continue to be
                   7910:        used. This is useful for people who watch their rebuilds
                   7911:        very carefully; it is not very good as a general-purpose
                   7912:        hammer.  If you use it, you need to be mindful of possible
                   7913:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7914: <p>Packages that are built with recommendations ignored
1.87      wiz      7915:        may not be uploaded to ftp.NetBSD.org by developers and
                   7916:        should not be used across different systems that may have
                   7917:        different versions of binary packages installed.</p>
1.75      rillig   7918: <p>For security fixes, please update the package
1.110     hubertf  7919:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7920:        information.</p>
1.75      rillig   7921: </li>
                   7922: <li>
                   7923: <p>If your package needs some executable to be able to run
1.87      wiz      7924:        correctly and if there's no
                   7925:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7926:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   7927:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87      wiz      7928:        be able to execute the latex binary from the teTeX package
                   7929:        when it runs, and that is specified:</p>
1.75      rillig   7930: <pre class="programlisting">
1.100     rillig   7931: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      7932:        </pre>
1.75      rillig   7933: <p>The comment about wildcard dependencies from previous
1.87      wiz      7934:        paragraph applies here, too.</p>
1.75      rillig   7935: </li>
                   7936: </ol></div>
                   7937: <p>If your package needs files from another package to build,
1.87      wiz      7938:     add the relevant distribution files to
                   7939:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   7940:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7941:     (It relies on the jpeg sources being present in source form
                   7942:     during the build.)</p>
1.75      rillig   7943: </div>
                   7944: <div class="sect2" lang="en">
                   7945: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7946: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7947: <p>Your package may conflict with other packages a user might
1.87      wiz      7948:     already have installed on his system, e.g. if your package
1.88      wiz      7949:     installs the same set of files as another package in the pkgsrc
                   7950:     tree.</p>
1.75      rillig   7951: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7952:     space-separated list of packages (including version string) your
                   7953:     package conflicts with.</p>
1.91      rillig   7954: <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>
                   7955:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87      wiz      7956:     install the same shared library, thus you set in
                   7957:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   7958: <pre class="programlisting">
1.100     rillig   7959: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      7960:     </pre>
                   7961: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   7962: <pre class="programlisting">
1.100     rillig   7963: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      7964:     </pre>
1.75      rillig   7965: <p>Packages will automatically conflict with other packages
1.87      wiz      7966:     with the name prefix and a different version
                   7967:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   7968:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   7969: </div>
                   7970: <div class="sect2" lang="en">
                   7971: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7972: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7973: <p>There are several reasons why a package might be
1.88      wiz      7974:     instructed to not build under certain circumstances.  If the
1.87      wiz      7975:     package builds and runs on most platforms, the exceptions
                   7976:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   7977:     the package builds and runs on a small handful of platforms,
                   7978:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   7979:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7980:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7981:     (OS-version-platform) that can use glob-style
                   7982:     wildcards.</p>
1.88      wiz      7983: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   7984:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7985:     backwards compatible with other versions of the OS, and should be
                   7986:     uploaded to a version specific directory on the FTP server.  Mark
                   7987:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   7988:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   7989:     the package system internals, but may be used in the
                   7990:     future.</p>
1.75      rillig   7991: <p>If the package should be skipped (for example, because it
1.87      wiz      7992:     provides functionality already provided by the system), set
1.88      wiz      7993:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7994:     the package should fail because some preconditions are not met,
                   7995:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7996:     message.</p>
1.75      rillig   7997: </div>
                   7998: <div class="sect2" lang="en">
                   7999: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8000: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8001: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8002:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8003:     be set in the package Makefile. This will be carried into any
                   8004:     binary package that is made from this pkgsrc entry. A
                   8005:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.110     hubertf  8006:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87      wiz      8007:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8008: </div>
                   8009: <div class="sect2" lang="en">
                   8010: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8011: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8012: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8013:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110     hubertf  8014:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87      wiz      8015:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8016: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8017:     <code class="varname">PKGREVISION</code> should be increased (this
                   8018:     is of course not necessary if the problem is fixed by using
                   8019:     a newer release of the software).</p>
1.75      rillig   8020: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8021:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8022: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8023:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8024: </div>
                   8025: <div class="sect2" lang="en">
                   8026: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8027: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   8028: <p>When making fixes to an existing package it can be useful
1.87      wiz      8029:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8030:     avoid conflicting with future versions by the original author, a
                   8031:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8032:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8033:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8034:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8035: <pre class="programlisting">
1.100     rillig   8036: DISTNAME=       foo-17.42
                   8037: PKGREVISION=    9
1.87      wiz      8038:     </pre>
1.75      rillig   8039: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8040:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8041:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8042:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8043:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8044: <p>When a new release of the package is released, the
1.87      wiz      8045:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8046:     minor release of the above package, things should be like:</p>
1.75      rillig   8047: <pre class="programlisting">
1.100     rillig   8048: DISTNAME=       foo-17.43
1.87      wiz      8049:     </pre>
                   8050: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8051:     non-trivial change in the resulting binary package.  Without a
                   8052:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8053:     version installed has no way of knowing that their package is out
                   8054:     of date.  Thus, changes without increasing
                   8055:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8056:     trivial that no reasonable person would want to upgrade", and this
                   8057:     is the rough test for when increasing
                   8058:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8059:     changes that do not merit increasing
                   8060:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8061: <div class="itemizedlist"><ul type="disc">
                   8062: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
                   8063:       or comments in Makefile.</p></li>
                   8064: <li><p>
                   8065:       Changing build variables if the resulting binary package is the same.</p></li>
                   8066: <li><p>
                   8067:       Changing <code class="filename">DESCR</code>.</p></li>
                   8068: <li><p>
                   8069:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8070: </ul></div>
1.87      wiz      8071: <p>Examples of changes that do merit an increase to
                   8072:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8073: <div class="itemizedlist"><ul type="disc">
                   8074: <li><p>
                   8075:       Security fixes</p></li>
                   8076: <li><p>
                   8077:       Changes or additions to a patch file</p></li>
                   8078: <li><p>
                   8079:       Changes to the <code class="filename">PLIST</code></p></li>
1.112     weinem   8080: <li><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8081: </ul></div>
1.78      rillig   8082: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8083:     changes.</p>
1.75      rillig   8084: </div>
1.79      rillig   8085: <div class="sect2" lang="en">
                   8086: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8087: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8088: <p>When you want to replace the same text in multiple files
1.87      wiz      8089:     or when the replacement text varies, patches alone cannot help.
                   8090:     This is where the SUBST framework comes in. It provides an
                   8091:     easy-to-use interface for replacing text in files.
                   8092:     Example:</p>
                   8093: <pre class="programlisting">
1.100     rillig   8094: SUBST_CLASSES+=                 fix-paths
                   8095: SUBST_STAGE.fix-paths=          pre-configure
                   8096: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8097: SUBST_FILES.fix-paths=          src/*.c
                   8098: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8099: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8100: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8101:     </pre>
1.79      rillig   8102: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8103:     that are used to identify the different SUBST blocks that are
                   8104:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8105:     important to always use the <code class="literal">+=</code> operator with
                   8106:     this variable. Otherwise some substitutions may be
                   8107:     skipped.</p>
1.79      rillig   8108: <p>The remaining variables of each SUBST block are
1.87      wiz      8109:     parameterized with the identifier from the first line
                   8110:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8111:     parameters to a function call.</p>
1.79      rillig   8112: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8113:     which the replacement will take place. All combinations of
                   8114:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8115:     <code class="literal">post-</code> together with a phase name are
                   8116:     possible, though only few are actually used. Most commonly used
                   8117:     are <code class="literal">post-patch</code> and
                   8118:     <code class="literal">pre-configure</code>. Of these two,
                   8119:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8120:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8121:     have the state after applying the patches but before making any
                   8122:     other changes. This is especially useful when you are debugging
                   8123:     a package in order to create new patches for it. Similarly,
                   8124:     <code class="literal">post-build</code> is preferred over
                   8125:     <code class="literal">pre-install</code>, because the install phase should
                   8126:     generally be kept as simple as possible. When you use
                   8127:     <code class="literal">post-build</code>, you have the same files in the
                   8128:     working directory that will be installed later, so you can check
                   8129:     if the substitution has succeeded.</p>
1.79      rillig   8130: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8131:     that is printed just before the substitution is done.</p>
1.79      rillig   8132: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8133:     globbing patterns that specifies the files in which the
                   8134:     substitution will take place. The patterns are interpreted
                   8135:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8136: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110     hubertf  8137:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8138:     command should be prefixed with <code class="literal">-e</code>, so that
                   8139:     all SUBST blocks look uniform.</p>
1.79      rillig   8140: <p>There are some more variables, but they are so seldomly
1.87      wiz      8141:     used that they are only documented in the
                   8142:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8143: </div>
1.75      rillig   8144: </div>
                   8145: <div class="sect1" lang="en">
                   8146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8147: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8148: <div class="sect2" lang="en">
                   8149: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8150: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8151: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8152:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8153:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8154:     with the name of each file to download as an argument, expecting
                   8155:     it to output the URL of the directory from which to download
1.91      rillig   8156:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8157:     example of this usage.</p>
1.75      rillig   8158: <p>If the download can't be automated, because the user must
1.87      wiz      8159:     submit personal information to apply for a password, or must pay
                   8160:     for the source, or whatever, you can set
                   8161:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8162:     displayed to the user before aborting the build. Example:</p>
                   8163: <pre class="programlisting">
1.100     rillig   8164: FETCH_MESSAGE=  "Please download the files"
                   8165: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8166: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8167:     </pre>
1.75      rillig   8168: </div>
                   8169: <div class="sect2" lang="en">
                   8170: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8171: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8172: <p>Sometimes authors of a software package make some
1.87      wiz      8173:     modifications after the software was released, and they put up a
                   8174:     new distfile without changing the package's version number. If a
                   8175:     package is already in pkgsrc at that time, the checksum will
                   8176:     no longer match. The contents of the new distfile should be
                   8177:     compared against the old one before changing anything, to make
                   8178:     sure the distfile was really updated on purpose, and that
                   8179:     no trojan horse or so crept in.
1.97      rillig   8180:     Please mention that the distfiles were compared and what was found
                   8181:     in your commit message.
1.87      wiz      8182:     Then, the correct way to work around this is to
                   8183:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8184:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8185:     <code class="varname">DISTFILES</code> and
1.93      rillig   8186:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8187:     subdirectory of the local distfiles directory.
1.110     hubertf  8188:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.97      rillig   8189:     In case this
1.87      wiz      8190:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8191:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8192:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8193:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8194:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8195:     path in the filenames.
1.97      rillig   8196:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8197:     Furthermore, a mail to the package's authors seems appropriate
                   8198:     telling them that changing distfiles after releases without
                   8199:     changing the file names is not good practice.</p>
1.75      rillig   8200: </div>
                   8201: </div>
                   8202: <div class="sect1" lang="en">
                   8203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8204: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8205: <div class="sect2" lang="en">
                   8206: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8207: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8208: <p>pkgsrc supports many different machines, with different
1.87      wiz      8209:     object formats like a.out and ELF, and varying abilities to do
                   8210:     shared library and dynamic loading at all. To accompany this,
                   8211:     varying commands and options have to be passed to the
                   8212:     compiler, linker, etc. to get the Right Thing, which can be
                   8213:     pretty annoying especially if you don't have all the machines
                   8214:     at your hand to test things.  The
1.91      rillig   8215:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87      wiz      8216:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8217:     both static and dynamic libraries from a set of source files,
                   8218:     thus being platform-independent.</p>
                   8219: <p>Here's how to use libtool in a package in seven simple
                   8220:     steps:</p>
1.75      rillig   8221: <div class="orderedlist"><ol type="1">
                   8222: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8223:        Makefile.</p></li>
1.75      rillig   8224: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8225:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8226:        add it to the definition of <code class="varname">CC</code>, if only
                   8227:        libraries are being built in a given Makefile. This one command
                   8228:        will build both PIC and non-PIC library objects, so you need not
                   8229:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8230: <li>
                   8231: <p>For the linking of the library, remove any
1.87      wiz      8232:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8233:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8234: <pre class="programlisting">
1.100     rillig   8235: ${LIBTOOL} --mode=link \
                   8236:     ${CC} -o ${.TARGET:.a=.la} \
                   8237:         ${OBJS:.o=.lo} \
                   8238:         -rpath ${PREFIX}/lib \
                   8239:         -version-info major:minor
1.87      wiz      8240:        </pre>
1.75      rillig   8241: <p>Note that the library is changed to have a
1.87      wiz      8242:        <code class="filename">.la</code> extension, and the objects are
                   8243:        changed to have a <code class="filename">.lo</code>
                   8244:        extension. Change <code class="varname">OBJS</code> as
                   8245:        necessary. This automatically creates all of the
                   8246:        <code class="filename">.a</code>,
                   8247:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8248:        necessary) in the build directory. Be sure to include
                   8249:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8250:        minor are zero, as libtool will otherwise strip off the
                   8251:        shared library version.</p>
1.75      rillig   8252: <p>From the libtool manual:</p>
                   8253: <pre class="programlisting">
1.100     rillig   8254: So, libtool library versions are described by three integers:
1.69      rillig   8255: 
1.100     rillig   8256: CURRENT
                   8257: The most recent interface number that this library implements.
1.69      rillig   8258: 
1.100     rillig   8259: REVISION
                   8260: The implementation number of the CURRENT interface.
1.69      rillig   8261: 
1.100     rillig   8262: AGE
                   8263: The difference between the newest and oldest interfaces that
                   8264: this library implements.  In other words, the library implements
                   8265: all the interface numbers in the range from number `CURRENT -
                   8266: AGE' to `CURRENT'.
1.1       grant    8267: 
1.100     rillig   8268: If two libraries have identical CURRENT and AGE numbers, then the
                   8269: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8270:        </pre>
1.75      rillig   8271: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8272:        different results for a.out and ELF (excluding symlinks)
                   8273:        in only one case. An ELF library of the form
                   8274:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8275:        will have a symlink of
                   8276:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8277:        on an a.out platform. This is handled
                   8278:        automatically.</p>
1.75      rillig   8279: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8280:        directory of the library being built.</p>
1.76      rillig   8281: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8282:        <code class="filename">.la</code> file, the other files will be
                   8283:        added automatically.</p>
1.75      rillig   8284: </li>
                   8285: <li>
1.76      rillig   8286: <p>When linking shared object (<code class="filename">.so</code>)
1.110     hubertf  8287:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87      wiz      8288:        shared libraries, use &#8220;<span class="quote">-module
                   8289:        -avoid-version</span>&#8221; to prevent them getting version
                   8290:        tacked on.</p>
1.76      rillig   8291: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8292:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8293: </li>
                   8294: <li>
                   8295: <p>When linking programs that depend on these libraries
1.87      wiz      8296:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.110     hubertf  8297:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8298:        --mode=link</span>&#8221;, and it will find the correct
                   8299:        libraries (static or shared), but please be aware that
                   8300:        libtool will not allow you to specify a relative path in
                   8301:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8302:        expects you to change that argument to be the
                   8303:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8304: <pre class="programlisting">
1.100     rillig   8305: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8306:        </pre>
1.75      rillig   8307: <p>should be changed to:</p>
                   8308: <pre class="programlisting">
1.100     rillig   8309: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8310:        </pre>
1.75      rillig   8311: <p>and it will do the right thing with the libraries.</p>
                   8312: </li>
                   8313: <li>
1.110     hubertf  8314: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8315:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8316:        --mode=install</span>&#8221;, and change the library name to
                   8317:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8318: <pre class="programlisting">
1.100     rillig   8319: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8320:        </pre>
1.76      rillig   8321: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8322:        shared library, any needed symlinks, and run
1.110     hubertf  8323:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8324: </li>
1.76      rillig   8325: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8326:        the <code class="filename">.la</code>
                   8327:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8328: </ol></div>
                   8329: </div>
                   8330: <div class="sect2" lang="en">
                   8331: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8332: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8333: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8334:     package Makefile. This will override the package's own libtool
                   8335:     in most cases.  For older libtool using packages,  libtool is
                   8336:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8337:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8338:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8339: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8340:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8341:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8342:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8343:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8344: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8345:     libraries built and installed, then use
                   8346:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8347: <p>If your package makes use of the platform-independent library
1.87      wiz      8348:     for loading dynamic shared objects, that comes with libtool
                   8349:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8350: <p>Some packages use libtool incorrectly so that the package
                   8351:     may not work or build in some circumstances. Some of the more
                   8352:     common errors are:</p>
1.75      rillig   8353: <div class="itemizedlist"><ul type="disc">
                   8354: <li>
                   8355: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8356:        executable or library. This in itself isn't a problem if one of two things
                   8357:        has been done:</p>
1.75      rillig   8358: <div class="orderedlist"><ol type="1">
                   8359: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8360:            <code class="filename">libfoo.la</code>, not
                   8361:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8362: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8363: </ol></div>
                   8364: </li>
                   8365: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8366:        The function lt_dlinit() should be called and the macro
                   8367:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8368:        executables.</p></li>
1.75      rillig   8369: </ul></div>
                   8370: </div>
                   8371: <div class="sect2" lang="en">
                   8372: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8373: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8374: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8375:     to regenerate the configure script and Makefile.in makefile
                   8376:     templates, then they should be executed in a pre-configure
                   8377:     target.</p>
1.75      rillig   8378: <p>For packages that need only autoconf:</p>
                   8379: <pre class="programlisting">
1.100     rillig   8380: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8381: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8382: ...
1.1       grant    8383: 
1.100     rillig   8384: pre-configure:
                   8385:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8386: 
1.100     rillig   8387: ...
1.87      wiz      8388:     </pre>
1.75      rillig   8389: <p>and for packages that need automake and autoconf:</p>
                   8390: <pre class="programlisting">
1.100     rillig   8391: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8392: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8393: ...
                   8394: 
                   8395: pre-configure:
                   8396:         set -e; cd ${WRKSRC}; \
                   8397:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8398: 
1.100     rillig   8399: ...
1.87      wiz      8400:     </pre>
1.75      rillig   8401: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8402:     require GNU Make.</p>
1.75      rillig   8403: <p>There are times when the configure process makes
1.87      wiz      8404:     additional changes to the generated files, which then causes
                   8405:     the build process to try to re-execute the automake sequence.
                   8406:     This is prevented by touching various files in the configure
                   8407:     stage. If this causes problems with your package you can set
                   8408:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8409:     Makefile.</p>
1.75      rillig   8410: </div>
                   8411: </div>
                   8412: <div class="sect1" lang="en">
                   8413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8414: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87      wiz      8415: <div class="sect2" lang="en">
                   8416: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8417: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8418: <p>Compilers for the C, C++, and Fortran languages comes with
                   8419:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8420:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8421:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8422: <p>To declare which language's compiler a package needs, set
                   8423:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8424:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8425:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8426:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8427:     written in C++, usually need a C compiler for the configure
                   8428:     phase.</p>
                   8429: </div>
                   8430: <div class="sect2" lang="en">
                   8431: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8432: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8433: <p>If a program is written in Java, use the Java framework in
                   8434:     pkgsrc.  The package must include
                   8435:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8436:     provides the following variables:</p>
                   8437: <div class="itemizedlist"><ul type="disc">
                   8438: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8439:       dependency on the JDK is added.  If
                   8440:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8441:       there is only a runtime dependency on the JDK.  The default is
                   8442:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8443:       JDK.</p></li>
                   8444: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8445:       a package needs a Java2 implementation.  The supported values
                   8446:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8447:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8448:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8449:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8450:       above. This variable is not set by default.</p></li>
                   8451: </ul></div>
                   8452: </div>
                   8453: <div class="sect2" lang="en">
                   8454: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8455: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8456: <p>If your package contains interpreted perl scripts, add
                   8457:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8458:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8459:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8460:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8461:     that you want adjusted.  Every occurrence of
                   8462:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8463:     path to the perl executable.</p>
                   8464: <p>If a particular version of perl is needed, set the
                   8465:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8466:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.110     hubertf  8467: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8468:     about handling perl modules.</p>
                   8469: </div>
                   8470: <div class="sect2" lang="en">
                   8471: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8472: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8473: <p>Currently, there is no special handling for other languages
                   8474:     in pkgsrc.  If a compiler package provides a
                   8475:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8476:     just add a (build) dependency on the appropriate compiler
                   8477:     package.</p>
                   8478: </div>
                   8479: </div>
                   8480: <div class="sect1" lang="en">
                   8481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8482: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8483: <p>The most common failures when building a package are that
                   8484:        some platforms do not provide certain header files, functions or
                   8485:        libraries, or they provide the functions in a library that the
                   8486:        original package author didn't know. To work around this, you
                   8487:        can rewrite the source code in most cases so that it does not
                   8488:        use the missing functions or provides a replacement function.</p>
                   8489: <div class="sect2" lang="en">
                   8490: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8491: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8492: <p>If a package already comes with a GNU configure script, the
                   8493:        preferred way to fix the build failure is to change the
                   8494:        configure script, not the code. In the other cases, you can
                   8495:        utilize the C preprocessor, which defines certain macros
                   8496:        depending on the operating system and hardware architecture it
                   8497:        compiles for. These macros can be queried using for example
                   8498:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8499:        system, hardware architecture and compiler has its own macro.
                   8500:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8501:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8502:        are all defined, you know that you are using NetBSD on an i386
                   8503:        compatible CPU, and your compiler is GCC.</p>
                   8504: <p>The list of the following macros for hardware and
                   8505:        operating system depends on the compiler that is used. For
                   8506:        example, if you want to conditionally compile code on Solaris,
                   8507:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8508:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8509: <div class="sect3" lang="en">
                   8510: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8511: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8512: <p>To distinguish between 4.4 BSD-derived systems and the
                   8513:         rest of the world, you should use the following code.</p>
                   8514: <pre class="programlisting">
1.100     rillig   8515: #include &lt;sys/param.h&gt;
                   8516: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8517: /* BSD-specific code goes here */
                   8518: #else
                   8519: /* non-BSD-specific code goes here */
                   8520: #endif
1.75      rillig   8521: </pre>
1.77      rillig   8522: <p>If this distinction is not fine enough, you can also test
                   8523:        for the following macros.</p>
1.75      rillig   8524: <pre class="programlisting">
1.100     rillig   8525: FreeBSD     __FreeBSD__
                   8526: DragonFly   __DragonFly__
                   8527: Interix     __INTERIX
                   8528: IRIX        __sgi (TODO: get a definite source for this)
                   8529: Linux       linux, __linux, __linux__
                   8530: NetBSD      __NetBSD__
                   8531: OpenBSD     __OpenBSD__
                   8532: Solaris     sun, __sun
1.75      rillig   8533: </pre>
                   8534: </div>
                   8535: <div class="sect3" lang="en">
                   8536: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8537: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8538: <pre class="programlisting">
1.100     rillig   8539: i386        i386, __i386, __i386__
                   8540: MIPS        __mips
                   8541: SPARC       sparc, __sparc
1.75      rillig   8542: </pre>
                   8543: </div>
                   8544: <div class="sect3" lang="en">
                   8545: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8546: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8547: <pre class="programlisting">
1.100     rillig   8548: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8549: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8550: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8551: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8552: </pre>
                   8553: </div>
                   8554: </div>
1.78      rillig   8555: <div class="sect2" lang="en">
                   8556: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8557: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8558: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8559:         combinations of compiler version and architecture and almost
                   8560:         always relation to optimisation being enabled.  Common symptoms
                   8561:         are gcc internal errors or never finishing compiling a
1.78      rillig   8562:        file.</p>
                   8563: <p>Typically, a workaround involves testing the
                   8564:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8565:         optimisation for that combination of file,
                   8566:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8567:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8568:        number of examples.</p>
                   8569: </div>
                   8570: <div class="sect2" lang="en">
                   8571: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8572: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8573: <p>This error message often means that a package did not
1.78      rillig   8574:        link to a shared library it needs. The following functions are
                   8575:        known to cause this error message over and over.</p>
                   8576: <div class="informaltable">
                   8577: <a name="undefined-reference-functions"></a><table border="1">
                   8578: <colgroup>
                   8579: <col>
                   8580: <col>
                   8581: <col>
                   8582: </colgroup>
                   8583: <thead><tr>
                   8584: <th>Function</th>
                   8585: <th>Library</th>
                   8586: <th>Affected platforms</th>
                   8587: </tr></thead>
                   8588: <tbody>
                   8589: <tr>
                   8590: <td>accept, bind, connect</td>
                   8591: <td>-lsocket</td>
                   8592: <td>Solaris</td>
                   8593: </tr>
                   8594: <tr>
                   8595: <td>crypt</td>
                   8596: <td>-lcrypt</td>
                   8597: <td>DragonFly, NetBSD</td>
                   8598: </tr>
                   8599: <tr>
                   8600: <td>dlopen, dlsym</td>
                   8601: <td>-ldl</td>
                   8602: <td>Linux</td>
                   8603: </tr>
                   8604: <tr>
                   8605: <td>gethost*</td>
                   8606: <td>-lnsl</td>
                   8607: <td>Solaris</td>
                   8608: </tr>
                   8609: <tr>
                   8610: <td>inet_aton</td>
                   8611: <td>-lresolv</td>
                   8612: <td>Solaris</td>
                   8613: </tr>
                   8614: <tr>
                   8615: <td>nanosleep, sem_*, timer_*</td>
                   8616: <td>-lrt</td>
                   8617: <td>Solaris</td>
                   8618: </tr>
                   8619: <tr>
                   8620: <td>openpty</td>
                   8621: <td>-lutil</td>
                   8622: <td>Linux</td>
                   8623: </tr>
                   8624: </tbody>
                   8625: </table>
                   8626: </div>
                   8627: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8628:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8629:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8630:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8631:     bmake</strong></span>.</p>
1.92      rillig   8632: <div class="sect3" lang="en">
                   8633: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8634: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8635: <p>When you are using the SunPro compiler, there is another
                   8636: possibility. That compiler cannot handle the following code:</p>
                   8637: <pre class="programlisting">
1.100     rillig   8638: extern int extern_func(int);
1.93      rillig   8639: 
1.100     rillig   8640: static inline int
                   8641: inline_func(int x)
                   8642: {
1.92      rillig   8643:         return extern_func(x);
1.100     rillig   8644: }
1.93      rillig   8645: 
1.100     rillig   8646: int main(void)
                   8647: {
1.92      rillig   8648:         return 0;
1.100     rillig   8649: }
1.92      rillig   8650: </pre>
                   8651: <p>It generates the code for <code class="function">inline_func</code> even if
                   8652: that function is never used. This code then refers to
                   8653: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8654: solve this problem you can try to tell the package to disable inlining
                   8655: of functions.</p>
                   8656: </div>
1.87      wiz      8657: </div>
                   8658: <div class="sect2" lang="en">
                   8659: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8660: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8661: <p>Sometimes packages fail to build because the compiler runs
                   8662:     into an operating system specific soft limit.  With the
                   8663:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8664:     to unlimit the resources.  Currently, the allowed values are
                   8665:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8666:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8667:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8668:     segment size or maximum stack size of a process, respectively, to
                   8669:     their hard limits.</p>
1.78      rillig   8670: </div>
1.75      rillig   8671: </div>
                   8672: <div class="sect1" lang="en">
                   8673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8674: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8675: <div class="sect2" lang="en">
                   8676: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8677: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8678: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8679:     with some operating systems cannot create more than one
                   8680:     directory at a time. As such, you should call
                   8681:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8682: <pre class="programlisting">
1.100     rillig   8683: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8684: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8685:     </pre>
1.78      rillig   8686: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8687:     dir2</code></span>&#8221; to the
                   8688:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8689:     automatically do the right thing.</p>
1.75      rillig   8690: </div>
                   8691: <div class="sect2" lang="en">
                   8692: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8693: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8694: <p>In general, documentation should be installed into
1.87      wiz      8695:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8696:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8697:     includes the version number of the package).</p>
1.84      wiz      8698: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8699:     directory where HTML documentation is installed with the
                   8700:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8701:     is needed because otherwise the documentation ends up in
                   8702:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8703:     places.</p>
                   8704: <p>An exception to the above is that library API documentation
1.91      rillig   8705:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8706:     browsers (devhelp) should be left at their default location, which
                   8707:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8708:     documentation can be recognized from files ending in
                   8709:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8710:     (It is also acceptable to install such files in
                   8711:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8712:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8713:     <code class="filename">.devhelp*</code> file must be directly in that
                   8714:     directory then, no additional subdirectory level is allowed in
                   8715:     this case. This is usually achieved by using
                   8716:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8717:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8718:     though.)</p>
1.75      rillig   8719: </div>
                   8720: <div class="sect2" lang="en">
                   8721: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8722: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8723: <p>Certain packages, most of them in the games category, install
1.87      wiz      8724:     a score file that allows all users on the system to record their
                   8725:     highscores.  In order for this to work, the binaries need to be
                   8726:     installed setgid and the score files owned by the appropriate
                   8727:     group and/or owner (traditionally the "games" user/group).  The
                   8728:     following variables, documented in more detail in
                   8729:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8730:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8731:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8732:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8733: <p>Note that per default, setgid installation of games is
1.87      wiz      8734:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8735:     the other variables accordingly.</p>
1.75      rillig   8736: <p>A package should therefor never hard code file ownership or
1.87      wiz      8737:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8738:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8739:     correctly.</p>
1.75      rillig   8740: </div>
                   8741: <div class="sect2" lang="en">
                   8742: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8743: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.103     wiz      8744: <div class="itemizedlist"><ul type="disc">
                   8745: <li><p>All installation operations have to be prefixed with
                   8746:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8747: <li><p>automake gets this DESTDIR mostly right
                   8748:       automatically. Many manual rules and pre/post-install often are
                   8749:       incorrect; fix them.</p></li>
                   8750: <li><p>If files are installed with special owner/group
                   8751:       either use @owner/@group in the <code class="filename">PLIST</code>
                   8752:       (preferred) or use <code class="varname">SPECIAL_PERMS</code>
                   8753:       (discouraged). Note that @owner/@group are sticky during
                   8754:       install, keep this in mind.</p></li>
                   8755: <li><p>In general, packages should support
                   8756:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8757:       DESTDIR.</p></li>
                   8758: </ul></div>
                   8759: </div>
                   8760: <div class="sect2" lang="en">
                   8761: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8762: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8763: <p>Your package may also contain scripts with hardcoded paths to
                   8764:       other interpreters besides (or as well as) perl.  To correct the
                   8765:       full pathname to the script interpreter, you need to set the
                   8766:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8767:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8768: <pre class="programlisting">
1.100     rillig   8769: REPLACE_INTERPRETER+=   tcl
                   8770: REPLACE.tcl.old=        .*/bin/tclsh
                   8771: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8772: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8773: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8774:     </pre>
1.75      rillig   8775: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8776: <h3 class="title">Note</h3>
                   8777: <p>Before March 2006, these variables were called
1.87      wiz      8778:     <code class="varname">_REPLACE.*</code> and
                   8779:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8780: </div>
                   8781: </div>
                   8782: <div class="sect2" lang="en">
                   8783: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8784: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8785: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8786:     the Makefile fragment
                   8787:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8788:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8789:     configuration for such modules as well as various hooks to tune
                   8790:     this configuration.  See comments in this file for
                   8791:     details.</p>
1.75      rillig   8792: <p>Perl5 modules will install into different places depending
1.87      wiz      8793:     on the version of perl used during the build process.  To
                   8794:     address this, pkgsrc will append lines to the
                   8795:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8796:     the installed <code class="filename">.packlist</code> file generated by
                   8797:     most perl5 modules.  This is invoked by defining
                   8798:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8799:     paths to packlist files, e.g.:</p>
1.75      rillig   8800: <pre class="programlisting">
1.100     rillig   8801: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8802:     </pre>
1.75      rillig   8803: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8804:     <code class="varname">PERL5_SITEARCH</code>, and
                   8805:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8806:     in which perl5 modules may be installed, and may be used by
                   8807:     perl5 packages that don't have a packlist.  These three
                   8808:     variables are also substituted for in the
                   8809:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8810: </div>
                   8811: <div class="sect2" lang="en">
                   8812: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8813: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8814: <p>Some packages install info files or use the
1.87      wiz      8815:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8816:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8817:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8818:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8819:     handle registration of the info files in the Info directory
                   8820:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8821:     files registration is either provided by the system, or by a
                   8822:     special purpose package automatically added as dependency if
                   8823:     needed.</p>
1.75      rillig   8824: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8825:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8826:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8827:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8828: <p>The info files for the package should be listed in the
1.87      wiz      8829:     package <code class="filename">PLIST</code>; however any split info files
                   8830:     need not be listed.</p>
1.75      rillig   8831: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8832:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8833:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8834:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8835:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8836:     variable in the package <code class="filename">Makefile</code>. By
                   8837:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8838:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8839:     does not match the required minimum, a build dependency on the
1.91      rillig   8840:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8841:     be added automatically.</p>
1.75      rillig   8842: <p>The build and installation process of the software provided
1.87      wiz      8843:     by the package should not use the
1.110     hubertf  8844:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8845:     info files is the task of the package
                   8846:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8847:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8848: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8849:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8850:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8851:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8852: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8853:     no effect except the logging of a message. The script overriding
1.110     hubertf  8854:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8855:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8856:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8857: </div>
                   8858: <div class="sect2" lang="en">
                   8859: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8860: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8861: <p>All packages that install manual pages should install them
1.87      wiz      8862:     into the same directory, so that there is one common place to look
                   8863:     for them. In pkgsrc, this place is
                   8864:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8865:     should be used in packages. The default for
                   8866:     <code class="varname">PKGMANDIR</code> is
                   8867:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8868:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8869: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8870: <h3 class="title">Note</h3>
1.87      wiz      8871: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8872:     is far from complete.</p>
1.75      rillig   8873: </div>
1.81      rillig   8874: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8875:     <code class="filename">man/</code> as the top level directory for the man
                   8876:     page file entries, and the pkgsrc framework will convert as
                   8877:     needed. In all other places, the correct
                   8878:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8879: <p>Packages that are
                   8880:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8881:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8882:     <code class="filename">./configure</code>
                   8883:     --mandir switch to set where the man pages should be installed.
                   8884:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8885:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8886: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8887:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8888:     to &#8220;<span class="quote">no</span>&#8221;.
                   8889:     Or if the <code class="filename">./configure</code> script uses
                   8890:     a non-standard use of --mandir, you can set
                   8891:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8892: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8893:     information on installation of compressed manual pages.</p>
1.75      rillig   8894: </div>
                   8895: <div class="sect2" lang="en">
                   8896: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8897: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8898: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8899:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8900:     you need to take some extra steps to make sure they get registered
                   8901:     in the database:</p>
1.75      rillig   8902: <div class="orderedlist"><ol type="1">
1.107     rillig   8903: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8904:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8905:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8906:        deinstallation time, and tells the package where to install
1.107     rillig   8907:        GConf data files using some standard configure arguments.  It
1.87      wiz      8908:        also disallows any access to the database directly from the
                   8909:        package.</p></li>
1.75      rillig   8910: <li><p>Ensure that the package installs its
1.87      wiz      8911:        <code class="filename">.schemas</code> files under
                   8912:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8913:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8914:        need to manually patch the package.</p></li>
1.75      rillig   8915: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8916:        directory, as they will be handled automatically.  See
1.110     hubertf  8917:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.107     rillig   8918: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8919:        your <code class="filename">Makefile</code> with a list of all
                   8920:        <code class="filename">.schemas</code> files installed by the package, if
                   8921:        any.  Names must not contain any directories in them.</p></li>
1.107     rillig   8922: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8923:        your <code class="filename">Makefile</code> with a
                   8924:        list of all <code class="filename">.entries</code> files installed by the
                   8925:        package, if any. Names must not contain any directories in
                   8926:        them.</p></li>
1.75      rillig   8927: </ol></div>
                   8928: </div>
                   8929: <div class="sect2" lang="en">
                   8930: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8931: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      8932: <p>If a package installs <code class="filename">.omf</code> files, used by
                   8933:     scrollkeeper, you need to take some extra steps to make sure they
                   8934:     get registered in the database:</p>
1.75      rillig   8935: <div class="orderedlist"><ol type="1">
                   8936: <li><p>Include
1.87      wiz      8937:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   8938:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8939:        takes care of rebuilding the scrollkeeper database at
                   8940:        installation and deinstallation time, and disallows any access
                   8941:        to it directly from the package.</p></li>
1.75      rillig   8942: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      8943:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8944:        will be handled automatically.</p></li>
1.76      rillig   8945: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      8946:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   8947: </ol></div>
                   8948: </div>
                   8949: <div class="sect2" lang="en">
                   8950: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8951: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8952: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8953:     the fonts database in the directory where they get installed at
                   8954:     installation and deinstallation time.  This can be automatically
                   8955:     done by using the pkginstall framework.</p>
1.75      rillig   8956: <p>You can list the directories where fonts are installed in the
1.87      wiz      8957:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8958:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   8959:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   8960:     Also make sure that the database file
                   8961:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8962: <p>Note that you should not create new directories for fonts;
1.87      wiz      8963:     instead use the standard ones to avoid that the user needs to
                   8964:     manually configure his X server to find them.</p>
1.75      rillig   8965: </div>
                   8966: <div class="sect2" lang="en">
                   8967: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8968: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8969: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8970:     take some extra steps to get them registered in the GTK2 database
                   8971:     properly:</p>
1.75      rillig   8972: <div class="orderedlist"><ol type="1">
                   8973: <li><p>Include
1.87      wiz      8974:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8975:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8976:       rebuilding the database at installation and deinstallation time.</p></li>
                   8977: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   8978:       your package installs GTK2 immodules.</p></li>
                   8979: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   8980:       GTK2 loaders.</p></li>
1.75      rillig   8981: <li>
1.87      wiz      8982: <p>Patch the package to not touch any of the GTK2
                   8983:       databases directly.  These are:</p>
1.75      rillig   8984: <div class="itemizedlist"><ul type="disc">
1.76      rillig   8985: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8986: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8987: </ul></div>
                   8988: </li>
1.87      wiz      8989: <li><p>Check the <code class="filename">PLIST</code> and remove
                   8990:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8991:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8992: </ol></div>
                   8993: </div>
                   8994: <div class="sect2" lang="en">
                   8995: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8996: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8997: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8998:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8999:     etc.), you need to take some extra steps:</p>
1.75      rillig   9000: <div class="orderedlist"><ol type="1">
                   9001: <li><p>Include
1.87      wiz      9002:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9003:        your <code class="filename">Makefile</code>, which takes care of
                   9004:        registering those files in system-wide catalogs at
                   9005:        installation and deinstallation time.</p></li>
1.75      rillig   9006: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9007:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9008: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9009:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9010: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9011:        to be added to the SGML catalog.  These come in groups of
                   9012:        three strings; see xmlcatmgr(1) for more information
                   9013:        (specifically, arguments recognized by the 'add' action).
                   9014:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9015: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9016:        to be added to the XML catalog.  These come in groups of three
                   9017:        strings; see xmlcatmgr(1) for more information (specifically,
                   9018:        arguments recognized by the 'add' action).  Note that you will
                   9019:        normally not use this variable.</p></li>
1.75      rillig   9020: </ol></div>
                   9021: </div>
                   9022: <div class="sect2" lang="en">
                   9023: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9024: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9025: <p>If a package provides extensions to the MIME database by
1.87      wiz      9026:     installing <code class="filename">.xml</code> files inside
                   9027:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9028:     need to take some extra steps to ensure that the database is kept
                   9029:     consistent with respect to these new files:</p>
1.75      rillig   9030: <div class="orderedlist"><ol type="1">
                   9031: <li><p>Include
1.87      wiz      9032:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9033:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9034:        this same directory, which is reserved for inclusion from
                   9035:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9036:        care of rebuilding the MIME database at installation and
                   9037:        deinstallation time, and disallows any access to it directly
                   9038:        from the package.</p></li>
1.75      rillig   9039: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9040:        <code class="filename">share/mime</code> directory,
                   9041:        <span class="emphasis"><em>except</em></span> for files saved under
                   9042:        <code class="filename">share/mime/packages</code>.  The former are
                   9043:        handled automatically by
                   9044:        the update-mime-database program, but the latter are
                   9045:        package-dependent and must be removed by the package that
                   9046:        installed them in the first place.</p></li>
1.76      rillig   9047: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9048:        from the PLIST.  They will be handled by the shared-mime-info
                   9049:        package.</p></li>
1.75      rillig   9050: </ol></div>
                   9051: </div>
                   9052: <div class="sect2" lang="en">
                   9053: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9054: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9055: <p>If a package uses intltool during its build, add
                   9056:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9057:     which forces it to use the intltool package provided by pkgsrc,
                   9058:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9059: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9060:     latest available version; this way, the package benefits of any
                   9061:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9062: </div>
                   9063: <div class="sect2" lang="en">
                   9064: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9065: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9066: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9067:     the startup directory by default, but you can enable it, by adding
                   9068:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9069:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9070:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9071:     it will automatically remove the scripts when the package is
                   9072:     deinstalled.</p>
1.75      rillig   9073: </div>
                   9074: <div class="sect2" lang="en">
                   9075: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9076: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9077: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9078:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9079:     updated.</p>
1.75      rillig   9080: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9081: <h3 class="title">Note</h3>
                   9082: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9083:     packages should install files
                   9084:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9085:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9086: </div>
                   9087: <div class="orderedlist"><ol type="1">
                   9088: <li><p>Include
1.87      wiz      9089:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9090:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9091:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9092:       database at installation and deinstallation time.</p></li>
1.75      rillig   9093: <li>
                   9094: <p>If your package installs files into a texmf
1.87      wiz      9095:       tree other than the one
                   9096:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9097:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9098:       trees that need database update.</p>
1.75      rillig   9099: <p>If your package also installs font map files that need
1.110     hubertf  9100:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.87      wiz      9101:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110     hubertf  9102:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9103:       be run automatically at installation/deinstallation to
                   9104:       enable/disable font map files for TeX output
                   9105:       drivers.</p>
1.75      rillig   9106: </li>
1.76      rillig   9107: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9108:       databases are included in <code class="filename">PLIST</code>, as
                   9109:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9110: </ol></div>
                   9111: </div>
1.85      jmmv     9112: <div class="sect2" lang="en">
                   9113: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9114: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9115:     emulation</h3></div></div></div>
                   9116: <p>There are some packages that provide libraries and
                   9117:     executables for running binaries from a one operating system
                   9118:     on a different one (if the latter supports it).  One example
                   9119:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9120: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9121:     helps in extracting and packaging Linux rpm packages.</p>
                   9122: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9123:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9124:     if all libraries for each installed executable can be found by
                   9125:     the dynamic linker.  Since the standard dynamic linker is run,
                   9126:     this fails for emulation packages, because the libraries used
                   9127:     by the emulation are not in the standard directories.</p>
                   9128: </div>
                   9129: <div class="sect2" lang="en">
                   9130: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9131: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9132: <p>If a package installs images under the
1.87      wiz      9133:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9134:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9135:     database, you need to take some extra steps to make sure that the
                   9136:     shared theme directory is handled appropriately and that the cache
                   9137:     database is rebuilt:</p>
1.85      jmmv     9138: <div class="orderedlist"><ol type="1">
                   9139: <li><p>Include
1.87      wiz      9140:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9141: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9142:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9143: <li><p>Ensure that the PLIST does not remove the shared icon
                   9144:          directories from the <code class="filename">share/icons/hicolor</code>
                   9145:          hierarchy because they will be handled automatically.</p></li>
                   9146: </ol></div>
                   9147: <p>The best way to verify that the PLIST is correct with
                   9148:       respect to the last two points is to regenerate it using
1.110     hubertf  9149:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9150: </div>
                   9151: <div class="sect2" lang="en">
                   9152: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9153: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9154: <p>If a package installs <code class="filename">.desktop</code> files
                   9155:       under <code class="filename">share/applications</code> and these include
                   9156:       MIME information, you need to take extra steps to ensure that they
                   9157:       are registered into the MIME database:</p>
                   9158: <div class="orderedlist"><ol type="1">
                   9159: <li><p>Include
                   9160:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9161: <li><p>Check the PLIST and remove the entry that refers to the
                   9162:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9163:          It will be handled automatically.</p></li>
                   9164: </ol></div>
                   9165: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9166:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9167:       print-PLIST</strong></span>.</p>
1.75      rillig   9168: </div>
                   9169: </div>
1.87      wiz      9170: <div class="sect1" lang="en">
                   9171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9172: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9173: <p>In some cases one does not have the time to solve a problem
                   9174:   immediately.  There are currently two ways to declare that one knows
                   9175:   that a package has problems.</p>
                   9176: <div class="itemizedlist"><ul type="disc">
                   9177: <li><p>The first way is to plainly mark it as broken.  For
                   9178:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9179:     reason why the package is broken (similar to the
                   9180:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9181:     the package will immediately be shown this message, and the build
                   9182:     will not be even tried.</p></li>
                   9183: <li><p>After each pkgsrc freeze period (a time when the
                   9184:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9185:     that were not building in the official branch build on the latest
                   9186:     NetBSD release will be marked as broken on that branch.  This is
                   9187:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9188:     branch name (or appending the branch name to it).  If a user tries
                   9189:     to build such a package and the build fails, the user gets a
                   9190:     message that says that the package was broken on the respective
                   9191:     branch(es).</p></li>
                   9192: </ul></div>
                   9193: <p>Both types of packages are removed from pkgsrc in irregular
                   9194:   intervals.</p>
                   9195: </div>
1.75      rillig   9196: </div>
                   9197: <div class="chapter" lang="en">
                   9198: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9199: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9200: <p>To check out all the gotchas when building a package, here are
                   9201:   the steps that I do in order to get a package working.  Please note
                   9202:   this is basically the same as what was explained in the previous
                   9203:   sections, only with some debugging aids.</p>
1.75      rillig   9204: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9205: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.75      rillig   9206: <li>
1.91      rillig   9207: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9208:       create a directory for a new package, change into it, then run
1.110     hubertf  9209:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9210: <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>
                   9211: <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>
                   9212: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9213: </li>
1.76      rillig   9214: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9215: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110     hubertf  9216: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75      rillig   9217: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9218:       configure step to the package's
                   9219:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9220: <li>
                   9221: <p>Make the package compile, doing multiple rounds of</p>
                   9222: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9223: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9224: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9225: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9226: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9227: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9228: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9229: <p>Doing this step as non-root user will ensure that no files
                   9230:       are modified that shouldn't be, especially during the build
1.110     hubertf  9231:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9232:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9233:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9234:       package.</p>
1.75      rillig   9235: </li>
1.88      wiz      9236: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.110     hubertf  9237:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.75      rillig   9238: <li>
1.76      rillig   9239: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9240: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9241: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9242: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9243: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9244: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9245: <p>You usually need to be <code class="username">root</code> to do
                   9246:       this.  Look if there are any files left:</p>
1.75      rillig   9247: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9248: <p>If this reveals any files that are missing in
1.88      wiz      9249:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9250: </li>
                   9251: <li>
1.88      wiz      9252: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9253:       package again and make a binary package:</p>
1.75      rillig   9254: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9255: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9256: </li>
                   9257: <li>
                   9258: <p>Delete the installed package:</p>
1.88      wiz      9259: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9260: </li>
                   9261: <li>
1.110     hubertf  9262: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9263:       command, which shouldn't find anything now:</p>
1.75      rillig   9264: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9265: </li>
                   9266: <li>
                   9267: <p>Reinstall the binary package:</p>
1.93      rillig   9268: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9269: </li>
1.88      wiz      9270: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9271: <li>
1.110     hubertf  9272: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9273:       reports:</p>
1.75      rillig   9274: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9275: </li>
1.110     hubertf  9276: <li><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9277: </ul></div>
                   9278: </div>
                   9279: <div class="chapter" lang="en">
                   9280: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9281: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9282: <div class="toc">
                   9283: <p><b>Table of Contents</b></p>
                   9284: <dl>
1.106     rillig   9285: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9286: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9287: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9288: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9289: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   9290: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9291: </dl>
                   9292: </div>
                   9293: <div class="sect1" lang="en">
                   9294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9295: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9296: <p>Our policy is that we accept binaries only from pkgsrc
                   9297:        developers to guarantee that the packages don't contain any
                   9298:        trojan horses etc. This is not to annoy anyone but rather to
                   9299:        protect our users! You're still free to put up your home-made
                   9300:        binary packages and tell the world where to get them. NetBSD
                   9301:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9302:        see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.75      rillig   9303: </div>
                   9304: <div class="sect1" lang="en">
                   9305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9306: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9307: <p>First, check that your package is complete, compiles and
1.110     hubertf  9308:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9309:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9310:        archive that contains all files that make up the package.
1.87      wiz      9311:        Finally, send this package to the pkgsrc bug tracking system,
1.110     hubertf  9312:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9313:        that, go to the web page
1.110     hubertf  9314:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87      wiz      9315:        which contains some instructions and a link to a form, where you
                   9316:        can submit packages.</p>
                   9317: <p>In the form of the problem report, the category should be
                   9318:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9319:        and version number, and the description field should contain a
                   9320:        short description of your package (contents of the COMMENT
                   9321:        variable or DESCR file are OK). The uuencoded package data should
                   9322:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9323: <p>If you want to submit several packages, please send a
                   9324:        separate PR for each one, it's easier for us to track things
                   9325:        that way.</p>
                   9326: <p>Alternatively, you can also import new packages into
                   9327:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.110     hubertf  9328:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9329:        for details.</p>
                   9330: </div>
                   9331: <div class="sect1" lang="en">
                   9332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9333: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9334: <p>Please note all package additions, updates, moves, and
1.93      rillig   9335:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9336:        important to keep this file up to date and conforming to the
                   9337:        existing format, because it will be used by scripts to
1.110     hubertf  9338:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9339:        sites. Additionally, check the
1.76      rillig   9340:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9341:        for the package you updated or removed, in case it was mentioned
                   9342:        there.</p>
                   9343: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9344:        bumped, the change should appear in
1.93      rillig   9345:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9346:        related or otherwise relevant. Mass bumps that result from a
                   9347:        dependency being updated should not be mentioned. In all other
                   9348:        cases it's the developer's decision.</p>
                   9349: <p>There is a make target that helps in creating proper
1.110     hubertf  9350:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9351:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9352:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9353:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9354:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9355:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9356:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9357:   For new packages, or package moves or removals, set the
                   9358:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9359:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9360:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75      rillig   9361:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9362:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9363: </div>
                   9364: <div class="sect1" lang="en">
                   9365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9366: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9367: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9368:   access to the pkgsrc repository. Please remember that cvs
                   9369:   imports files relative to the current working directory, and that
                   9370:   the pathname that you
1.110     hubertf  9371:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75      rillig   9372:   to place the files in the repository.  Newly created packages should be
                   9373:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9374:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9375: <pre class="programlisting">
1.100     rillig   9376: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9377: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9378: </pre>
1.87      wiz      9379: <p>Remember to move the directory from which you imported out of
1.75      rillig   9380:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9381:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9382:   package to the category's <code class="filename">Makefile</code>.</p>
                   9383: <p>The commit message of the initial import should include part of the
1.76      rillig   9384:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9385:   what the package is/does.</p>
                   9386: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9387:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9388:   and provides a consistent tag.</p>
1.75      rillig   9389: </div>
                   9390: <div class="sect1" lang="en">
                   9391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9392: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9393: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9394:   changes between old and new versions into the commit log when updating
1.87      wiz      9395:   a package. There are various reasons for this:</p>
1.75      rillig   9396: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9397: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9398:   or its information may be overwritten by newer information.</p></li>
                   9399: <li><p>Having the change information between old and new versions in our CVS
                   9400:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9401: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9402:   repository is very useful for people who read the pkgsrc-changes mailing
                   9403:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9404:   the package.</p></li>
1.75      rillig   9405: </ul></div>
1.87      wiz      9406: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9407:   has been released, it should not automatically be upgraded in the CVS
                   9408:   repository.  We prefer to be conservative in the packages that are
                   9409:   included in pkgsrc - development or beta packages are not really the
                   9410:   best thing for most places in which pkgsrc is used. Please use your
                   9411:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9412:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9413: </div>
                   9414: <div class="sect1" lang="en">
                   9415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9416: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9417: <div class="orderedlist"><ol type="1">
                   9418: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9419: <li>
                   9420: <p>Remove all CVS dirs.</p>
1.87      wiz      9421: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9422: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9423: <p>and use that for further work.</p>
1.75      rillig   9424: </li>
                   9425: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9426: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9427: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.110     hubertf  9428: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9429: place.</p></li>
                   9430: <li>
                   9431: <p>Check if any package depends on it:
                   9432: </p>
                   9433: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9434: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9435: </li>
                   9436: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110     hubertf  9437: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9438: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9439: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9440: <li>
                   9441: <p>Commit the changed and removed files:</p>
                   9442: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9443: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9444: </li>
                   9445: </ol></div>
                   9446: </div>
                   9447: </div>
                   9448: <div class="chapter" lang="en">
                   9449: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9450: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9451: <p>This section contains the answers to questions that may
                   9452:        arise when you are writing a package. If you don't find your
                   9453:        question answered here, first have a look in the other chapters,
                   9454:        and if you still don't have the answer, ask on the
                   9455:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9456: <div class="qandaset">
                   9457: <dl>
1.106     rillig   9458: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9459:        MAKEFLAGS, .MAKEFLAGS and
                   9460:        MAKE_FLAGS?</a>
                   9461: </dt>
1.106     rillig   9462: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9463:        MAKE, GMAKE and
                   9464:        MAKE_PROGRAM?</a>
                   9465: </dt>
1.106     rillig   9466: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9467:        CC, PKG_CC and
                   9468:        PKGSRC_COMPILER?</a>
                   9469: </dt>
1.106     rillig   9470: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9471:        BUILDLINK_LDFLAGS,
                   9472:        BUILDLINK_LDADD and
                   9473:        BUILDLINK_LIBS?</a>
                   9474: </dt>
1.106     rillig   9475: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9476:        VARNAME=BUILDLINK_PREFIX.foo
                   9477:        say it's empty?</a>
                   9478: </dt>
1.106     rillig   9479: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9480:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9481:        don't understand the := inside
                   9482:        it.</a>
                   9483: </dt>
1.106     rillig   9484: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9485:        developers?</a>
                   9486: </dt>
1.106     rillig   9487: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9488:        documentation?</a>
                   9489: </dt>
1.106     rillig   9490: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9491: do?</a>
                   9492: </dt>
1.75      rillig   9493: </dl>
                   9494: <table border="0" summary="Q and A Set">
                   9495: <col align="left" width="1%">
                   9496: <tbody>
                   9497: <tr class="question">
                   9498: <td align="left" valign="top">
1.113   ! weinem   9499: <a name="devfaq.makeflags"></a><a name="id2733644"></a><p><b>22.1.</b></p>
1.75      rillig   9500: </td>
                   9501: <td align="left" valign="top"><p>What is the difference between
                   9502:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9503:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9504: </tr>
                   9505: <tr class="answer">
1.91      rillig   9506: <td align="left" valign="top"></td>
1.75      rillig   9507: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110     hubertf  9508:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9509:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9510:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9511:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9512: </tr>
                   9513: <tr class="question">
                   9514: <td align="left" valign="top">
1.113   ! weinem   9515: <a name="devfaq.make"></a><a name="id2733683"></a><p><b>22.2.</b></p>
1.75      rillig   9516: </td>
                   9517: <td align="left" valign="top"><p>What is the difference between
                   9518:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9519:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9520: </tr>
                   9521: <tr class="answer">
1.91      rillig   9522: <td align="left" valign="top"></td>
1.75      rillig   9523: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110     hubertf  9524:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9525:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9526:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9527:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9528:        Make program that is used for building the
                   9529:        package.</p></td>
                   9530: </tr>
                   9531: <tr class="question">
                   9532: <td align="left" valign="top">
1.113   ! weinem   9533: <a name="devfaq.cc"></a><a name="id2733723"></a><p><b>22.3.</b></p>
1.75      rillig   9534: </td>
                   9535: <td align="left" valign="top"><p>What is the difference between
                   9536:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9537:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9538: </tr>
                   9539: <tr class="answer">
1.91      rillig   9540: <td align="left" valign="top"></td>
1.75      rillig   9541: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9542:        compiler, which can be configured by the pkgsrc user.
                   9543:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9544:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9545:        path to a compiler, but the type of compiler that should be
1.76      rillig   9546:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9547:        information about the latter variable.</p></td>
                   9548: </tr>
                   9549: <tr class="question">
                   9550: <td align="left" valign="top">
1.113   ! weinem   9551: <a name="devfaq.bl3flags"></a><a name="id2733831"></a><p><b>22.4.</b></p>
1.75      rillig   9552: </td>
                   9553: <td align="left" valign="top"><p>What is the difference between
                   9554:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9555:        <code class="varname">BUILDLINK_LDADD</code> and
                   9556:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9557: </tr>
                   9558: <tr class="answer">
1.91      rillig   9559: <td align="left" valign="top"></td>
1.75      rillig   9560: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9561: </tr>
                   9562: <tr class="question">
                   9563: <td align="left" valign="top">
1.113   ! weinem   9564: <a name="devfaq.bl3prefix"></a><a name="id2733851"></a><p><b>22.5.</b></p>
1.75      rillig   9565: </td>
1.110     hubertf  9566: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9567:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9568:        say it's empty?</p></td>
                   9569: </tr>
                   9570: <tr class="answer">
1.91      rillig   9571: <td align="left" valign="top"></td>
1.75      rillig   9572: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9573:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9574:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.110     hubertf  9575:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9576:        command.</p></td>
                   9577: </tr>
1.78      rillig   9578: <tr class="question">
                   9579: <td align="left" valign="top">
1.113   ! weinem   9580: <a name="devfaq.master_sites"></a><a name="id2733881"></a><p><b>22.6.</b></p>
1.78      rillig   9581: </td>
                   9582: <td align="left" valign="top"><p>What does
                   9583:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9584:        don't understand the <code class="literal">:=</code> inside
                   9585:        it.</p></td>
                   9586: </tr>
                   9587: <tr class="answer">
1.91      rillig   9588: <td align="left" valign="top"></td>
1.78      rillig   9589: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9590:        assignment operator, like you might expect at first sight.
                   9591:        Instead, it is a degenerate form of
                   9592:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110     hubertf  9593:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9594:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9595:        case of <code class="varname">MASTER_SITE_*</code>,
                   9596:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9597:        <em class="replaceable"><code>new_string</code></em> is
                   9598:        <code class="literal">package/</code>. That's where the
                   9599:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9600:        together.</p></td>
                   9601: </tr>
                   9602: <tr class="question">
                   9603: <td align="left" valign="top">
1.113   ! weinem   9604: <a name="devfaq.mailinglists"></a><a name="id2733958"></a><p><b>22.7.</b></p>
1.78      rillig   9605: </td>
                   9606: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9607:        developers?</p></td>
                   9608: </tr>
                   9609: <tr class="answer">
1.91      rillig   9610: <td align="left" valign="top"></td>
1.78      rillig   9611: <td align="left" valign="top"><div class="variablelist"><dl>
1.110     hubertf  9612: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9613: <dd><p>This is a list for technical discussions related
                   9614:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9615:        pkgsrc infrastructure, proposed new features, questions related
                   9616:        to porting pkgsrc to a new platform, advice for maintaining a
                   9617:        package, patches that affect many packages, help requests moved
                   9618:        from pkgsrc-users when an infrastructure bug is found,
                   9619:        etc.</p></dd>
1.110     hubertf  9620: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9621: <dd><p>All bug reports in category "pkg" sent with
1.110     hubertf  9622:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9623:        directly; use one of the other mailing
                   9624:        lists.</p></dd>
                   9625: </dl></div></td>
                   9626: </tr>
1.80      rillig   9627: <tr class="question">
                   9628: <td align="left" valign="top">
1.113   ! weinem   9629: <a name="devfaq.documentation"></a><a name="id2733996"></a><p><b>22.8.</b></p>
1.80      rillig   9630: </td>
                   9631: <td align="left" valign="top"><p>Where is the pkgsrc
                   9632:        documentation?</p></td>
                   9633: </tr>
                   9634: <tr class="answer">
1.91      rillig   9635: <td align="left" valign="top"></td>
1.80      rillig   9636: <td align="left" valign="top">
                   9637: <p>There are many places where you can find
                   9638:        documentation about pkgsrc:</p>
                   9639: <div class="itemizedlist"><ul type="disc">
                   9640: <li><p>The pkgsrc guide (this document) is a collection
                   9641:        of chapters that explain large parts of pkgsrc, but some
                   9642:        chapters tend to be outdated. Which ones they are is hard to
                   9643:        say.</p></li>
1.110     hubertf  9644: <li><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   9645:        about certain features, announcements of new parts of the pkgsrc
                   9646:        infrastructure and sometimes even announcements that a certain
                   9647:        feature has been marked as obsolete. The benefit here is that
                   9648:        each message has a date appended to it.</p></li>
                   9649: <li><p>Many of the files in the
                   9650:        <code class="filename">mk/</code> directory start with a comment that
                   9651:        describes the purpose of the file and how it can be used by the
1.92      rillig   9652:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9653:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9654:        help</strong></span>.</p></li>
1.80      rillig   9655: <li><p>The CVS log messages are a rich source of
                   9656:        information, but they tend to be highly abbreviated, especially
                   9657:        for actions that occur often. Some contain a detailed
                   9658:        description of what has changed, but they are geared towards the
                   9659:        other pkgsrc developers, not towards an average pkgsrc user.
                   9660:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9661:        don't know what has been before, these messages may not be worth
                   9662:        too much to you.</p></li>
                   9663: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9664:        documented</span>&#8221;, that is the documentation exists only in the
                   9665:        mind of the developer who wrote the code. To get this
1.110     hubertf  9666:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9667:        to see who has written it and ask on the
                   9668:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9669:        find your questions later (see above). To be sure that the
                   9670:        developer in charge reads the mail, you may CC him or
                   9671:        her.</p></li>
                   9672: </ul></div>
                   9673: </td>
                   9674: </tr>
1.92      rillig   9675: <tr class="question">
                   9676: <td align="left" valign="top">
1.113   ! weinem   9677: <a name="devfaq.too-much-time"></a><a name="id2734058"></a><p><b>22.9.</b></p>
1.92      rillig   9678: </td>
                   9679: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9680: do?</p></td>
                   9681: </tr>
                   9682: <tr class="answer">
                   9683: <td align="left" valign="top"></td>
                   9684: <td align="left" valign="top">
1.93      rillig   9685: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9686: anyway.</p>
                   9687: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9688: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   9689:     <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
                   9690:     will tell you about newer versions of installed packages that are
                   9691:     available, but not yet updated in pkgsrc.</p></li>
                   9692: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.112     weinem   9693:     &#8212; it contains a list of suggested new packages and a list of
1.92      rillig   9694:     cleanups and enhancements for pkgsrc that would be nice to
                   9695:     have.</p></li>
                   9696: <li><p>Review packages for which review was requested on
1.110     hubertf  9697:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   9698:     mailing list.</p></li>
                   9699: </ul></div>
                   9700: </td>
                   9701: </tr>
1.75      rillig   9702: </tbody>
                   9703: </table>
                   9704: </div>
                   9705: </div>
1.85      jmmv     9706: <div class="chapter" lang="en">
                   9707: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9708: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9709: <div class="toc">
                   9710: <p><b>Table of Contents</b></p>
                   9711: <dl>
1.106     rillig   9712: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9713: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9714: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9715: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9716: </dl>
                   9717: </div>
1.110     hubertf  9718: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9719: site</a>:</p>
                   9720: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9721:   environment, an intuitive and attractive desktop for users, and the
                   9722:   GNOME development platform, an extensive framework for building
                   9723:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9724: <p>pkgsrc provides a seamless way to automatically build and install
                   9725: a complete GNOME environment <span class="emphasis"><em>under many different
                   9726: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9727: the most advanced build and packaging systems for GNOME due to its
                   9728: included technologies buildlink3, the wrappers and tools framework and
                   9729: automatic configuration file management.  Lots of efforts are put into
                   9730: achieving a completely clean deinstallation of installed software
                   9731: components.</p>
1.110     hubertf  9732: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9733: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9734: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9735: pkgsrc as its preferred packaging system, contributing lots of
                   9736: portability fixes to make GNOME build and install under it.</p>
                   9737: <p>This chapter is aimed at pkgsrc developers and other people
                   9738: interested in helping our GNOME porting and packaging efforts.  It
                   9739: provides instructions on how to manage the existing packages and some
                   9740: important information regarding their internals.</p>
                   9741: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9742: <h3 class="title">We need your help!</h3>
                   9743: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9744:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9745:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9746:   work</a> list!  There is still a long way to go to get a
                   9747:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9748:   achieve it!</p>
                   9749: </div>
                   9750: <div class="sect1" lang="en">
                   9751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9752: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9753: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9754: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9755: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9756:     the core GNOME desktop environment.  It only includes the necessary
                   9757:     bits to get it to boot correctly, although it may lack important
                   9758:     functionality for daily operation.  The idea behind this package is
                   9759:     to let end users build their own configurations on top of this one,
                   9760:     first installing this meta package to achieve a functional setup and
                   9761:     then adding individual applications.</p></li>
1.91      rillig   9762: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9763:     complete installation of the GNOME platform and desktop as defined
                   9764:     by the GNOME project; this is based on the components distributed in
                   9765:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9766:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9767:     official FTP server.  Developer-only tools found in those
                   9768:     directories are not installed unless required by some other
                   9769:     component to work properly.  Similarly, packages from the bindings
                   9770:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9771:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9772:     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>
                   9773: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9774:     Installs all the tools required to build a GNOME component when
                   9775:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9776:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9777: </ul></div>
                   9778: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9779: sorted in a way that eases updates: a package may depend on other
                   9780: packages listed before it but not on any listed after it.  It is very
                   9781: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9782: change it to alphabetical sorting!</em></span></p>
                   9783: </div>
                   9784: <div class="sect1" lang="en">
                   9785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9786: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9787: <p>Almost all GNOME applications are written in C and use a common
                   9788: set of tools as their build system.  Things get different with the new
                   9789: bindings to other languages (such as Python), but the following will
                   9790: give you a general idea on the minimum required tools:</p>
                   9791: <div class="itemizedlist"><ul type="disc">
                   9792: <li>
                   9793: <p>Almost all GNOME applications use the GNU Autotools as their
                   9794:     build system.  As a general rule you will need to tell this to your
                   9795:     package:</p>
1.100     rillig   9796: <pre class="programlisting">
                   9797: GNU_CONFIGURE=yes
1.85      jmmv     9798: USE_LIBTOOL=yes
1.100     rillig   9799: USE_TOOLS+=gmake
                   9800: </pre>
1.85      jmmv     9801: </li>
                   9802: <li>
                   9803: <p>If the package uses pkg-config to detect dependencies, add this
                   9804:     tool to the list of required utilities:</p>
                   9805: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9806: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9807:     the end of the build process to ensure that you did not miss to
                   9808:     specify any dependency in your package and that the version
                   9809:     requirements are all correct.</p>
                   9810: </li>
1.93      rillig   9811: <li><p>If the package uses intltool, be sure to add
                   9812:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9813:     to handle dependencies and to force the package to use the latest
                   9814:     available version.</p></li>
                   9815: <li>
                   9816: <p>If the package uses gtk-doc (a documentation generation
                   9817:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9818:     tool is rather big and the distfile should come with pregenerated
                   9819:     documentation anyway; if it does not, it is a bug that you ought to
                   9820:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9821:     the default):</p>
                   9822: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9823: <p>The default location of installed HTML files
                   9824:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9825:     and should not be changed unless the package insists on installing
                   9826:     them somewhere else.  Otherwise programs as
1.110     hubertf  9827:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9828:     do that with an entry similar to:</p>
                   9829: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9830: </li>
                   9831: </ul></div>
                   9832: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9833: files under the installation prefix to maintain databases.  In this
                   9834: context, shared means that those exact same directories and files are
                   9835: used among several different packages, leading to conflicts in the
                   9836: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9837: handle the most common cases, so you have to forget about using
                   9838: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9839: omitting shared files from them.  If you find yourself doing those,
                   9840: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9841: <p>The following table lists the common situations that result in
                   9842: using shared directories or files.  For each of them, the appropriate
                   9843: solution is given.  After applying the solution be sure to
                   9844: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9845: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9846: <div class="table">
1.106     rillig   9847: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9848: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9849: <colgroup>
                   9850: <col>
                   9851: <col>
                   9852: </colgroup>
                   9853: <thead><tr>
                   9854: <th>If the package...</th>
                   9855: <th>Then...</th>
                   9856: </tr></thead>
                   9857: <tbody>
                   9858: <tr>
                   9859: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.110     hubertf  9860: <td>See <a class="xref" 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.85      jmmv     9861: </tr>
                   9862: <tr>
                   9863: <td>Installs icons under the
                   9864:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9865:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9866: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9867: </tr>
                   9868: <tr>
                   9869: <td>Installs files under
                   9870:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9871: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9872: </tr>
                   9873: <tr>
                   9874: <td>Installs <code class="filename">.desktop</code> files under
                   9875:         <code class="filename">share/applications</code> and these include MIME
                   9876:         information.</td>
1.110     hubertf  9877: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9878: </tr>
                   9879: </tbody>
1.91      rillig   9880: </table></div>
1.85      jmmv     9881: </div>
1.91      rillig   9882: <br class="table-break">
1.85      jmmv     9883: </div>
                   9884: <div class="sect1" lang="en">
                   9885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9886: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9887: <p>When seeing GNOME as a whole, there are two kinds of
                   9888: updates:</p>
                   9889: <div class="variablelist"><dl>
                   9890: <dt><span class="term">Major update</span></dt>
                   9891: <dd>
                   9892: <p>Given that there is still a very long way for GNOME 3 (if it
                   9893:       ever appears), we consider a major update one that goes from a
                   9894:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9895:       where <code class="literal">Y</code> is even and greater than
                   9896:       <code class="literal">X</code>.  These are hard to achieve because they
                   9897:       introduce lots of changes in the components' code and almost all
                   9898:       GNOME distfiles are updated to newer versions.  Some of them can
                   9899:       even break API and ABI compatibility with the previous major
                   9900:       version series.  As a result, the update needs to be done all at
                   9901:       once to minimize breakage.</p>
                   9902: <p>A major update typically consists of around 80 package
                   9903:       updates and the addition of some new ones.</p>
                   9904: </dd>
                   9905: <dt><span class="term">Minor update</span></dt>
                   9906: <dd>
                   9907: <p>We consider a minor update one that goes from a
                   9908:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9909:       one where <code class="literal">Y</code> is greater than
                   9910:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9911:       not update all GNOME components, can be done in an incremental way
                   9912:       and do not break API nor ABI compatibility.</p>
                   9913: <p>A minor update typically consists of around 50 package
                   9914:       updates, although the numbers here may vary a lot.</p>
                   9915: </dd>
                   9916: </dl></div>
                   9917: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9918: release (either major or minor), the following steps should be
                   9919: followed:</p>
                   9920: <div class="orderedlist"><ol type="1">
                   9921: <li>
                   9922: <p>Get a list of all the tarballs that form the new release by
                   9923:     using the following commands.  These will leave the full list of the
                   9924:     components's distfiles into the <code class="filename">list.txt</code>
                   9925:     file:</p>
1.88      wiz      9926: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9927:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9928:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9929: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9930:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9931:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9932: </li>
                   9933: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   9934:     bump their version to the release you are updating them to.  The
                   9935:     three meta packages should be always consistent with versioning.
                   9936:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9937:     in them.</p></li>
                   9938: <li>
                   9939: <p>For each meta package, update all its
                   9940:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9941:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9942:     newer version (even if found in the FTP) because the meta packages
                   9943:     are supposed to list the exact versions that form a specific GNOME
                   9944:     release.  Exceptions are permitted here if a newer version solves a
                   9945:     serious issue in the overall desktop experience; these typically
                   9946:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9947:     from the developers.</p>
                   9948: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9949:     should be updated to the latest version available (if found in
                   9950:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   9951:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     9952: </li>
                   9953: <li>
                   9954: <p>Generate a patch from the modified meta packages and extract the
                   9955:     list of "new" lines.  This will provide you an outline on what
                   9956:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9957: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     9958: </li>
                   9959: <li><p>For major desktop updates it is recommended to zap all your
                   9960:     installed packages and start over from scratch at this point.</p></li>
                   9961: <li><p>Now comes the longest step by far: iterate over the contents
                   9962:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9963:     it in order.  For major desktop updates none of these should be
1.93      rillig   9964:     committed until the entire set is completed because there are chances
1.85      jmmv     9965:     of breaking not-yet-updated packages.</p></li>
                   9966: <li><p>Once the packages are up to date and working, commit them to
                   9967:     the tree one by one with appropriate log messages.  At the end,
                   9968:     commit the three meta package updates and all the corresponding
                   9969:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9970:     <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>
                   9971: </ol></div>
                   9972: </div>
                   9973: <div class="sect1" lang="en">
                   9974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9975: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9976: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9977: packages.  Please, it is very important that you always, always,
                   9978: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  9979: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     9980: their attention on portability issues and to ensure that future versions
                   9981: can be built out-of-the box on NetBSD.  The less custom patches in
                   9982: pkgsrc, the easier further updates are.  Those developers in charge of
                   9983: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9984: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     9985: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9986: of them do.  Do not be short on your reports: always provide detailed
                   9987: explanations of the current failure, how it can be improved to achieve
                   9988: maximum portability and, if at all possible, provide a patch against CVS
                   9989: head.  The more verbose you are, the higher chances of your patch being
                   9990: accepted.</p>
                   9991: <p>Also, please avoid using preprocessor magic to fix portability
                   9992: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9993: GNOME to their operating system, the official GNOME sources are now
                   9994: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9995: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  9996: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     9997: details.</p>
                   9998: </div>
                   9999: </div>
1.75      rillig   10000: </div>
                   10001: <div class="part" lang="en">
                   10002: <div class="titlepage"><div><div><h1 class="title">
                   10003: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10004: <div class="partintro" lang="en">
                   10005: <div></div>
                   10006: <p>This part of the guide deals with everything
                   10007:        from the infrastructure that is behind the interfaces described
                   10008:        in the developer's guide. A casual package maintainer should not
                   10009:        need anything from this part.</p>
                   10010: <div class="toc">
                   10011: <p><b>Table of Contents</b></p>
                   10012: <dl>
1.106     rillig   10013: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10014: <dd><dl>
1.106     rillig   10015: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10016: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10017: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10018: <dd><dl>
1.106     rillig   10019: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10020: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10021: </dl></dd>
1.106     rillig   10022: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10023: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10024: <dd><dl>
1.106     rillig   10025: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10026: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10027: </dl></dd>
1.106     rillig   10028: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10029: <dd><dl>
1.106     rillig   10030: <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>
                   10031: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10032: </dl></dd>
                   10033: </dl></dd>
1.106     rillig   10034: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10035: <dd><dl>
1.106     rillig   10036: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10037: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10038: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10039: <dd><dl>
1.106     rillig   10040: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10041: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10042: </dl></dd>
                   10043: </dl></dd>
1.106     rillig   10044: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10045: <dd><dl>
1.106     rillig   10046: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10047: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10048: </dl></dd>
                   10049: </dl>
                   10050: </div>
                   10051: </div>
                   10052: <div class="chapter" lang="en">
                   10053: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10054: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10055: <div class="toc">
                   10056: <p><b>Table of Contents</b></p>
                   10057: <dl>
1.106     rillig   10058: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10059: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10060: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10061: <dd><dl>
1.106     rillig   10062: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10063: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10064: </dl></dd>
1.106     rillig   10065: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10066: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10067: <dd><dl>
1.106     rillig   10068: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10069: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10070: </dl></dd>
1.106     rillig   10071: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10072: <dd><dl>
1.106     rillig   10073: <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>
                   10074: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10075: </dl></dd>
                   10076: </dl>
                   10077: </div>
                   10078: <p>The pkgsrc infrastructure consists of many small Makefile
                   10079:        fragments. Each such fragment needs a properly specified
                   10080:        interface. This chapter explains how such an interface looks
                   10081:        like.</p>
                   10082: <div class="sect1" lang="en">
                   10083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10084: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10085: <p>Whenever a variable is defined in the pkgsrc
                   10086:        infrastructure, the location and the way of definition provide
                   10087:        much information about the intended use of that variable.
                   10088:        Additionally, more documentation may be found in a header
                   10089:        comment or in this pkgsrc guide.</p>
                   10090: <p>A special file is
                   10091:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10092:        variables that are intended to be user-defined. They are either
                   10093:        defined using the <code class="literal">?=</code> operator or they are
                   10094:        left undefined because defining them to anything would
                   10095:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10096:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10097:        file.</p>
                   10098: <p>Outside this file, the following conventions apply:
                   10099:        Variables that are defined using the <code class="literal">?=</code>
                   10100:        operator may be overridden by a package.</p>
                   10101: <p>Variables that are defined using the <code class="literal">=</code>
                   10102:        operator may be used read-only at run-time.</p>
                   10103: <p>Variables whose name starts with an underscore must not be
                   10104:        accessed outside the pkgsrc infrastructure at all. They may
                   10105:        change without further notice.</p>
                   10106: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10107: <h3 class="title">Note</h3>
                   10108: <p>These conventions are currently not applied
                   10109:        consistently to the complete pkgsrc
                   10110:        infrastructure.</p>
                   10111: </div>
                   10112: </div>
                   10113: <div class="sect1" lang="en">
                   10114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10115: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10116: <p>All variables that contain lists of things should default
                   10117:        to being empty. Two examples that do not follow this rule are
                   10118:        <code class="varname">USE_LANGUAGES</code> and
                   10119:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10120:        modified using the <code class="literal">+=</code> operator in package
                   10121:        <code class="filename">Makefile</code>s (or other files included by
                   10122:        them), since there is no guarantee whether the variable is
                   10123:        already set or not, and what its value is. In the case of
                   10124:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10125:        the default value and just define it as in the following
                   10126:        example.</p>
                   10127: <pre class="programlisting">
1.100     rillig   10128: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10129: </pre>
                   10130: <p>Because of the selection of this default value, the same
                   10131:        value appears in many package Makefiles. Similarly for
                   10132:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10133:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10134:        doesn't stand out. Nevertheless it is mentioned in many
                   10135:        files.</p>
                   10136: </div>
                   10137: <div class="sect1" lang="en">
                   10138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10139: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10140: <div class="sect2" lang="en">
                   10141: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10142: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10143: <p>Variable evaluation takes place either at load time or at
                   10144:        runtime, depending on the context in which they occur. The
                   10145:        contexts where variables are evaluated at load time are:</p>
                   10146: <div class="itemizedlist"><ul type="disc">
                   10147: <li><p>The right hand side of the <code class="literal">:=</code>
                   10148:        and <code class="literal">!=</code> operators,</p></li>
                   10149: <li><p>Make directives like <code class="literal">.if</code> or
                   10150:        <code class="literal">.for</code>,</p></li>
                   10151: <li><p>Dependency lines.</p></li>
                   10152: </ul></div>
                   10153: <p>A special exception are references to the iteration
                   10154:        variables of <code class="literal">.for</code> loops, which are expanded
                   10155:        inline, no matter in which context they appear.</p>
                   10156: <p>As the values of variables may change during load time,
                   10157:        care must be taken not to evaluate them by accident. Typical
                   10158:        examples for variables that should not be evaluated at load time
                   10159:        are <code class="varname">DEPENDS</code> and
                   10160:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10161:        clear, here is an example:</p>
                   10162: <pre class="programlisting">
1.100     rillig   10163: CONFIGURE_ARGS=         # none
                   10164: CFLAGS=                 -O
                   10165: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10166: 
1.100     rillig   10167: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10168: 
1.100     rillig   10169: CFLAGS+=                -Wall
1.75      rillig   10170:        </pre>
                   10171: <p>This code shows how the use of the <code class="literal">:=</code>
                   10172:        operator can quickly lead to unexpected results. The first
                   10173:        paragraph is fairly common code. The second paragraph evaluates
                   10174:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10175:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10176:        <code class="literal">-Wall</code> is appended to the
                   10177:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10178:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10179:        paragraphs from above typically occur in completely unrelated
                   10180:        files.</p>
                   10181: </div>
                   10182: <div class="sect2" lang="en">
                   10183: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10184: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10185: <p>After all the files have been loaded, the values of the
                   10186:        variables cannot be changed anymore. Variables that are used in
                   10187:        the shell commands are expanded at this point.</p>
                   10188: </div>
                   10189: </div>
                   10190: <div class="sect1" lang="en">
                   10191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10192: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10193: <p>There are many ways in which the definition and use of a
                   10194:        variable can be restricted in order to detect bugs and
                   10195:        violations of the (mostly unwritten) policies. See the
                   10196:        <code class="literal">pkglint</code> developer's documentation for further
                   10197:        details.</p>
                   10198: </div>
                   10199: <div class="sect1" lang="en">
                   10200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10201: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10202: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10203:        of the following classes. Cases where a file falls into more
                   10204:        than one class should be avoided as it often leads to subtle
                   10205:        bugs.</p>
                   10206: <div class="sect2" lang="en">
                   10207: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10208: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10209: <p>In a traditional imperative programming language some of
1.76      rillig   10210:        the <code class="filename">.mk</code> files could be described as
1.112     weinem   10211:        procedures. They take some input parameters and&#8212;after
                   10212:        inclusion&#8212;provide a result in output parameters. Since all
1.76      rillig   10213:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10214:        care must be taken not to use parameter names that have already
                   10215:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10216:        bad choice for a parameter name.</p>
                   10217: <p>Procedures are completely evaluated at preprocessing time.
                   10218:        That is, when calling a procedure all input parameters must be
                   10219:        completely resolvable. For example,
                   10220:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10221:        parameter since it is very likely that further text will be
                   10222:        added after calling the procedure, which would effectively apply
                   10223:        the procedure to only a part of the variable. Also, references
                   10224:        to other variables wit will be modified after calling the
                   10225:        procedure.</p>
                   10226: <p>A procedure can declare its output parameters either as
                   10227:        suitable for use in preprocessing directives or as only
                   10228:        available at runtime. The latter alternative is for variables
                   10229:        that contain references to other runtime variables.</p>
                   10230: <p>Procedures shall be written such that it is possible to
                   10231:        call the procedure more than once. That is, the file must not
                   10232:        contain multiple-inclusion guards.</p>
                   10233: <p>Examples for procedures are
1.76      rillig   10234:        <code class="filename">mk/bsd.options.mk</code> and
                   10235:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10236:        that the parameters are evaluated at load time, they should be
                   10237:        assigned using the <code class="literal">:=</code> operator, which should
                   10238:        be used only for this purpose.</p>
                   10239: </div>
                   10240: <div class="sect2" lang="en">
                   10241: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10242: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10243: <p>Action files take some input parameters and may define
                   10244:        runtime variables. They shall not define loadtime variables.
                   10245:        There are action files that are included implicitly by the
                   10246:        pkgsrc infrastructure, while other must be included
                   10247:        explicitly.</p>
                   10248: <p>An example for action files is
1.76      rillig   10249:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10250: </div>
                   10251: </div>
1.81      rillig   10252: <div class="sect1" lang="en">
                   10253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10254: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10255: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10256:        a set of variable definitions, and include the file
                   10257:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10258:        Before that, they may also include various other
                   10259:        <code class="filename">*.mk</code> files if they need to query the
                   10260:        availability of certain features like the type of compiler or
                   10261:        the X11 implementation. Due to the heavy use of preprocessor
                   10262:        directives like <code class="literal">.if</code> and
                   10263:        <code class="literal">.for</code>, the order in which the files are loaded
                   10264:        matters.</p>
                   10265: <p>This section describes at which point the various files
                   10266:        are loaded and gives reasons for that order.</p>
                   10267: <div class="sect2" lang="en">
                   10268: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10269: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10270: </h3></div></div></div>
                   10271: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10272:        is to define some essential variables like
                   10273:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10274:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10275: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10276:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10277:        After that, those variables
1.81      rillig   10278:        that have not been overridden by the user are loaded from
                   10279:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10280: <p>After the user settings, the system settings and platform
                   10281:        settings are loaded, which may override the user
                   10282:        settings.</p>
                   10283: <p>Then, the tool definitions are loaded. The tool wrappers
                   10284:        are not yet in effect. This only happens when building a
                   10285:        package, so the proper variables must be used instead of the
                   10286:        direct tool names.</p>
                   10287: <p>As the last steps, some essential variables from the
                   10288:        wrapper and the package system flavor are loaded, as well as the
                   10289:        variables that have been cached in earlier phases of a package
                   10290:        build.</p>
                   10291: </div>
                   10292: <div class="sect2" lang="en">
                   10293: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10294: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10295: </h3></div></div></div>
1.81      rillig   10296: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10297: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10298:        loaded, which fill default values for those variables that have
1.93      rillig   10299:        not been defined by the package. These variables may later
1.81      rillig   10300:        be used even in unrelated files.</p>
                   10301: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10302:        provides the target <code class="literal">error-check</code> that is added
                   10303:        as a special dependency to all other targets that use
                   10304:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10305:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10306: <p>Then, the package-specific hacks from
                   10307:        <code class="filename">hacks.mk</code> are included.</p>
                   10308: <p>Then, various other files follow. Most of them don't have
                   10309:        any dependencies on what they need to have included before or
                   10310:        after them, though some do.</p>
                   10311: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10312:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10313:        restricts the use of these variables to all the files that have
                   10314:        been included before. Appearances in later files will be
                   10315:        silently ignored.</p>
                   10316: <p>Then, the files for the main targets are included, in the
                   10317:        order of later execution, though the actual order should not
                   10318:        matter.</p>
                   10319: <p>At last, some more files are included that don't set any
                   10320:        interesting variables but rather just define make targets to be
                   10321:        executed.</p>
                   10322: </div>
                   10323: </div>
1.75      rillig   10324: </div>
                   10325: <div class="chapter" lang="en">
                   10326: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10327: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10328: <div class="toc">
                   10329: <p><b>Table of Contents</b></p>
                   10330: <dl>
1.106     rillig   10331: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10332: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10333: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10334: <dd><dl>
1.106     rillig   10335: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10336: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10337: </dl></dd>
                   10338: </dl>
                   10339: </div>
                   10340: <p>The pkgsrc infrastructure consists of a large codebase,
                   10341:        and there are many corners where every little bit of a file is
                   10342:        well thought out, making pkgsrc likely to fail as soon as
                   10343:        anything is changed near those parts. To prevent most changes
                   10344:        from breaking anything, a suite of regression tests should go
                   10345:        along with every important part of the pkgsrc infrastructure.
                   10346:        This chapter describes how regression tests work in pkgsrc and
                   10347:        how you can add new tests.</p>
                   10348: <div class="sect1" lang="en">
                   10349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10350: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10351: <p></p>
                   10352: </div>
                   10353: <div class="sect1" lang="en">
                   10354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10355: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10356: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10357:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10358:        can simply run that command, which will run all tests in the
1.76      rillig   10359:        <code class="filename">regress</code> category.</p>
1.75      rillig   10360: </div>
                   10361: <div class="sect1" lang="en">
                   10362: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10363: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10364: <p>Every directory in the <code class="filename">regress</code>
                   10365:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10366:        is considered a regression test. This file is a shell program
1.110     hubertf  10367:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10368:        The following functions can be overridden to suit your
                   10369:        needs.</p>
                   10370: <div class="sect2" lang="en">
                   10371: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10372: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10373: <p>These functions do not take any parameters. They are all
                   10374:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10375:        to check the exitcodes of any commands you run in the
                   10376:        test.</p>
                   10377: <div class="variablelist"><dl>
                   10378: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10379: <dd><p>This function prepares the environment for the
                   10380:        test. By default it does nothing.</p></dd>
                   10381: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10382: <dd><p>This function runs the actual test. By default,
                   10383:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10384:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10385:        error messages into the file
                   10386:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10387: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10388: <dd><p>This function is run after the test and is
                   10389:        typically used to compare the actual output from the one that is
                   10390:        expected. It can make use of the various helper functions from
                   10391:        the next section.</p></dd>
                   10392: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10393: <dd><p>This function cleans everything up after the
                   10394:        test has been run. By default it does nothing.</p></dd>
                   10395: </dl></div>
                   10396: </div>
                   10397: <div class="sect2" lang="en">
                   10398: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10399: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10400: <div class="variablelist"><dl>
                   10401: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10402: <dd><p>This function compares the exitcode of the
1.110     hubertf  10403:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10404:        If they differ, the test will fail.</p></dd>
                   10405: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10406: <dd><p>This function checks for each of its parameters
1.110     hubertf  10407:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10408:        extended regular expression. If it does not, the test will
                   10409:        fail.</p></dd>
                   10410: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10411: <dd><p>This function checks for each of its parameters
1.110     hubertf  10412:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10413:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10414:        If any of the regular expressions matches, the test will
                   10415:        fail.</p></dd>
                   10416: </dl></div>
                   10417: </div>
                   10418: </div>
                   10419: </div>
                   10420: <div class="chapter" lang="en">
                   10421: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10422: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10423: <div class="toc">
                   10424: <p><b>Table of Contents</b></p>
                   10425: <dl>
1.106     rillig   10426: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10427: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10428: </dl>
                   10429: </div>
                   10430: <p>The pkgsrc system has already been ported to many
                   10431:        operating systems, hardware architectures and compilers. This
                   10432:        chapter explains the necessary steps to make pkgsrc even more
                   10433:        portable.</p>
                   10434: <div class="sect1" lang="en">
                   10435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10436: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10437: <p>To port pkgsrc to a new operating system (called
                   10438:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10439:        following files:</p>
                   10440: <div class="variablelist"><dl>
1.93      rillig   10441: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10442: <dd><p>This file contains some basic definitions, for
                   10443:        example the name of the C
                   10444:        compiler.</p></dd>
1.76      rillig   10445: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10446: <dd><p>Insert code that defines the variables
                   10447:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10448:        <code class="varname">LOWER_OS_VERSION</code>,
                   10449:        <code class="varname">LOWER_VENDOR</code>,
                   10450:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10451:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10452:        appear in this file.</p></dd>
1.93      rillig   10453: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10454: <dd><p>This file contains the platform-specific
                   10455:        definitions that are used by pkgsrc. Start by copying one of the
                   10456:        other files and edit it to your
                   10457:        needs.</p></dd>
1.93      rillig   10458: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10459: <dd><p>This file contains a list of directories,
                   10460:        together with their permission bits and ownership. These
                   10461:        directories will be created automatically with every package
1.98      wiz      10462:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10463:        be removed.</p></dd>
1.93      rillig   10464: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10465: <dd><p>Just copy one of the pre-existing x11.dist files
                   10466:        to your
1.76      rillig   10467:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10468: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10469: <dd><p>On some operating systems, the tools that are
                   10470:        provided with the base system are not good enough for pkgsrc.
1.110     hubertf  10471:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75      rillig   10472:        narrow limit on the line length they can process. Therefore
                   10473:        pkgsrc brings its own tools, which can be enabled
                   10474:        here.</p></dd>
1.93      rillig   10475: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10476: <dd><p>This file defines the paths to all the tools
                   10477:        that are needed by one or the other package in pkgsrc, as well
                   10478:        as by pkgsrc itself. Find out where these tools are on your
                   10479:        platform and add them.</p></dd>
                   10480: </dl></div>
                   10481: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10482:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10483: </div>
                   10484: <div class="sect1" lang="en">
                   10485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10486: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10487: <p>TODO</p>
                   10488: </div>
                   10489: </div>
                   10490: </div>
                   10491: <div class="appendix" lang="en">
                   10492: <div class="titlepage"><div><div><h2 class="title">
                   10493: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10494: <div class="toc">
                   10495: <p><b>Table of Contents</b></p>
                   10496: <dl>
                   10497: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10498: <dd><dl>
                   10499: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10500: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10501: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.110     hubertf  10502: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75      rillig   10503: </dl></dd>
                   10504: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10505: </dl>
                   10506: </div>
                   10507: <p>We checked to find a piece of software that wasn't in the packages
                   10508:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10509:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10510:     present in the tree is beyond us, but it's useful for the purposes of
                   10511:     this exercise.</p>
                   10512: <div class="sect1" lang="en">
                   10513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10514: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10515: <div class="sect2" lang="en">
                   10516: <div class="titlepage"><div><div><h3 class="title">
                   10517: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10518: <pre class="programlisting">
1.100     rillig   10519: # $NetBSD$
                   10520: #
1.1       grant    10521: 
1.100     rillig   10522: DISTNAME=       bison-1.25
                   10523: CATEGORIES=     devel
                   10524: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10525: 
1.100     rillig   10526: MAINTAINER=     thorpej@NetBSD.org
                   10527: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10528: COMMENT=        GNU yacc clone
1.1       grant    10529: 
1.100     rillig   10530: GNU_CONFIGURE=  yes
                   10531: INFO_FILES=     bison.info
1.1       grant    10532: 
1.100     rillig   10533: .include "../../mk/bsd.pkg.mk"
1.1       grant    10534: </pre>
1.75      rillig   10535: </div>
                   10536: <div class="sect2" lang="en">
                   10537: <div class="titlepage"><div><div><h3 class="title">
                   10538: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10539: <pre class="programlisting">
1.100     rillig   10540: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.110     hubertf  10541: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10542: of the NetBSD source tree is beyond me.
1.1       grant    10543: </pre>
1.75      rillig   10544: </div>
                   10545: <div class="sect2" lang="en">
                   10546: <div class="titlepage"><div><div><h3 class="title">
                   10547: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10548: <pre class="programlisting">
1.100     rillig   10549: @comment $NetBSD$
                   10550: bin/bison
                   10551: man/man1/bison.1.gz
                   10552: share/bison.simple
                   10553: share/bison.hairy
1.1       grant    10554: </pre>
1.75      rillig   10555: </div>
                   10556: <div class="sect2" lang="en">
                   10557: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10558: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10559: </h3></div></div></div>
1.75      rillig   10560: <p>The NetBSD package system comes with
1.91      rillig   10561:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10562:        which helps to check the contents of these
                   10563:        files. After installation it is quite easy to use, just change to the
                   10564:        directory of the package you wish to examine and execute
1.110     hubertf  10565:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10566: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10567: looks fine.</pre>
                   10568: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10569:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10570:        -Wall</strong></span> for a very thorough check.</p>
                   10571: </div>
                   10572: </div>
                   10573: <div class="sect1" lang="en">
                   10574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10575: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10576: <p>Create the directory where the package lives,
                   10577:       plus any auxiliary directories:</p>
                   10578: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10579: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10580: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10581: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10582: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10583:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10584:       then continue with fetching the distfile:</p>
                   10585: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10586: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10587: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10588: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10589: ftp: Error retrieving file: 500 Internal error
                   10590: 
                   10591: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10592: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10593: ftp: Error retrieving file: 500 Internal error
                   10594: 
                   10595: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10596: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10597: Successfully retrieved file.</pre>
                   10598: <p>Generate the checksum of the distfile into
1.76      rillig   10599:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10600: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10601: <p>Now compile:</p>
                   10602: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10603: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10604: ===&gt;  Extracting for bison-1.25
                   10605: ===&gt;  Patching for bison-1.25
                   10606: ===&gt;   Ignoring empty patch directory
                   10607: ===&gt;  Configuring for bison-1.25
                   10608: creating cache ./config.cache
                   10609: checking for gcc... cc
                   10610: checking whether we are using GNU C... yes
                   10611: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10612: checking how to run the C preprocessor... cc -E
                   10613: checking for minix/config.h... no
                   10614: checking for POSIXized ISC... no
                   10615: checking whether cross-compiling... no
                   10616: checking for ANSI C header files... yes
                   10617: checking for string.h... yes
                   10618: checking for stdlib.h... yes
                   10619: checking for memory.h... yes
                   10620: checking for working const... yes
                   10621: checking for working alloca.h... no
                   10622: checking for alloca... yes
                   10623: checking for strerror... yes
                   10624: updating cache ./config.cache
                   10625: creating ./config.status
                   10626: creating Makefile
                   10627: ===&gt;  Building for bison-1.25
                   10628: 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
                   10629: 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
                   10630: 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
                   10631: 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
                   10632: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10633: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10634: 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
                   10635: 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
                   10636: 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
                   10637: 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
                   10638: 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
                   10639: 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
                   10640: 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
                   10641: 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
                   10642: 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
                   10643: 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
                   10644: 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
                   10645: 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
                   10646: 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
                   10647: 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
                   10648: 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
                   10649: 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
                   10650: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10651: rm -f bison.s1
1.75      rillig   10652: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10653: <p>Everything seems OK, so install the files:</p>
                   10654: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10655: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10656: ===&gt;  Installing for bison-1.25
                   10657: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10658: rm -f /usr/pkg/bin/bison
                   10659: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10660: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10661: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10662: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10663: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10664: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10665: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10666: ===&gt;  Registering installation for bison-1.25</pre>
                   10667: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10668:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10669:       binary package, do this now:</p>
                   10670: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10671: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10672: ===&gt;  Building package for bison-1.25
                   10673: Creating package bison-1.25.tgz
                   10674: Registering depends:.
1.75      rillig   10675: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10676: <p>Now that you don't need the source and object files
                   10677:       any more, clean up:</p>
                   10678: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10679: ===&gt;  Cleaning for bison-1.25</pre>
                   10680: </div>
                   10681: </div>
                   10682: <div class="appendix" lang="en">
                   10683: <div class="titlepage"><div><div><h2 class="title">
                   10684: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10685: <div class="toc">
                   10686: <p><b>Table of Contents</b></p>
                   10687: <dl>
                   10688: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10689: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10690: </dl>
                   10691: </div>
                   10692: <div class="sect1" lang="en">
                   10693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10694: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10695: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10696: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10697: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10698: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10699: =&gt; [172219 bytes]
                   10700: Connected to ftp.plig.net.
                   10701: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10702: 331 Guest login ok, send your complete e-mail address as password.
                   10703: 230-You are user #5 of 500 simultaneous users allowed.
                   10704: 230-
1.68      rillig   10705: 230-  ___ _             _ _
                   10706: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10707: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10708: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10709: 230-         |_|   |_|     |___|         |___|
                   10710: 230-
                   10711: 230-** Welcome to ftp.plig.org **
                   10712: 230-
                   10713: 230-Please note that all transfers from this FTP site are logged. If you
                   10714: 230-do not like this, please disconnect now.
                   10715: 230-
                   10716: 230-This arhive is available via
                   10717: 230-
                   10718: 230-HTTP:  http://ftp.plig.org/
                   10719: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10720: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10721: 230-
                   10722: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10723: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10724: 230-
                   10725: 230-
                   10726: 230 Logged in anonymously.
                   10727: Remote system type is UNIX.
                   10728: Using binary mode to transfer files.
                   10729: 200 Type okay.
                   10730: 250 "/pub" is new cwd.
                   10731: 250-"/pub/figlet" is new cwd.
                   10732: 250-
                   10733: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10734: 250-
1.75      rillig   10735: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10736: 250-
                   10737: 250-The official FIGlet web page is:
1.75      rillig   10738: 250-   http://www.figlet.org/
1.1       grant    10739: 250-
                   10740: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10741: 250-contribute a font or something else, you can email us.
1.68      rillig   10742: 250
1.1       grant    10743: 250 "/pub/figlet/program" is new cwd.
                   10744: 250 "/pub/figlet/program/unix" is new cwd.
                   10745: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10746: 502 Unimplemented command.
                   10747: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10748: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10749: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10750: 226 Transfer completed.
                   10751: 172219 bytes received in 00:02 (75.99 KB/s)
                   10752: 221 Goodbye.
                   10753: =&gt; Checksum OK for figlet221.tar.gz.
                   10754: ===&gt; Extracting for figlet-2.2.1nb2
                   10755: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10756: ===&gt; Patching for figlet-2.2.1nb2
                   10757: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10758: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10759: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10760: ===&gt; Configuring for figlet-2.2.1nb2
                   10761: ===&gt; Building for figlet-2.2.1nb2
                   10762: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10763: chmod a+x figlet
                   10764: gcc -O2 -o chkfont chkfont.c
                   10765: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10766: <code class="prompt">#</code>
1.75      rillig   10767: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10768: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10769: ===&gt; Installing for figlet-2.2.1nb2
                   10770: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10771: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10772: mkdir -p /usr/pkg/share/figlet
                   10773: cp figlet /usr/pkg/bin
                   10774: cp chkfont /usr/pkg/bin
                   10775: chmod 555 figlist showfigfonts
                   10776: cp figlist /usr/pkg/bin
                   10777: cp showfigfonts /usr/pkg/bin
                   10778: cp fonts/*.flf /usr/pkg/share/figlet
                   10779: cp fonts/*.flc /usr/pkg/share/figlet
                   10780: cp figlet.6 /usr/pkg/man/man6
                   10781: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10782: <code class="prompt">#</code></pre>
                   10783: </div>
                   10784: <div class="sect1" lang="en">
                   10785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10786: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10788: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10789: ===&gt; Packaging figlet-2.2.1nb2
                   10790: ===&gt; Building binary package for figlet-2.2.1nb2
                   10791: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10792: Using SrcDir value of /usr/pkg
1.68      rillig   10793: Registering depends:.
1.75      rillig   10794: <code class="prompt">#</code></pre>
                   10795: </div>
                   10796: </div>
                   10797: <div class="appendix" lang="en">
                   10798: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10799: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10800: <div class="toc">
                   10801: <p><b>Table of Contents</b></p>
                   10802: <dl>
                   10803: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10804: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10805: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10806: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102     rillig   10807: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.108     rillig   10808: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10809: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.93      rillig   10810: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10811: source packages</a></span></dt>
                   10812: </dl>
                   10813: </div>
                   10814: <p>As in other big projects, the directory layout of pkgsrc
                   10815:        is quite complex for newbies. This chapter explains where you
                   10816:        find things on the FTP server. The base directory on
1.110     hubertf  10817:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10818:        On other servers it may be different, but inside this directory,
                   10819:        everything should look the same, no matter on which server you
                   10820:        are. This directory contains some subdirectories, which are
                   10821:        explained below.</p>
1.76      rillig   10822: <div class="sect1" lang="en">
                   10823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10824: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109     rillig   10825: <p>This directory used to contain binary packages of the
                   10826:        package management tools for various platforms. For those
                   10827:        package collections that need them, they are now stored near the
1.110     hubertf  10828:        binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109     rillig   10829:        directory</a>.</p>
1.76      rillig   10830: </div>
                   10831: <div class="sect1" lang="en">
                   10832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10833: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10834: <p>The directory <code class="filename">distfiles</code> contains lots
                   10835:        of archive files from all pkgsrc packages, which are mirrored
                   10836:        here. The subdirectories are called after their package names
                   10837:        and are used when the distributed files have names that don't
                   10838:        explicitly contain a version number or are otherwise too generic
                   10839:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10840: </div>
                   10841: <div class="sect1" lang="en">
                   10842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10843: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10844: <p>This directory is currently not in use.</p>
                   10845: </div>
                   10846: <div class="sect1" lang="en">
                   10847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10848: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10849: <p>This directory contains things that individual pkgsrc
                   10850:        developers find worth publishing.</p>
                   10851: </div>
                   10852: <div class="sect1" lang="en">
                   10853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   10854: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   10855: <p>This directory contains binary packages for the various
                   10856:        platforms that are supported by pkgsrc.
                   10857:        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>
                   10858: <div class="itemizedlist"><ul type="disc">
1.108     rillig   10859: <li><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10860:        operating system for which the packages have been built. The
1.110     hubertf  10861:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10862:        command, so it may differ from the one you are used to
                   10863:        hear.</p></li>
1.108     rillig   10864: <li><p><code class="varname">ARCH</code> is the hardware
                   10865:        architecture of the platform for which the packages have been
1.110     hubertf  10866:        built. It also includes the <code class="varname">ABI</code> (Application
                   10867:        Binary Interface) for platforms that have several of
                   10868:        them.</p></li>
1.108     rillig   10869: <li><p><code class="varname">OSVERSION</code> is the version of
                   10870:        the operating system. For version numbers that change often (for
                   10871:        example NetBSD-current), the often-changing part should be
                   10872:        replaced with an <code class="literal">x</code>, for example
                   10873:        <code class="literal">4.99.x</code>.</p></li>
                   10874: <li><p><code class="varname">TAG</code> is either
                   10875:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10876:        for a stable branch, or <code class="literal">head</code> for packages
                   10877:        built from the HEAD branch. The latter should only be used when
                   10878:        the packages are updated on a regular basis. Otherwise the date
                   10879:        from checking out pkgsrc should be appended, for example
                   10880:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10881: </ul></div>
                   10882: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10883:        can quickly click through the directories on the
                   10884:        server and find the best binary packages for their machines. Since they
                   10885:        usually know the operating system and the hardware architecture, OPSYS
                   10886:        and ARCH are placed first. After these choices, they can select the
                   10887:        best combination of OSVERSION and TAG together, since it is usually the
                   10888:        case that packages stay compatible between different version of the
                   10889:        operating system.</p>
                   10890: <p>In each of these directories, there is a
                   10891:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10892:        <code class="filename">All</code> which contains all binary packages.
                   10893:        Besides that, there are various category directories that
                   10894:        contain symbolic links to the real binary packages.</p>
                   10895: </div>
                   10896: <div class="sect1" lang="en">
                   10897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   10898: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   10899: <p>Here are the reports from bulk builds, for those who want
                   10900:        to fix packages that didn't build on some of the platforms. The
1.110     hubertf  10901:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   10902: </div>
                   10903: <div class="sect1" lang="en">
                   10904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10905: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93      rillig   10906: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10907: source packages</h2></div></div></div>
                   10908: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10909:        that is the files that define how to create binary packages from
                   10910:        source archives.</p>
                   10911: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10912:        snapshot of the CVS repository, which is updated regularly. The
                   10913:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10914:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10915: <p>In the directories for the quarterly branches, there is an
                   10916:        additional file called
                   10917:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10918:        which contains the state of pkgsrc when it was branched.</p>
                   10919: </div>
1.75      rillig   10920: </div>
                   10921: <div class="appendix" lang="en">
                   10922: <div class="titlepage"><div><div><h2 class="title">
                   10923: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10924: <div class="toc">
                   10925: <p><b>Table of Contents</b></p>
                   10926: <dl>
1.79      rillig   10927: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10928: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10929: </dl>
                   10930: </div>
1.79      rillig   10931: <p>This section contains information on editing the pkgsrc
                   10932:        guide itself.</p>
1.75      rillig   10933: <div class="sect1" lang="en">
                   10934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10935: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10936: <p>The pkgsrc guide's source code is stored in
                   10937:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10938:        are created from it:</p>
                   10939: <div class="itemizedlist"><ul type="disc">
                   10940: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10941: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110     hubertf  10942: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   10943: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   10944:        The PDF version of the pkgsrc guide.</p></li>
1.110     hubertf  10945: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   10946:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10947: </ul></div>
                   10948: </div>
                   10949: <div class="sect1" lang="en">
                   10950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10951: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10952: <p>The procedure to edit the pkgsrc guide is:</p>
                   10953: <div class="procedure"><ol type="1">
                   10954: <li><p>Make sure you have the packages needed to
1.83      wiz      10955:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   10956:        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
                   10957:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79      rillig   10958:        PostScript and PDF versions. You will need both packages
                   10959:        installed, to make sure documentation is consistent across all
                   10960:        formats.</p></li>
1.110     hubertf  10961: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   10962:        right directory. All further steps will take place
                   10963:        here.</p></li>
                   10964: <li><p>Edit the XML file(s) in
                   10965:        <code class="filename">files/</code>.</p></li>
1.110     hubertf  10966: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   10967:        guide for valid XML and to build the final output files. If you
                   10968:        get any errors at this stage, you can just edit the files, as
                   10969:        there are only symbolic links in the working directory, pointing
                   10970:        to the files in <code class="filename">files/</code>.</p></li>
1.110     hubertf  10971: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   10972:        commit)</strong></span></p></li>
1.110     hubertf  10973: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   10974:        regenerate the output files with the proper RCS
                   10975:        Ids.</p></li>
1.91      rillig   10976: <li>
1.110     hubertf  10977: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   10978:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10979:        <code class="filename">htdocs</code>.</p>
                   10980: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10981: <h3 class="title">Note</h3>
                   10982: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  10983:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10984:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   10985:        directory.</p>
                   10986: </div>
                   10987: </li>
1.79      rillig   10988: </ol></div>
1.75      rillig   10989: </div>
                   10990: </div>
                   10991: </div></body>
1.1       grant    10992: </html>

CVSweb <webmaster@jp.NetBSD.org>