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

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.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.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>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     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.148     asau       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>
1.157     asau       67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
1.82      rillig     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     81: <dd><dl>
1.151     obache     82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth    85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                     86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                     87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                     88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                     89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                     90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                     91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig     92: </dl></dd>
                     93: </dl></dd>
                     94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     97: <dd><dl>
                     98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    103: <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>
                    104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    105: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    106: </dl></dd>
                    107: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    108: <dd><dl>
                    109: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    110: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    111: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    112: </dl></dd>
                    113: </dl></dd>
                    114: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    115: <dd><dl>
                    116: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    117: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    118: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       119: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       120: <dd><dl>
1.103     wiz       121: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       122: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    123: <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       124: </dl></dd>
1.103     wiz       125: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    126: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    127: </dl></dd>
                    128: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    129: <dd><dl>
                    130: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    131: <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    132: </dl></dd>
                    133: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    134: builds)</a></span></dt>
1.75      rillig    135: <dd><dl>
1.106     rillig    136: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    137: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    138: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    139: <dd><dl>
                    140: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    141: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    142: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    143: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    144: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    145: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    146: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    147: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    150: <dd><dl>
                    151: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    152: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    153: </dl></dd>
1.106     rillig    154: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    155: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    156: </dl></dd>
                    157: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    158: <dd><dl>
1.128     wiz       159: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    160: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    161: </dl></dd>
                    162: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    163: <dd><dl>
                    164: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    167: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    168: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    169: <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>
                    170: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173   ! wiz       171: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
        !           172: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
        !           173: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
        !           174: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       175: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.173   ! wiz       176: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
        !           177: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
        !           178: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
        !           179: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
        !           180: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !           181: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build.  What shall I do?</a></span></dt>
        !           182: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    183: </dl></dd>
                    184: </dl></dd>
                    185: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    186: <dd><dl>
1.106     rillig    187: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    188: <dd><dl>
1.106     rillig    189: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    190: <dd><dl>
1.106     rillig    191: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    192: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil      193: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    194: </dl></dd>
1.106     rillig    195: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    196: <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>
                    197: </dl></dd>
                    198: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    199: <dd><dl>
1.128     wiz       200: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    201: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig    202: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    203: <dd><dl>
                    204: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    205: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    206: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    207: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    208: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    209: </dl></dd>
                    210: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    211: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    212: <dd><dl>
                    213: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    214: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    215: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    216: </dl></dd>
1.128     wiz       217: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    218: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    219: </dl></dd>
1.128     wiz       220: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    221: <dd><dl>
                    222: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz       223: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    224: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    225: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    226: <dd><dl>
                    227: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    228: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    229: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    230: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    231: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    232: </dl></dd>
                    233: </dl></dd>
                    234: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    235: <dd><dl>
                    236: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz       237: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    238: <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    239: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    240: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz       241: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig    242: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    243: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    244: </dl></dd>
                    245: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    246: <dd><dl>
                    247: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz       248: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    249: <dd><dl>
                    250: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz       251: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    252:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    253:       and
                    254:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    255:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    256: </dl></dd>
1.128     wiz       257: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    258: <dd><dl>
1.128     wiz       259: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig    260: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    261: </dl></dd>
                    262: </dl></dd>
                    263: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    264: <dd><dl>
                    265: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    266: <dd><dl>
                    267: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    268: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    269: </dl></dd>
                    270: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    271: <dd><dl>
1.128     wiz       272: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig    273: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    274: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    275: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    276: </dl></dd>
                    277: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    278: <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>
                    279: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    280: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    281: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    282: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    283: <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>
                    284: </dl></dd>
                    285: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    286: <dd><dl>
                    287: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz       288: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig    289: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    290: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    291: </dl></dd>
                    292: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    293: <dd><dl>
                    294: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    295: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    296: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz       298: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    299: <dd><dl>
                    300: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    301: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    302: </dl></dd>
1.128     wiz       303: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    306: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    308: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    309: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    310: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    311: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    312: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig    313: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    314: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    315: </dl></dd>
                    316: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    317: <dd><dl>
                    318: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    319: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    320: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    321: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    322: </dl></dd>
                    323: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    324: <dd><dl>
                    325: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128     wiz       328: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig    329: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    330: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    331: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    332: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    333: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    334: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    335: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    336: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    337: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    338: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    339: </dl></dd>
1.128     wiz       340: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    341: <dd><dl>
                    342: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    343: <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>
                    344: </dl></dd>
1.128     wiz       345: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    348: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    349: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    350: </dl></dd>
                    351: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    352: <dd><dl>
                    353: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    354: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    355: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz       356: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    357: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig    358: </dl></dd>
1.128     wiz       359: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig    360: <dd><dl>
                    361: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    362: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz       363: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig    364: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    365: </dl></dd>
1.128     wiz       366: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig    367: <dd><dl>
                    368: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    369: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    370: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    371: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    372: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    373: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    374: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    375: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    376: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    377: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    378: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    379: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    380: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    381: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    382: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    383: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    384: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    385: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       386:     emulation</a></span></dt>
1.106     rillig    387: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    388: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    389: </dl></dd>
1.106     rillig    390: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    391: </dl></dd>
1.106     rillig    392: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    393: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    394: <dd><dl>
1.106     rillig    395: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    396: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    397: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz       398: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig    399: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed      400: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    401: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    402: </dl></dd>
                    403: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    404: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    405: <dd><dl>
                    406: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    407: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    408: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    409: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      410: </dl></dd>
1.75      rillig    411: </dl></dd>
                    412: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    413: <dd><dl>
1.106     rillig    414: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    415: <dd><dl>
1.106     rillig    416: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    417: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    418: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    419: <dd><dl>
1.106     rillig    420: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    421: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    422: </dl></dd>
1.106     rillig    423: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    424: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    425: <dd><dl>
1.106     rillig    426: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    427: <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    428: </dl></dd>
1.106     rillig    429: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    430: <dd><dl>
1.128     wiz       431: <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>
                    432: <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    433: </dl></dd>
                    434: </dl></dd>
1.106     rillig    435: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    436: <dd><dl>
1.106     rillig    437: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    438: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    439: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    440: <dd><dl>
1.106     rillig    441: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    442: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    443: </dl></dd>
                    444: </dl></dd>
1.106     rillig    445: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    446: <dd><dl>
1.106     rillig    447: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    448: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    449: </dl></dd>
                    450: </dl></dd>
                    451: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    452: <dd><dl>
                    453: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    454: <dd><dl>
                    455: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    456: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    457: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz       458: <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    459: </dl></dd>
                    460: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    461: </dl></dd>
                    462: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    463: <dd><dl>
                    464: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    465: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    466: </dl></dd>
1.76      rillig    467: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    468: <dd><dl>
1.128     wiz       469: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    470: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    471: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    472: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    473: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    474: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    475: source packages</a></span></dt>
                    476: </dl></dd>
1.75      rillig    477: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    478: <dd><dl>
1.79      rillig    479: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    480: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    481: </dl></dd>
                    482: </dl>
                    483: </div>
1.82      rillig    484: <div class="list-of-tables">
                    485: <p><b>List of Tables</b></p>
                    486: <dl>
                    487: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    488: </dt>
1.106     rillig    489: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      490: </dt>
1.106     rillig    491: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      492: </dt>
1.82      rillig    493: </dl>
                    494: </div>
1.148     asau      495: <div class="chapter">
                    496: <div class="titlepage"><div><div><h1 class="title">
                    497: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    498: <div class="toc">
                    499: <p><b>Table of Contents</b></p>
                    500: <dl>
                    501: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    502: <dd><dl>
                    503: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    504: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    505: </dl></dd>
1.75      rillig    506: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    507: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       508: <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    509: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    510: </dl>
                    511: </div>
1.148     asau      512: <div class="sect1">
1.75      rillig    513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    514: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    515: <p>There is a lot of software freely available for Unix-based
                    516: systems, which is usually available in form of the source code. Before
                    517: such software can be used, it needs to be configured to the local
                    518: system, compiled and installed, and this is exactly what The NetBSD
                    519: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    520: to handle binary packages, so that not every user has to build the
                    521: packages for himself, which is a time-costly task.</p>
1.75      rillig    522: <p>pkgsrc currently contains several thousand packages,
                    523:       including:</p>
1.148     asau      524: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       525: <li class="listitem"><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    526:          web server</p></li>
1.128     wiz       527: <li class="listitem"><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    528:          web browser</p></li>
1.128     wiz       529: <li class="listitem"><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    530:          Desktop Environment</p></li>
1.128     wiz       531: <li class="listitem"><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    532:          Desktop Environment</p></li>
                    533: </ul></div>
                    534: <p>...just to name a few.</p>
                    535: <p>pkgsrc has built-in support for handling varying dependencies,
                    536:       such as pthreads and X11, and extended features such as IPv6 support on
                    537:       a range of platforms.</p>
1.148     asau      538: <div class="sect2">
1.82      rillig    539: <div class="titlepage"><div><div><h3 class="title">
                    540: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    541: <p>
                    542: pkgsrc provides the following key features:
                    543: </p>
1.148     asau      544: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       545: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    546:   and installation of binary packages. The source and latest
                    547:   patches are retrieved from a master or mirror download site, checksum
                    548:   verified, then built on your system. Support for binary-only
                    549:   distributions is available for both native platforms and NetBSD
                    550:   emulated platforms.</p></li>
1.128     wiz       551: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    552:   including binaries, libraries, man pages and other
                    553:   documentation.</p></li>
1.128     wiz       554: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.82      rillig    555:   are handled automatically. The configuration files of various
                    556:   packages are handled automatically during updates, so local changes
                    557:   are preserved.</p></li>
1.128     wiz       558: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    559:   consists of highly portable code. This allows the greatest speed of
1.132     spz       560:   development when porting to a new platform. This portability also
1.82      rillig    561:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    562:   platforms</em></span>.</p></li>
1.128     wiz       563: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    564:   international encryption requirements and build-time options for a
                    565:   large number of packages are all set in a simple, central
                    566:   configuration file.</p></li>
1.128     wiz       567: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    568:   freely available under a BSD license, so you may extend and adapt
                    569:   pkgsrc to your needs. Support for local packages and patches is
                    570:   available right out of the box, so you can configure it specifically
                    571:   for your environment.</p></li>
                    572: </ul></div>
1.91      rillig    573: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      574: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       575: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  576: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    577: them and to complain about them rather than to just install the package
                    578: and hope that it works. There are numerous checks in pkgsrc that try to
                    579: 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
                    580: of shell scripts), and post-installation checks (installed files,
                    581: references to shared libraries, script interpreters).</p></li>
1.128     wiz       582: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  583: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    584: pkgsrc has been ported to many operating systems. Care is taken that
                    585: packages behave the same on all platforms.</p></li>
                    586: </ul></div>
1.82      rillig    587: </div>
1.148     asau      588: <div class="sect2">
1.82      rillig    589: <div class="titlepage"><div><div><h3 class="title">
                    590: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    591: <p>pkgsrc consists of both a source distribution and a binary
                    592: distribution for these operating systems. After retrieving the required
                    593: source or binaries, you can be up and running with pkgsrc in just
                    594: minutes!</p>
1.75      rillig    595: <p>pkgsrc was derived from FreeBSD's ports system, and
                    596:       initially developed for NetBSD only. Since then, pkgsrc has
                    597:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    598: <div class="table">
                    599: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    600: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    601: <colgroup>
                    602: <col>
                    603: <col>
                    604: </colgroup>
                    605: <thead><tr>
                    606: <th>Platform</th>
                    607: <th>Date Support Added</th>
                    608: </tr></thead>
                    609: <tbody>
                    610: <tr>
1.110     hubertf   611: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    612: <td align="center">Aug 1997</td>
                    613: </tr>
                    614: <tr>
1.110     hubertf   615: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    616: <td align="center">Mar 1999</td>
                    617: </tr>
                    618: <tr>
1.110     hubertf   619: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    620: <td align="center">Jun 1999</td>
                    621: </tr>
                    622: <tr>
                    623: <td>
1.110     hubertf   624:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    625:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    626:         </td>
                    627: <td align="center">Oct 2001</td>
                    628: </tr>
                    629: <tr>
1.110     hubertf   630: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    631: <td align="center">Nov 2002</td>
                    632: </tr>
                    633: <tr>
1.110     hubertf   634: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    635: <td align="center">Nov 2002</td>
                    636: </tr>
                    637: <tr>
1.110     hubertf   638: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    639: <td align="center">Dec 2002</td>
                    640: </tr>
                    641: <tr>
                    642: <td>BSD/OS</td>
                    643: <td align="center">Dec 2003</td>
                    644: </tr>
                    645: <tr>
1.110     hubertf   646: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    647: <td align="center">Dec 2003</td>
                    648: </tr>
                    649: <tr>
                    650: <td>
1.110     hubertf   651:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    652:           (Microsoft Windows Services for Unix)
                    653:         </td>
                    654: <td align="center">Mar 2004</td>
                    655: </tr>
                    656: <tr>
1.110     hubertf   657: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    658: <td align="center">Oct 2004</td>
                    659: </tr>
                    660: <tr>
1.110     hubertf   661: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    662: <td align="center">Nov 2004</td>
                    663: </tr>
1.98      wiz       664: <tr>
1.110     hubertf   665: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       666: <td align="center">Apr 2007</td>
                    667: </tr>
1.128     wiz       668: <tr>
                    669: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    670: <td align="center">Sep 2010</td>
                    671: </tr>
1.151     obache    672: <tr>
                    673: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  674: <td align="center">Jan 2011</td>
1.151     obache    675: </tr>
                    676: <tr>
                    677: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    678: <td align="center">Nov 2011</td>
                    679: </tr>
                    680: <tr>
                    681: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    682: <td align="center">Mar 2013</td>
                    683: </tr>
1.166     jnemeth   684: <tr>
                    685: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    686: <td align="center">Jul 2013</td>
                    687: </tr>
1.82      rillig    688: </tbody>
1.91      rillig    689: </table></div>
1.82      rillig    690: </div>
1.91      rillig    691: <br class="table-break">
1.82      rillig    692: </div>
1.75      rillig    693: </div>
1.148     asau      694: <div class="sect1">
1.75      rillig    695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    696: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    697: <p>This document is divided into three parts. The first,
1.110     hubertf   698:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    699:        describes how one can use one of the packages in the Package
                    700:        Collection, either by installing a precompiled binary package,
1.93      rillig    701:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   702:        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    703:        package so it can be easily built by other NetBSD users without
                    704:        knowing about the package's building details. The third part,
1.110     hubertf   705:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    706:        is intended for those who want to understand how pkgsrc is
                    707:        implemented.</p>
                    708: <p>This document is available in various formats:
1.110     hubertf   709:        <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    710: </div>
1.148     asau      711: <div class="sect1">
1.75      rillig    712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    713: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       714: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    715:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    716:       terminology used within this document.</p>
1.148     asau      717: <div class="variablelist"><dl class="variablelist">
1.75      rillig    718: <dt><span class="term">Package</span></dt>
                    719: <dd><p>A set of files and building instructions
                    720:            that describe what's necessary
                    721:            to build a certain piece of software using
                    722:             pkgsrc. Packages are traditionally stored under
1.76      rillig    723:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    724: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       725: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       726:          is part of the NetBSD operating system and can be bootstrapped
                    727:          to run on non-NetBSD operating systems as well.  It handles
                    728:          building (compiling), installing, and removing of
                    729:          packages.</p></dd>
1.75      rillig    730: <dt><span class="term">Distfile</span></dt>
                    731: <dd><p>This term describes the file or files that are
                    732:            provided by the author of the piece of software to
                    733:            distribute his work. All the changes necessary to build on
                    734:            NetBSD are reflected in the corresponding package. Usually
                    735:            the distfile is in the form of a compressed tar-archive,
                    736:            but other types are possible, too. Distfiles are usually
                    737:            stored below
1.76      rillig    738:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    739: <dt><span class="term">Port</span></dt>
                    740: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    741:            for what we call a package.
1.128     wiz       742:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    743:            architecture.</p></dd>
                    744: <dt><span class="term">Precompiled/binary package</span></dt>
                    745: <dd>
                    746: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    747:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    748:            file so it can be installed on machines of the same
                    749:            machine architecture without the need to
                    750:            recompile. Packages are usually generated in
1.76      rillig    751:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       752:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       753: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    754:            especially in the context of precompiled packages.</p>
                    755: </dd>
                    756: <dt><span class="term">Program</span></dt>
1.88      wiz       757: <dd><p>The piece of software to be installed which will be
                    758:          constructed from all the files in the distfile by the
                    759:          actions defined in the corresponding package.</p></dd>
1.75      rillig    760: </dl></div>
1.148     asau      761: <div class="sect2">
1.75      rillig    762: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       763: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      764: <div class="variablelist"><dl class="variablelist">
1.75      rillig    765: <dt><span class="term">pkgsrc users</span></dt>
                    766: <dd>
                    767: <p>The
                    768:        pkgsrc users are people who use the packages provided by pkgsrc.
                    769:        Typically they are system administrators. The people using the
1.128     wiz       770:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    771:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    772: <p>There are two kinds of pkgsrc users: Some only want to
                    773:        install pre-built binary packages. Others build the pkgsrc
                    774:        packages from source, either for installing them directly or for
1.110     hubertf   775:        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    776:        documentation.</p>
                    777: </dd>
                    778: <dt><span class="term">package maintainers</span></dt>
                    779: <dd><p>A
1.110     hubertf   780:        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    781: <dt><span class="term">infrastructure developers</span></dt>
                    782: <dd><p>These people are involved in all those files
1.76      rillig    783:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   784:        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    785:        too.</p></dd>
                    786: </dl></div>
                    787: </div>
                    788: </div>
1.148     asau      789: <div class="sect1">
1.75      rillig    790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    791: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    792: <p>When giving examples for commands, shell prompts are used to
                    793:       show if the command should/can be issued as root, or if
1.128     wiz       794:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.75      rillig    795:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    796:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    797: </div>
                    798: </div>
1.148     asau      799: <div class="part">
1.75      rillig    800: <div class="titlepage"><div><div><h1 class="title">
                    801: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    802: <div class="toc">
                    803: <p><b>Table of Contents</b></p>
                    804: <dl>
                    805: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    806: <dd><dl>
                    807: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    808: <dd><dl>
1.157     asau      809: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       810: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    811: </dl></dd>
                    812: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    813: <dd><dl>
                    814: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    815: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    816: </dl></dd>
                    817: </dl></dd>
                    818: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    819: <dd><dl>
1.82      rillig    820: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    821: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    822: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    823: <dd><dl>
1.151     obache    824: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                    825: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                    826: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth   827: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                    828: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                    829: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                    830: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                    831: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                    832: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                    833: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig    834: </dl></dd>
                    835: </dl></dd>
                    836: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    837: <dd><dl>
                    838: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    839: <dd><dl>
                    840: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    841: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    842: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    843: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    844: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    845: <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>
                    846: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    847: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    848: </dl></dd>
                    849: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    850: <dd><dl>
                    851: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    852: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    853: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    854: </dl></dd>
                    855: </dl></dd>
                    856: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    857: <dd><dl>
                    858: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    859: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    860: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       861: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       862: <dd><dl>
1.103     wiz       863: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       864: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    865: <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       866: </dl></dd>
1.103     wiz       867: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    868: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    869: </dl></dd>
                    870: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    871: <dd><dl>
                    872: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    873: <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    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    876: builds)</a></span></dt>
1.75      rillig    877: <dd><dl>
1.106     rillig    878: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    879: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    880: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    883: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    884: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    885: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    886: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    887: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    888: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    889: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    890: </dl></dd>
                    891: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    892: <dd><dl>
                    893: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    894: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    895: </dl></dd>
1.106     rillig    896: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    897: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    898: </dl></dd>
                    899: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    900: <dd><dl>
1.128     wiz       901: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    902: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    903: </dl></dd>
                    904: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    907: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    908: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    909: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    910: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    911: <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>
                    912: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173   ! wiz       913: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
        !           914: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
        !           915: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
        !           916: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       917: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.173   ! wiz       918: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
        !           919: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
        !           920: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
        !           921: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
        !           922: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !           923: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build.  What shall I do?</a></span></dt>
        !           924: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    925: </dl></dd>
                    926: </dl>
                    927: </div>
1.148     asau      928: <div class="chapter">
1.75      rillig    929: <div class="titlepage"><div><div><h2 class="title">
                    930: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    931: <div class="toc">
                    932: <p><b>Table of Contents</b></p>
                    933: <dl>
                    934: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    935: <dd><dl>
1.157     asau      936: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       937: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    938: </dl></dd>
                    939: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    940: <dd><dl>
                    941: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    942: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    943: </dl></dd>
                    944: </dl>
                    945: </div>
1.91      rillig    946: <p>Before you download and extract the files, you need to decide
                    947: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    948: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    949: free to install the sources and binary packages wherever you want in
                    950: your filesystem, provided that the pathname does not contain white-space
                    951: or other characters that are interpreted specially by the shell and some
                    952: other programs. A safe bet is to use only letters, digits, underscores
                    953: and dashes.</p>
1.148     asau      954: <div class="sect1">
1.75      rillig    955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    956: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    957: <p>Before you download any pkgsrc files, you should decide
                    958:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    959:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    960:        quarterly basis from the current branch and only gets modified
                    961:        for security updates. The names of the stable branches are built
                    962:        from the year and the quarter, for example
1.124     snj       963:        <code class="literal">2009Q1</code>.</p>
1.75      rillig    964: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       965:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    966:        Both ways are described here.</p>
1.157     asau      967: <p>Note that tar archive contains CVS working copy.
                    968:        Thus you can switch to using CVS at any later time.</p>
                    969: <p>Note also that quarterly branch is not frozen in stone.
                    970:        It receives critical updates.</p>
1.148     asau      971: <div class="sect2">
1.75      rillig    972: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      973: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    974: <p>The primary download location for all pkgsrc files is
1.157     asau      975:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    976:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    977:        (it points to the same location).
                    978:        There are a number of subdirectories for different purposes,
                    979:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
                    980: <p>The tar archive for the current branch is in the directory
                    981:        <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    982:        It is autogenerated daily.</p>
1.157     asau      983: <p>To save download time we provide bzip2- and
                    984:        xz-compressed archives which are published at
                    985:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    986:        and
                    987:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    988:        respectively.
                    989:        </p>
                    990: <p>You can fetch the same files using FTP.</p>
1.166     jnemeth   991: <p>The tar file for the stable branch 2013Q1 is in the
                    992:        directory <code class="filename">pkgsrc-2013Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2013Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112     weinem    993: <p>To download a pkgsrc stable tarball, run:</p>
                    994: <pre class="screen">
1.166     jnemeth   995: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126     jakllsch  996: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112     weinem    997:        stable branch to be downloaded, for example, 
1.166     jnemeth   998:        <span class="quote">&#8220;<span class="quote">pkgsrc-2013Q1</span>&#8221;</span>.</p>
1.157     asau      999: <p>You can use fetch it also using "wget", "curl",
                   1000:        or your web browser.</p>
1.112     weinem   1001: <p>Then, extract it with:</p>
1.126     jakllsch 1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1003: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1004:        in <code class="filename">/usr/</code> and all the package source will be 
                   1005:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1006: <p>To download pkgsrc-current, run:</p>
                   1007: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig   1008: </div>
1.148     asau     1009: <div class="sect2">
1.75      rillig   1010: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      1011: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                   1012: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146     wiz      1013: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128     wiz      1014: </pre>
                   1015: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
                   1016:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
                   1017: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1018:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1019:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1020: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1021: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       grant    1022: </pre>
1.136     dholland 1023: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1024: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146     wiz      1025: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128     wiz      1026: </pre>
                   1027: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1028:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1029:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1030: <pre class="programlisting">
                   1031: # set CVS remote shell command
                   1032: CVS_RSH=ssh
                   1033: export CVS_RSH
                   1034: </pre>
                   1035: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1036:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1037:        in your home directory and saving the following lines to it.
                   1038:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1039:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1040: <pre class="programlisting">
                   1041: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1042: cvs -q -z2
1.101     rillig   1043: checkout -P
1.103     wiz      1044: update -dP
                   1045: diff -upN
1.101     rillig   1046: rdiff -u
1.128     wiz      1047: release -d
1.101     rillig   1048: </pre>
1.75      rillig   1049: </div>
                   1050: </div>
1.148     asau     1051: <div class="sect1">
1.75      rillig   1052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1053: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1054: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1055:        (which also works if you have first installed it via a tar
                   1056:        file). It saves bandwidth and hard disk activity, compared to
                   1057:        downloading the tar file again.</p>
1.148     asau     1058: <div class="sect2">
1.75      rillig   1059: <div class="titlepage"><div><div><h3 class="title">
                   1060: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1061: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1062: <h3 class="title">Warning</h3>
1.77      rillig   1063: <p>When updating from a tar file, you first need to
                   1064:        completely remove the old pkgsrc directory. Otherwise those
                   1065:        files that have been removed from pkgsrc in the mean time will
                   1066:        not be removed on your local disk, resulting in inconsistencies.
                   1067:        When removing the old files, any changes that you have done to
                   1068:        the pkgsrc files will be lost after updating. Therefore updating
                   1069:        via CVS is strongly recommended.</p>
1.75      rillig   1070: </div>
1.82      rillig   1071: <p>Note that by default the distfiles and the binary packages
                   1072:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1073:        before updating. You can also configure pkgsrc to use other than
                   1074:        the default directories by setting the
                   1075:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1076:        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   1077: <p>To update pkgsrc from a tar file, download the tar file as
                   1078:        explained above. Then, make sure that you have not made any
                   1079:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1080:        directory and extract the new tar file. Done.</p>
                   1081: </div>
1.148     asau     1082: <div class="sect2">
1.75      rillig   1083: <div class="titlepage"><div><div><h3 class="title">
                   1084: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1085: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1086: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1087: </pre>
                   1088: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
                   1089: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
                   1090: </pre>
1.148     asau     1091: <div class="sect3">
1.75      rillig   1092: <div class="titlepage"><div><div><h4 class="title">
                   1093: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1094: <p>When updating pkgsrc, the CVS program keeps track of the
                   1095:        branch you selected. But if you, for whatever reason, want to
                   1096:        switch from the stable branch to the current one, you can do it
1.128     wiz      1097:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1098:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1099:        back to the stable branch, add the
1.128     wiz      1100:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1.75      rillig   1101: </div>
1.148     asau     1102: <div class="sect3">
1.75      rillig   1103: <div class="titlepage"><div><div><h4 class="title">
                   1104: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1105: <p>When you update pkgsrc, the CVS program will only touch
                   1106:        those files that are registered in the CVS repository. That
                   1107:        means that any packages that you created on your own will stay
                   1108:        unmodified. If you change files that are managed by CVS, later
                   1109:        updates will try to merge your changes with those that have been
                   1110:        done by others. See the CVS manual, chapter
1.128     wiz      1111:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1112: </div>
                   1113: </div>
                   1114: </div>
                   1115: </div>
1.148     asau     1116: <div class="chapter">
1.75      rillig   1117: <div class="titlepage"><div><div><h2 class="title">
                   1118: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1119: <div class="toc">
                   1120: <p><b>Table of Contents</b></p>
                   1121: <dl>
1.82      rillig   1122: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1123: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1124: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1125: <dd><dl>
1.151     obache   1126: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                   1127: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                   1128: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth  1129: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                   1130: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                   1131: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                   1132: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                   1133: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                   1134: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                   1135: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig   1136: </dl></dd>
                   1137: </dl>
                   1138: </div>
1.148     asau     1139: <div class="sect1">
1.75      rillig   1140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1141: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1142: <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   1143: </div>
1.148     asau     1144: <div class="sect1">
1.82      rillig   1145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1146: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1147: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1148:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1149:     to privileged one all programs are installed under one particular user
1.149     asau     1150:     and cannot utilise privileged operations (packages don't create
                   1151:     special users and all special file permissions like setuid are ignored).
                   1152:     </p>
1.82      rillig   1153: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1154: <pre class="screen">
1.167     asau     1155: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75      rillig   1156: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1157: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1158:     </pre>
1.149     asau     1159: <p>To bootstrap in unprivileged mode pass <span class="quote">&#8220;<span class="quote">--unprivileged</span>&#8221;</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
                   1160: <p>By default, in privileged mode pkgsrc uses
                   1161:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1162:     where programs will be installed in,
1.87      wiz      1163:     and <code class="filename">/var/db/pkg</code> for the package database
1.149     asau     1164:     directory where pkgsrc will do its internal bookkeeping,
                   1165:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1166:     where packages install their persistent data.
                   1167:     In unprivileged mode pkgsrc uses
                   1168:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
                   1169:     <code class="filename">~/pkg/var/db/pkg</code> for the package database,
                   1170:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1171:     </p>
                   1172: <p>You can change default layout using command-line arguments.
                   1173:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1174:     </p>
1.148     asau     1175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1176: <h3 class="title">Note</h3>
1.110     hubertf  1177: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1178:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1179:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1180:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1181: </div>
1.149     asau     1182: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1183: <h3 class="title">Note</h3>
                   1184: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1185:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1186:       corresponding to the installation you're working with to build
                   1187:       and install packages.
                   1188:       </p>
                   1189: </div>
1.75      rillig   1190: </div>
1.148     asau     1191: <div class="sect1">
1.75      rillig   1192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1193: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1194: <p>Here are some platform-specific notes you should be aware of.</p>
1.148     asau     1195: <div class="sect2">
1.75      rillig   1196: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1197: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
                   1198: <p>Cygwin 1.7.x and later are supported.</p>
                   1199: <p>You need to install minimal base packages in `Base' category
                   1200:       plus any of compiler, gcc, gcc4, and/or clang.
                   1201:       For gcc and gcc4, C and C++ compiler will be installed by default,
                   1202:       but you can install Fortran compiler additionally
                   1203:       because it will be required to use libtool.
                   1204:       If it is not installed (or too old), Fortran compiler will be
                   1205:       installed with pkgsrc automatically.</p>
                   1206: <p>As noted in
                   1207:       <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
                   1208:       su(1) command has been in Cygwin distribution, but it has never worked.
                   1209:       Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
                   1210:       </p>
                   1211: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
                   1212:           then pick "Run as administrator".</p></li></ul></div>
                   1213: </div>
                   1214: <div class="sect2">
                   1215: <div class="titlepage"><div><div><h3 class="title">
                   1216: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.148     asau     1217: <p>Darwin 5.x and up are supported.</p>
                   1218: <p>Before you start, you need to download and install
                   1219:       the Mac OS X Developer Tools from Apple's Developer Connection.
                   1220:       This requires (free) membership. See
1.126     jakllsch 1221:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148     asau     1222:       for details. Also, make sure you install X11 (an optional
                   1223:       package included with the Developer Tools) if you intend
                   1224:       to build packages that use the X11 Window System.
                   1225:       (If you don't want or need the full Xcode GUI,
                   1226:       download and install Command Line Tools for Xcode.)</p>
1.75      rillig   1227: </div>
1.148     asau     1228: <div class="sect2">
1.75      rillig   1229: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1230: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136     dholland 1231: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87      wiz      1232:       other versions may work.</p>
1.75      rillig   1233: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1234:       with the FreeBSD userland tools. There are several steps:</p>
1.128     wiz      1235: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1236: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87      wiz      1237:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1238:          recommended that you choose a different location (e.g.
                   1239:          <code class="filename">/usr/pkgdb</code>) by
                   1240:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1241: <li class="listitem">
1.75      rillig   1242: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1243:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1244: <pre class="screen">
                   1245: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1246: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1247: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1248: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1249: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1250:          </pre>
1.75      rillig   1251: </li>
1.128     wiz      1252: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1253:          <code class="filename">/etc/mk.conf.example</code> file
                   1254:          when you use the bootstrap script.</p></li>
1.75      rillig   1255: </ol></div>
                   1256: </div>
1.148     asau     1257: <div class="sect2">
1.75      rillig   1258: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1259: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
                   1260: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
                   1261:       Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
                   1262: <p> You should install ncurses (libncurses and libncurses-dev)
                   1263:       packages.</p>
                   1264: </div>
                   1265: <div class="sect2">
                   1266: <div class="titlepage"><div><div><h3 class="title">
                   1267: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75      rillig   1268: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1269:       providing a Unix-like environment with a tighter kernel integration than
                   1270:       available with Cygwin.  It is part of the Windows Services for Unix
                   1271:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1272:       (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   1273: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1274:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1275:       of pthreads, but other parts of libc may also be lacking.)</p>
1.129     wiz      1276: <p>Services for Unix Applications (aka SUA) is an integrated
                   1277:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1278:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1279:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1280:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1281:       work as well. The Interix 5.x subsystem has not yet been tested
                   1282:       with pkgsrc.</p>
1.148     asau     1283: <div class="sect3">
1.75      rillig   1284: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1285: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1286: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1287:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148     asau     1288: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1289: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1290: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1291: <li class="listitem"><p>Remote Connectivity</p></li>
                   1292: <li class="listitem"><p>Interix SDK</p></li>
1.75      rillig   1293: </ul></div>
                   1294: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1295:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1296:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1297:        pkgsrc (or from a binary package).</p>
1.75      rillig   1298: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1299:        not need to be installed, but Remote Connectivity itself should be
                   1300:        installed in order to have a working inetd.</p>
1.75      rillig   1301: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1302:        behavior for Interix programs, and whether to make pathnames default to
                   1303:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1304:        enabled.  (Without case-sensitivity, a large number of packages including
                   1305:        perl will not build.)</p>
1.75      rillig   1306: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1307:        works (via the Data Execution Prevention feature).  In order to use
                   1308:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1309:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1310:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1311:        support contract; however, Debian Interix Port has made most Interix
                   1312:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93      rillig   1313: <p>In addition to the hotfix noted above, it may be necessary to
                   1314:        disable Data Execution Prevention entirely to make Interix functional.
                   1315:        This may happen only with certain types of CPUs; the cause is not fully
                   1316:        understood at this time.  If gcc or other applications still segfault
                   1317:        repeatedly after installing one of the hotfixes note above, the
                   1318:        following option can be added to the appropriate "boot.ini" line on the
                   1319:        Windows boot drive:  /NoExecute=AlwaysOff
                   1320:        (WARNING, this will disable DEP completely, which may be a security
                   1321:        risk if applications are often run as a user in the Administrators
                   1322:        group!)</p>
1.75      rillig   1323: </div>
1.148     asau     1324: <div class="sect3">
1.75      rillig   1325: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1326: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1327: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1328:        with pkgsrc, note the following things.</p>
1.148     asau     1329: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1330: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1331:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1332:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.128     wiz      1333: <li class="listitem">
1.75      rillig   1334: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1335:            change the following registry key:</p>
1.75      rillig   1336: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1337: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1338: </li>
1.128     wiz      1339: <li class="listitem">
1.75      rillig   1340: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1341:            following registry key:</p>
1.75      rillig   1342: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1343: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1344: </li>
                   1345: </ul></div>
                   1346: </div>
1.148     asau     1347: <div class="sect3">
1.75      rillig   1348: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1349: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1350: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1351:        running "pkg_add") must be a member of the local Administrators
                   1352:        group.  Such a user must also be used to run the bootstrap.  This is
                   1353:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1354: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1355:        automatically complain if this is not the case.  This ensures that
                   1356:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1357: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1358:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1359:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1360:        the same time as the pkgsrc packages, ensure that you use the proper
                   1361:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1362: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1363:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1364:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1365:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1366: <pre class="programlisting">
1.100     rillig   1367: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1368:        </pre>
1.75      rillig   1369: </div>
1.148     asau     1370: <div class="sect3">
1.75      rillig   1371: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1372: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1373: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1374:        for a full Unix-like platform, it has some drawbacks that should
                   1375:        be noted for those desiring to make the most of Interix.</p>
1.148     asau     1376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1377: <li class="listitem">
1.75      rillig   1378: <p><span class="strong"><strong>X11:</strong></span></p>
                   1379: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1380:          and can run X11 based applications, but it does
                   1381:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1382:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1383:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1384:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1385:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1386:          and the free X11 server included with
1.110     hubertf  1387:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1388: </li>
1.128     wiz      1389: <li class="listitem">
1.75      rillig   1390: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1391: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1392:          Win32 applications, it does not currently support various X11
                   1393:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1394:          Most interactive applications to a local X server will run
                   1395:          reasonably fast, but full motion video and other graphics
                   1396:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1397: </li>
1.128     wiz      1398: <li class="listitem">
1.75      rillig   1399: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1400: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1401:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1402:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1403:          <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  1404:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1405:          server component.  To output audio via an Interix host, the
1.91      rillig   1406:          <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      1407:          must also be installed.</p>
1.75      rillig   1408: </li>
1.128     wiz      1409: <li class="listitem">
1.75      rillig   1410: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1411: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1412:          is not currently possible to access CD/DVD drives, USB devices,
                   1413:          or SCSI devices through non-filesystem means.  Among other things,
                   1414:          this makes it impossible to use Interix directly for CD/DVD
                   1415:          burning.</p>
1.75      rillig   1416: </li>
1.128     wiz      1417: <li class="listitem">
1.75      rillig   1418: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1419: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1420:          drives are also not directly accessible in Interix.  However,
                   1421:          support is in work to make tape drive access possible by using
                   1422:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1423:          esound server).</p>
1.75      rillig   1424: </li>
                   1425: </ul></div>
                   1426: </div>
1.148     asau     1427: <div class="sect3">
1.75      rillig   1428: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1429: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1430: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1431:        Windows system; any member of the local Administrators group will
                   1432:        suffice.  However, some packages currently assume that the user
                   1433:        named "root" is the privileged user.  To accommodate these, you
                   1434:        may create such a user; make sure it is in the local group
                   1435:        Administrators (or your language equivalent).</p>
1.110     hubertf  1436: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1437:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1438:        time being, install packages as the local Administrator (or
                   1439:        your language equivalent), or run the following command after
                   1440:        installing a package to work around the issue:</p>
1.75      rillig   1441: <pre class="screen">
1.87      wiz      1442: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1443:        </pre>
1.75      rillig   1444: </div>
                   1445: </div>
1.148     asau     1446: <div class="sect2">
1.75      rillig   1447: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1448: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75      rillig   1449: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1450:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1451:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1452:       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   1453: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.136     dholland 1454:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1455:       etc.</p>
1.86      schwarz  1456: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1457:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1458:        you start out using "abi=n32", that's what all your packages will be built
                   1459:        with.</p>
                   1460: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1461:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1462:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1463:       try to link n32 object files with lib64 or vice versa.  Check your
                   1464:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1465: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1466:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1467:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1468:       link over a network-mounted file system.</p>
1.75      rillig   1469: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1470:       as imake(1), but you may want to set some options depending on your local
                   1471:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1472:       course, your compiler's man pages for details.</p>
1.75      rillig   1473: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1474: 
1.87      wiz      1475:       </p>
1.75      rillig   1476: <pre class="programlisting">
1.100     rillig   1477: PKGSRC_COMPILER=        mipspro
1.87      wiz      1478:       </pre>
1.75      rillig   1479: <p>
1.1       grant    1480: 
1.110     hubertf  1481:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1482:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1483:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1484:       default.</p>
1.75      rillig   1485: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1486:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1487:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1488:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1489:       '--preserve-path' flag.</p>
1.75      rillig   1490: </div>
1.148     asau     1491: <div class="sect2">
1.75      rillig   1492: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1493: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87      wiz      1494: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1495:       either libtermcap or libcurses (libncurses).  Installing the
                   1496:       distributions libncurses-dev package (or equivalent) should fix
                   1497:       the problem.</p>
                   1498: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1499:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1500:       i386 have been tested.</p>
1.75      rillig   1501: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1502:       directory:</p>
1.75      rillig   1503: <pre class="programlisting">
1.138     wiz      1504: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87      wiz      1505:       </pre>
1.148     asau     1506: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1507: <h3 class="title">Note</h3>
1.138     wiz      1508: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1509: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1510: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1511: </div>
                   1512: <p>Use a value for ICCBASE that corresponds to the directory
                   1513:       where icc is installed. After bootstrapping, set
                   1514:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137     wiz      1515: <pre class="programlisting">
1.138     wiz      1516: ICCBASE=                /opt/intel/cc/10.1.008
1.87      wiz      1517:       </pre>
1.138     wiz      1518: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1519:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1520:       install directory for icc 8.0. If you are using a more recent
                   1521:       version, be sure to set the correct path explicitly.
                   1522:       </p>
1.75      rillig   1523: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1524:       provided by icc, so binaries can be run on other systems which do not
                   1525:       have the shared libraries installed.</p>
                   1526: <p>Libtool, however, extracts a list of libraries from the
1.136     dholland 1527:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1528:       records it, throwing away the -Bstatic and -Bdynamic options
                   1529:       interspersed between the libraries.  This means that
                   1530:       libtool-linked C++ shared libraries will have a runtime
                   1531:       dependency on the icc libraries until this is fixed in
                   1532:       libtool.</p>
1.75      rillig   1533: </div>
1.148     asau     1534: <div class="sect2">
1.75      rillig   1535: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1536: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163     bsiegert 1537: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
                   1538:       Older versions might also work. Releases before #10 are not
                   1539:       supported.</p>
                   1540: <p>The package tools of the (older) native ports tree,
                   1541:       <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
                   1542:       have the same names as the ones used by pkgsrc. Care should be taken
                   1543:       that the right tools are used. When installing packages from source,
                   1544:       use the <code class="filename">bmake</code> command for pkgsrc and
                   1545:       <code class="filename">mmake</code> for MirPorts.</p>
                   1546: <p>pkgsrc and MirPorts use the same location for the package
                   1547:       database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
                   1548:       to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
                   1549:       tree is self-contained. This is also the default setting used in the
                   1550:       binary package builds.</p>
                   1551: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
                   1552:       server. The bootstrap kit there already contains the
                   1553:       <span class="command"><strong>pkgin</strong></span> package manager. See the
                   1554:       <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
                   1555:       page for more details.</p>
                   1556: </div>
                   1557: <div class="sect2">
                   1558: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1559: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136     dholland 1560: <p>OpenBSD 5.1 has been tested and supported,
                   1561:       other versions may work.</p>
1.75      rillig   1562: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1563:       with the OpenBSD userland tools. There are several steps:</p>
1.128     wiz      1564: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1565: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87      wiz      1566:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1567:          recommended that you choose a different location (e.g.
                   1568:          <code class="filename">/usr/pkgdb</code>) by
                   1569:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1570: <li class="listitem">
1.75      rillig   1571: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1572:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1573: <pre class="screen">
                   1574: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1575: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1576: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1577: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1578: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1579:          </pre>
1.75      rillig   1580: </li>
1.128     wiz      1581: <li class="listitem">
1.110     hubertf  1582: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1583:          <code class="filename">/etc/mk.conf.example</code> file
                   1584:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1585:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1586:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1587:          of the file with:</p>
                   1588: <pre class="programlisting">
1.100     rillig   1589: .ifdef BSD_PKG_MK
                   1590: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1591: .else
                   1592: # OpenBSD stuff
                   1593: .endif
1.87      wiz      1594:          </pre>
1.75      rillig   1595: </li>
                   1596: </ol></div>
                   1597: </div>
1.148     asau     1598: <div class="sect2">
1.75      rillig   1599: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1600: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142     wiz      1601: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
                   1602:       You will need a working C compiler. Both gcc 4.5.3 and
1.87      wiz      1603:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1604: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1605:       process and to build packages.</p>
1.148     asau     1606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1607: <li class="listitem"><p>SUNWsprot</p></li>
                   1608: <li class="listitem"><p>SUNWarc</p></li>
                   1609: <li class="listitem"><p>SUNWbtool</p></li>
                   1610: <li class="listitem"><p>SUNWtoo</p></li>
                   1611: <li class="listitem"><p>SUNWlibm</p></li>
1.75      rillig   1612: </ul></div>
1.78      rillig   1613: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1614:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1615: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1616:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1617:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1618:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148     asau     1619: <div class="sect3">
1.75      rillig   1620: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1621: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1622: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1623:        for building all packages.</p>
1.75      rillig   1624: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1625:        then either build gcc from
1.142     wiz      1626:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.87      wiz      1627:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1628: <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   1629: </div>
1.148     asau     1630: <div class="sect3">
1.75      rillig   1631: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1632: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1633: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1634:        5.0)</p>
1.148     asau     1635: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1636: <li class="listitem"><p>SPROcc
1.87      wiz      1637:          - Sun WorkShop Compiler C 5.0</p></li>
1.128     wiz      1638: <li class="listitem"><p>SPROcpl
1.87      wiz      1639:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.128     wiz      1640: <li class="listitem"><p>SPROild
1.87      wiz      1641:          - Sun WorkShop Incremental Linker</p></li>
1.128     wiz      1642: <li class="listitem"><p>SPROlang
1.87      wiz      1643:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1644: </ul></div>
1.96      rillig   1645: <p>You should set the following variables in your
1.110     hubertf  1646:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1647: <pre class="programlisting">
1.100     rillig   1648: CC=     cc
                   1649: CXX=    CC
                   1650: CPP=    cc -E
                   1651: CXXCPP= CC -E
1.96      rillig   1652: </pre>
1.148     asau     1653: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1654: <h3 class="title">Note</h3>
                   1655: <p>The <code class="varname">CPP</code> setting might break some
                   1656:        packages that use the C preprocessor for processing things other
                   1657:        than C source code.</p>
                   1658: </div>
1.75      rillig   1659: </div>
1.148     asau     1660: <div class="sect3">
1.75      rillig   1661: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1662: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1663: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1664:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1665: <pre class="programlisting">
1.100     rillig   1666: PKGSRC_COMPILER=        sunpro
                   1667: ABI=                    64
1.96      rillig   1668: </pre>
1.148     asau     1669: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1670: <h3 class="title">Note</h3>
                   1671: <p>This setting has been tested for the SPARC
                   1672:        architecture. Intel and AMD machines need some more
                   1673:        work.</p>
                   1674: </div>
1.75      rillig   1675: </div>
1.148     asau     1676: <div class="sect3">
1.75      rillig   1677: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1678: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110     hubertf  1679: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1680:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1681:       The workaround is to use another shell for the configure
1.91      rillig   1682:       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  1683:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1684: <pre class="programlisting">
1.100     rillig   1685: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1686: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1687:       </pre>
1.91      rillig   1688: <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   1689: </div>
                   1690: </div>
                   1691: </div>
                   1692: </div>
1.148     asau     1693: <div class="chapter">
1.75      rillig   1694: <div class="titlepage"><div><div><h2 class="title">
                   1695: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1696: <div class="toc">
                   1697: <p><b>Table of Contents</b></p>
                   1698: <dl>
                   1699: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1700: <dd><dl>
                   1701: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1702: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1703: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1704: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1705: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1706: <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>
                   1707: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1708: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1709: </dl></dd>
                   1710: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1711: <dd><dl>
                   1712: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1713: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1714: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1715: </dl></dd>
                   1716: </dl>
                   1717: </div>
                   1718: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1719: is to only install the package tools and to use binary packages
1.128     wiz      1720: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1721: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1722: of pkgsrc, too. Then you are able to build your own packages,
                   1723: and you can still use binary packages from someone else.</p>
1.148     asau     1724: <div class="sect1">
1.75      rillig   1725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1726: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1727: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1728:   server and its mirrors, there are collections of binary packages,
                   1729:   ready to be installed. These binary packages have been built using the
                   1730:   default settings for the directories, that is:</p>
1.148     asau     1731: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1732: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1733: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1734: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109     rillig   1735: </ul></div>
                   1736: <p>If you cannot use these directories for whatever reasons (maybe
                   1737:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1738:   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.148     asau     1739: <div class="sect2">
1.75      rillig   1740: <div class="titlepage"><div><div><h3 class="title">
                   1741: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1742: <p>To install binary packages, you first need to know from where
                   1743:     to get them. The first place where you should look is on the main
1.110     hubertf  1744:     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   1745: <p>This directory contains binary packages for multiple
                   1746:     platforms. First, select your operating system. (Ignore the
                   1747:     directories with version numbers attached to it, they just exist for
                   1748:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1749:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1750: <p>In this directory, you often find a file called
                   1751:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1752:     management tools. If the file is missing, it is likely that your
                   1753:     operating system already provides those tools. Download the file and
                   1754:     extract it in the <code class="filename">/</code> directory. It will create
                   1755:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1756:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1757:     (the database of installed packages).</p>
1.75      rillig   1758: </div>
1.148     asau     1759: <div class="sect2">
1.75      rillig   1760: <div class="titlepage"><div><div><h3 class="title">
                   1761: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1762: <p>In the directory from the last section, there is a
                   1763:     subdirectory called <code class="filename">All</code>, which contains all the
                   1764:     binary packages that are available for the platform, excluding those
                   1765:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1766:     medium you are using).</p>
1.109     rillig   1767: <p>To install packages directly from an FTP or HTTP server, run
                   1768:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1769:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1770: <pre class="screen">
                   1771: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1772: <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>
                   1773: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1774: </pre>
                   1775: <p>Instead of URLs, you can also use local paths, for example if
                   1776:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1777:     repository. If you want to install packages from multiple sources,
                   1778:     you can separate them by a semicolon in
                   1779:     <code class="varname">PKG_PATH</code>.</p>
                   1780: <p>After these preparations, installing a package is very
                   1781:     easy:</p>
                   1782: <pre class="screen">
                   1783: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1784: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1785: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1786: </pre>
1.75      rillig   1787: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1788:     package in question will be installed, too, assuming they are
                   1789:     present where you install from.</p>
1.128     wiz      1790: <p>Adding packages might install vulnerable packages.
                   1791:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1792:     regularly, especially after installing new packages, and verify
                   1793:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1794: <p>After you've installed packages, be sure to have
1.88      wiz      1795:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1796:     <code class="varname">PATH</code> so you can actually start the just
                   1797:     installed program.</p>
1.75      rillig   1798: </div>
1.148     asau     1799: <div class="sect2">
1.75      rillig   1800: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1801: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1802: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1803:     installed from source code or from a binary package. The
1.110     hubertf  1804:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1805:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1806:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1807:     name can be given with or without version number. Wildcards can
                   1808:     also be used to deinstall a set of packages, for example
                   1809:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1810:     so that the shell does not expand them before
                   1811:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1812: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1813:     removes all the packages that require the package in question
                   1814:     and then removes the package itself. For example:
1.82      rillig   1815: 
1.88      wiz      1816:     </p>
1.82      rillig   1817: <pre class="screen">
1.88      wiz      1818: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1819:     </pre>
1.82      rillig   1820: <p>
                   1821: 
1.88      wiz      1822:     will remove jpeg and all the packages that used it; this allows
                   1823:     upgrading the jpeg package.</p>
1.82      rillig   1824: </div>
1.148     asau     1825: <div class="sect2">
1.82      rillig   1826: <div class="titlepage"><div><div><h3 class="title">
                   1827: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1828: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1829:     installed packages or binary package files.</p>
1.82      rillig   1830: </div>
1.148     asau     1831: <div class="sect2">
1.82      rillig   1832: <div class="titlepage"><div><div><h3 class="title">
                   1833: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1834: <p>
1.88      wiz      1835:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1836:       known security vulnerabilities to packages which are (or have been)
                   1837:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1838:       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      1839:     </p>
1.82      rillig   1840: <p>
1.125     wiz      1841:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1842:       this list can be downloaded
                   1843:       automatically, and a security audit of all packages installed on a system
                   1844:       can take place.
                   1845:     </p>
1.82      rillig   1846: <p>
1.125     wiz      1847:       There are two components to auditing.  The first
                   1848:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1849:       is for downloading
1.88      wiz      1850:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1851:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1852:       installed packages are vulnerable.  If a package is vulnerable, you
                   1853:       will see output similar to the following:
                   1854:     </p>
1.82      rillig   1855: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1856:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1857: <p>
1.125     wiz      1858:       You may wish to have the
1.110     hubertf  1859:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1860:       file downloaded daily so that
                   1861:       it remains current.  This may be done by adding an appropriate entry
1.136     dholland 1862:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1863:       </p>
                   1864: <pre class="screen">
                   1865: # download vulnerabilities file
                   1866: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1867:       </pre>
                   1868: <p>
                   1869:       will update the vulnerability list every day at 3AM. You may wish to do
                   1870:       this more often than once a day.
                   1871: 
                   1872:       In addition, you may wish to run the package audit from the daily
                   1873:       security script.  This may be accomplished by adding the following
                   1874:       line to <code class="filename">/etc/security.local</code>:
                   1875:       </p>
                   1876: <pre class="screen">
                   1877: /usr/sbin/pkg_admin audit
                   1878:       </pre>
                   1879: <p>
1.88      wiz      1880:     </p>
1.82      rillig   1881: </div>
1.148     asau     1882: <div class="sect2">
1.82      rillig   1883: <div class="titlepage"><div><div><h3 class="title">
                   1884: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1885: <p>
1.112     weinem   1886:       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.128     wiz      1887:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1888:       argument to check if your packages are up-to-date, e.g.
                   1889:     </p>
                   1890: <pre class="screen">
                   1891: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1892: ...
1.88      wiz      1893: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1894:     </pre>
1.110     hubertf  1895: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1896:     package on your system and rebuild any dependencies.
                   1897:     </p>
1.82      rillig   1898: </div>
1.148     asau     1899: <div class="sect2">
1.82      rillig   1900: <div class="titlepage"><div><div><h3 class="title">
                   1901: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1902: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1903:     administrative functions on the package system.</p>
1.82      rillig   1904: </div>
1.148     asau     1905: <div class="sect2">
1.82      rillig   1906: <div class="titlepage"><div><div><h3 class="title">
                   1907: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1908: <p>Please pay very careful attention to the warnings
1.136     dholland 1909:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1910:     inherent dangers of installing binary packages which you did
                   1911:     not create yourself, and the security holes that can be
                   1912:     introduced onto your system by indiscriminate adding of such
                   1913:     files.</p>
1.75      rillig   1914: <p>The same warning of course applies to every package you
1.88      wiz      1915:     install from source when you haven't completely read and
                   1916:     understood the source code of the package, the compiler that
                   1917:     is used to build the package and all the other tools that are
                   1918:     involved.</p>
1.75      rillig   1919: </div>
                   1920: </div>
1.148     asau     1921: <div class="sect1">
1.75      rillig   1922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1923: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1924: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1925:   directory now contains a set of packages, organized into
                   1926:   categories. You can browse the online index of packages, or run
1.110     hubertf  1927:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1928:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1929:   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      1930: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1931:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1932:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1933:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1934:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1935:   system (inside a chroot is an exception). </p>
                   1936: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1937:   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      1938:   instructions how to create your own packages.</p>
1.148     asau     1939: <div class="sect2">
1.75      rillig   1940: <div class="titlepage"><div><div><h3 class="title">
                   1941: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1942: <p>To build packages from source, you need a working C
1.88      wiz      1943:     compiler. On NetBSD, you need to install the
1.128     wiz      1944:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1945:     sets. If you want to build X11-related packages, the
1.128     wiz      1946:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1947:     sets are required, too.</p>
1.75      rillig   1948: </div>
1.148     asau     1949: <div class="sect2">
1.75      rillig   1950: <div class="titlepage"><div><div><h3 class="title">
                   1951: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1952: <p>The first step for building a package is downloading the
1.88      wiz      1953:     distfiles (i.e. the unmodified source). If they have not yet been
                   1954:     downloaded, pkgsrc will fetch them automatically.</p>
                   1955: <p>If you have all files that you need in the
                   1956:     <code class="filename">distfiles</code> directory,
                   1957:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1958:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1959:     </p>
1.82      rillig   1960: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1961: <p>
1.110     hubertf  1962:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1963: <p>By default a list of distribution sites will be randomly
                   1964:     intermixed to prevent huge load on servers which holding popular
                   1965:     packages (for example, SourceForge.net mirrors). Thus, every
                   1966:     time when you need to fetch yet another distfile all the mirrors
                   1967:     will be tried in new (random) order. You can turn this feature
                   1968:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1969:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1970: <p>You can overwrite some of the major distribution sites to
                   1971:     fit to sites that are close to your own.  By setting one or two
                   1972:     variables you can modify the order in which the master sites are
                   1973:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1974:     delimited list of domain suffixes.
                   1975:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1976:     contains a whitespace delimited list of regular expressions.  It
                   1977:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1978:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1979:     some examples.  This may save some of your bandwidth and
                   1980:     time.</p>
1.75      rillig   1981: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1982:     if you want to keep the settings, by editing the
1.110     hubertf  1983:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1984:     and adding the definitions there.</p>
1.82      rillig   1985: <p>
1.88      wiz      1986:       If a package depends on many other packages (such as
1.93      rillig   1987:       <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      1988:       alternate between periods of
                   1989:       downloading source, and compiling. To ensure you have all the source
                   1990:       downloaded initially you can run the command:
                   1991:       </p>
1.82      rillig   1992: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1993: <p>
1.88      wiz      1994:       which will output and run a set of shell commands to fetch the
                   1995:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1996:       also choose to download the files manually.
                   1997:     </p>
1.75      rillig   1998: </div>
1.148     asau     1999: <div class="sect2">
1.75      rillig   2000: <div class="titlepage"><div><div><h3 class="title">
                   2001: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   2002: <p>
1.88      wiz      2003:       Once the software has downloaded, any patches will be applied, then it
                   2004:       will be compiled for you. This may take some time depending on your
                   2005:       computer, and how many other packages the software depends on and their
                   2006:       compile time.
                   2007:     </p>
1.148     asau     2008: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   2009: <h3 class="title">Note</h3>
                   2010: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  2011:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      2012:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   2013: </div>
1.87      wiz      2014: <p>For example, type</p>
1.88      wiz      2015: <pre class="screen">
                   2016: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2017: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2018:     </pre>
1.75      rillig   2019: <p>at the shell prompt to build the various components of the
1.88      wiz      2020:     package.</p>
1.82      rillig   2021: <p>The next stage is to actually install the newly compiled
1.88      wiz      2022:     program onto your system. Do this by entering:
1.82      rillig   2023: 
1.88      wiz      2024:     </p>
1.82      rillig   2025: <pre class="screen">
1.88      wiz      2026: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2027:     </pre>
1.82      rillig   2028: <p>
                   2029: 
1.88      wiz      2030:     while you are still in the directory for whatever package you
                   2031:     are installing.</p>
1.82      rillig   2032: <p>Installing the package on your system may require you to
1.88      wiz      2033:     be root.  However, pkgsrc has a
                   2034:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2035:     to only become root for the actual installation step.</p>
1.82      rillig   2036: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2037:     You can now enter:
1.82      rillig   2038: 
1.88      wiz      2039:     </p>
1.82      rillig   2040: <pre class="screen">
1.88      wiz      2041: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2042:     </pre>
1.82      rillig   2043: <p>
                   2044: 
1.88      wiz      2045:     to remove the compiled files in the work directory, as you shouldn't need
                   2046:     them any more. If other packages were also added to your system
                   2047:     (dependencies) to allow your program to compile, you can tidy these up
                   2048:     also with the command:</p>
1.82      rillig   2049: <pre class="screen">
1.88      wiz      2050: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2051:     </pre>
1.75      rillig   2052: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2053:     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      2054: <p>The program is installed under the default root of the
                   2055:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2056:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2057:     variable in your environment, and it will use that value as the
                   2058:     root of your packages tree. So, to use
                   2059:     <code class="filename">/usr/local</code>, set
                   2060:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2061:     Please note that you should use a directory which is dedicated to
                   2062:     packages and not shared with other programs (i.e., do not try and
                   2063:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2064:     to add any of your own files or directories (such as
                   2065:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2066:     <code class="filename">pkgsrc/</code>) below the
                   2067:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2068:     conflicts between programs and other files installed by the
                   2069:     package system and whatever else may have been installed
                   2070:     there.</p>
1.110     hubertf  2071: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2072:     alter some configuration options at build time.  Have a look at
                   2073:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2074:     of what will be set there by default.  Environment variables such
                   2075:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2076:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2077:     set them each time you want to use pkgsrc.</p>
1.128     wiz      2078: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   2079:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      2080:     or being installed. This may be for debugging purposes, or out of
                   2081:     simple curiosity. A number of utility values have been added to
                   2082:     help with this.</p>
1.128     wiz      2083: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2084: <li class="listitem">
1.136     dholland 2085: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2086:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2087:        information will be displayed. For example,</p>
1.75      rillig   2088: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2089: <p>will show all the commands that are invoked, up to and
1.128     wiz      2090:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   2091: </li>
1.128     wiz      2092: <li class="listitem">
1.136     dholland 2093: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2094:        definition, then the <code class="varname">VARNAME</code> definition
                   2095:        should be used, in conjunction with the show-var
1.136     dholland 2096:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2097:        variable <code class="varname">LOCALBASE</code>:</p>
                   2098: <pre class="screen">
                   2099: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2100: /usr/pkg
                   2101: <code class="prompt">%</code>
1.88      wiz      2102:        </pre>
1.75      rillig   2103: </li>
                   2104: </ol></div>
                   2105: <p>If you want to install a binary package that you've either
1.88      wiz      2106:     created yourself (see next section), that you put into
                   2107:     pkgsrc/packages manually or that is located on a remote FTP
                   2108:     server, you can use the "bin-install" target. This target will
1.136     dholland 2109:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  2110:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2111:     sites searched is kept in the variable
                   2112:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.136     dholland 2113:     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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2114:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2115:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2116:     details.</p>
                   2117: <p>A final word of warning: If you set up a system that has a
                   2118:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2119:     set that before any packages are installed, as you cannot use
                   2120:     several directories for the same purpose. Doing so will result in
                   2121:     pkgsrc not being able to properly detect your installed packages,
                   2122:     and fail miserably. Note also that precompiled binary packages are
                   2123:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2124:     <code class="filename">/usr/pkg</code>, and that you should
                   2125:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2126:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2127: </div>
                   2128: </div>
                   2129: </div>
1.148     asau     2130: <div class="chapter">
1.75      rillig   2131: <div class="titlepage"><div><div><h2 class="title">
                   2132: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2133: <div class="toc">
                   2134: <p><b>Table of Contents</b></p>
                   2135: <dl>
                   2136: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2137: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2138: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2139: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2140: <dd><dl>
1.103     wiz      2141: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      2142: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2143: <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      2144: </dl></dd>
1.103     wiz      2145: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2146: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2147: </dl>
                   2148: </div>
1.104     rillig   2149: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2150: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2151: that file depends on the installation. On NetBSD, when you use
1.136     dholland 2152: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2153: <code class="filename">/etc/</code>. In all other cases the default location is
                   2154: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2155: bootstrap program to install the binary packages.</p>
                   2156: <p>During the bootstrap, an example configuration file is created. To
                   2157: use that, you have to create the directory
                   2158: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2159: there.</p>
                   2160: <p>The format of the configuration file is that of the usual
                   2161: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2162: is done by setting variables in this file. Note that you can define all
                   2163: kinds of variables, and no special error checking (for example for
                   2164: spelling mistakes) takes place, so you have to try it out to see if it
                   2165: works.</p>
1.148     asau     2166: <div class="sect1">
1.75      rillig   2167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2168: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2169: <p>In this section, you can find some variables that apply to all
1.89      rillig   2170:     pkgsrc packages. A complete list of the variables that can be
                   2171:     configured by the user is available in
                   2172:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2173:     comments that describe each variable's intent.</p>
1.148     asau     2174: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2175: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   2176:            packages will be installed. The default is
1.76      rillig   2177:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2178:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      2179: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2180:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   2181:            installed. The default is
1.76      rillig   2182:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      2183: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   2184:            X11 is installed on the system. The default is
1.76      rillig   2185:            <code class="filename">/usr/X11R6</code>.</p></li>
1.128     wiz      2186: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   2187:            downloaded copies of the original source distributions used
                   2188:            for building pkgsrc packages. The default is
1.76      rillig   2189:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      2190: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   2191:            database about installed packages is stored.  The default is
                   2192:            <code class="filename">/var/db/pkg</code>.</p></li>
1.128     wiz      2193: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   2194:            If set, override the packages'
                   2195:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      2196: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   2197:            Backup location(s) for distribution files and patch files
                   2198:            if not found locally or in
1.76      rillig   2199:            <code class="filename">${MASTER_SITES}</code> or
                   2200:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2201:            The defaults are
1.132     spz      2202:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2203:            and
1.76      rillig   2204:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      2205: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2206:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2207:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      2208:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2209:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2210: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      2211:            List of acceptable licenses. License names are case-sensitive.
                   2212:            Whenever you try to build a package whose license is not in this
                   2213:            list, you will get an error message. If the license condition is
                   2214:            simple enough, the error message will include specific
                   2215:            instructions on how to change this variable.</p></li>
1.75      rillig   2216: </ul></div>
                   2217: </div>
1.148     asau     2218: <div class="sect1">
1.75      rillig   2219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2220: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2221: <p>XXX
                   2222:       </p>
1.148     asau     2223: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2224: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   2225:            directory for the binary packages. The default is
1.76      rillig   2226:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      2227: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   2228:            The top level directory where, if defined, the separate
                   2229:            working directories will get created, and symbolically
1.76      rillig   2230:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2231:            This is useful for building packages on several
1.76      rillig   2232:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2233:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2234:            is local to every architecture. (It should be noted that
                   2235:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 2236:            &mdash; it is an internal definition which refers to the
1.75      rillig   2237:            root of the pkgsrc tree. It is possible to have many
                   2238:            pkgsrc tree instances.)</p></li>
1.128     wiz      2239: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   2240:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2241:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2242:            information.</p></li>
1.128     wiz      2243: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2244:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2245:            BSD-style Makefile. If this is not set,
                   2246:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2247:            <code class="filename">/dev/null</code> to avoid picking up
                   2248:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128     wiz      2249: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82      rillig   2250:            By default, dependencies are only installed, and no binary
                   2251:            package is created for them. You can set this variable to
                   2252:            <code class="literal">package</code> to automatically create binary
                   2253:            packages after installing dependencies.</p></li>
1.75      rillig   2254: </ul></div>
                   2255: </div>
1.148     asau     2256: <div class="sect1">
1.75      rillig   2257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2258: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.131     wiz      2259: <p>Most packages support installation into a
1.103     wiz      2260:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2261:     to be built, before the actual filesystem is touched. DESTDIR
                   2262:     support exists in two variations:</p>
1.148     asau     2263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2264: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      2265:       installation and packaging is still run as root.</p></li>
                   2266: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2267:       build, installation and packaging as normal user. Root
                   2268:       privileges are only needed to add packages.</p></li>
                   2269: </ul></div>
                   2270: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                   2271:     you can set
                   2272:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                   2273:     so it's preferable to convert a package to DESTDIR instead.</p>
1.103     wiz      2274: <p>DESTDIR support changes the behaviour of various targets
                   2275:     slightly. To install a package after building it, use
                   2276:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2277:     <code class="literal">install</code> don't do that any
                   2278:     longer. <code class="literal">package-install</code> can be used as
                   2279:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2280:     will ask for the root password to install the package and fail,
                   2281:     <code class="literal">package-install</code> will ask again.</p>
                   2282: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2283:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2284: <p>Considering the <code class="filename">foo/bar</code> package,
                   2285:     DESTDIR full support can be tested using the following commands
                   2286: 
                   2287: </p>
                   2288: <pre class="programlisting">
                   2289: <code class="prompt">$</code> id
                   2290: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2291: <code class="prompt">$</code> mkdir $HOME/packages
                   2292: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2293: </pre>
                   2294: <p>
                   2295: 
                   2296:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2297:     should be needed
                   2298: 
                   2299: </p>
                   2300: <pre class="programlisting">
1.123     snj      2301: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118     imil     2302: </pre>
                   2303: <p>
                   2304: 
                   2305:     Create a package without root privileges
                   2306: 
                   2307: </p>
                   2308: <pre class="programlisting">
1.123     snj      2309: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118     imil     2310: </pre>
                   2311: <p>
                   2312: 
                   2313:     For the following command, you must be able to gain root
1.136     dholland 2314:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     2315: 
                   2316: </p>
                   2317: <pre class="programlisting">
1.123     snj      2318: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118     imil     2319: </pre>
                   2320: <p>
                   2321: 
                   2322:     Then, as a simple user
                   2323: 
                   2324: </p>
                   2325: <pre class="programlisting">
                   2326: <code class="prompt">$</code> make clean
                   2327: </pre>
                   2328: <p>
                   2329: 
                   2330:     </p>
1.103     wiz      2331: </div>
1.148     asau     2332: <div class="sect1">
1.103     wiz      2333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2334: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     2335: <div class="sect2">
1.78      rillig   2336: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2337: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2338: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2339:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     2340: <div class="variablelist"><dl class="variablelist">
1.89      rillig   2341: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2342: <dd>
                   2343: <p>This is a list of values specifying the chain of
                   2344:          compilers to invoke when building packages.  Valid values
                   2345:          are:</p>
1.148     asau     2346: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2347: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   2348:            distributed C/C++ (chainable)</p></li>
1.128     wiz      2349: <li class="listitem"><p><code class="varname">ccache</code>:
1.89      rillig   2350:            compiler cache (chainable)</p></li>
1.128     wiz      2351: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   2352:            GNU C/C++ Compiler</p></li>
1.128     wiz      2353: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   2354:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.128     wiz      2355: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   2356:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      2357: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   2358:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2359: </ul></div>
                   2360: <p>The default is
1.128     wiz      2361:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   2362:          <code class="varname">ccache</code> and/or
                   2363:          <code class="varname">distcc</code> with an appropriate
                   2364:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      2365:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 2366:          variable should always be terminated with a value for
                   2367:          a real compiler.  Note that only one real compiler
1.128     wiz      2368:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 2369:          is not allowed).</p>
1.89      rillig   2370: </dd>
                   2371: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2372: <dd><p>This specifies the minimum version of GCC to use
                   2373:          when building packages.  If the system GCC doesn't
                   2374:          satisfy this requirement, then pkgsrc will build and
                   2375:          install one of the GCC packages to use instead.</p></dd>
                   2376: </dl></div>
                   2377: </div>
1.148     asau     2378: <div class="sect2">
1.89      rillig   2379: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2380: <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   2381: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2382:        please make sure to use the <code class="literal">+=</code> operator
                   2383:        instead of the <code class="literal">=</code> operator:</p>
                   2384: <pre class="programlisting">
1.100     rillig   2385: CFLAGS+=        -your -flags
1.78      rillig   2386: </pre>
                   2387: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      2388:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  2389:        need to add their own flags.  You may want to take a look
                   2390:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      2391:        package if you're interested in optimization specifically
                   2392:        for the current CPU. </p>
1.78      rillig   2393: </div>
1.148     asau     2394: <div class="sect2">
1.88      wiz      2395: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2396: <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      2397: <p>If you want to pass flags to the linker, both in the configure
                   2398: step and the build step, you can do this in two ways.  Either set
                   2399: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2400: between the two is that <code class="varname">LIBS</code> will be appended to
                   2401: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2402: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2403: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2404: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2405: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2406: settings, use the <code class="literal">+=</code> operator:</p>
                   2407: <pre class="programlisting">
1.100     rillig   2408: LDFLAGS+=        -your -linkerflags
1.88      wiz      2409: </pre>
                   2410: </div>
1.78      rillig   2411: </div>
1.148     asau     2412: <div class="sect1">
1.78      rillig   2413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2414: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2415: <p>XXX
                   2416:       </p>
1.148     asau     2417: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2418: <li class="listitem">
1.75      rillig   2419: <p><code class="varname">PKG_DEVELOPER</code>:
                   2420:            Run some sanity checks that package developers want:
                   2421:            </p>
1.148     asau     2422: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2423: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      2424:              fuzz</p></li>
1.128     wiz      2425: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      2426:              binaries will find their shared libs.</p></li>
1.75      rillig   2427: </ul></div>
                   2428: <p>
1.87      wiz      2429:        </p>
1.75      rillig   2430: </li>
1.128     wiz      2431: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      2432:        of debugging output which is displayed whilst making and
                   2433:        installing the package.  The default value for this is 0,
                   2434:        which will not display the commands as they are executed
                   2435:        (normal, default, quiet operation); the value 1 will display
                   2436:        all shell commands before their invocation, and the value 2
                   2437:        will display both the shell commands before their invocation,
1.110     hubertf  2438:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2439:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2440: </ul></div>
                   2441: <p>
                   2442:     </p>
                   2443: </div>
1.148     asau     2444: <div class="sect1">
1.75      rillig   2445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2446: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2447: <p>Some packages have build time options, usually to select
                   2448:     between different dependencies, enable optional support for big
                   2449:     dependencies or enable experimental features.</p>
1.75      rillig   2450: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2451:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2452:     show-options</strong></span>, for example:</p>
1.75      rillig   2453: <pre class="programlisting">
                   2454:     The following options are supported by this package:
                   2455:         ssl      Enable SSL support.
                   2456:     Exactly one of the following gecko options is required:
                   2457:         firefox  Use firefox as gecko rendering engine.
                   2458:         mozilla  Use mozilla as gecko rendering engine.
                   2459:     At most one of the following database options may be selected:
                   2460:         mysql    Enable support for MySQL database.
                   2461:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2462: 
1.75      rillig   2463:     These options are enabled by default: firefox
                   2464:     These options are currently enabled: mozilla ssl
1.1       grant    2465: </pre>
1.75      rillig   2466: <p>The following variables can be defined in
1.110     hubertf  2467:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2468:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2469:     which can be used to select or disable options for all packages
                   2470:     that support them, and
                   2471:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2472:     which can be used to select or disable options specifically for
                   2473:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2474:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2475:     are disabled. A few examples:</p>
1.75      rillig   2476: <pre class="screen">
1.110     hubertf  2477: <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   2478: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2479: PKG_OPTIONS.kdebase=    debug -sasl
                   2480: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2481: <p>It is important to note that options that were specifically
1.120     snj      2482:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2483:     you do not wish to include the option.  If you are unsure you can view
                   2484:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2485: <p>The following settings are consulted in the order given, and
                   2486:     the last setting that selects or disables an option is
                   2487:     used:</p>
1.128     wiz      2488: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2489: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2490:       maintainer</p></li>
1.128     wiz      2491: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2492:       variables (see below)</p></li>
1.128     wiz      2493: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2494: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2495: </ol></div>
                   2496: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2497:     selected is used, all others are automatically disabled.  If an
                   2498:     option of the group is explicitly disabled, the previously
                   2499:     selected option, if any, is used.  It is an error if no option
                   2500:     from a required group of options is selected, and building the
                   2501:     package will fail.</p>
                   2502: <p>Before the options framework was introduced, build options
                   2503:     were selected by setting a variable (often named
                   2504:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2505:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2506:     transition to the options framework for the user, these legacy
                   2507:     variables are converted to the appropriate options setting
                   2508:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2509:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2510:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2511:     directly.  Support for the legacy variables will be removed
                   2512:     eventually.</p>
1.75      rillig   2513: </div>
                   2514: </div>
1.148     asau     2515: <div class="chapter">
1.75      rillig   2516: <div class="titlepage"><div><div><h2 class="title">
                   2517: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2518: <div class="toc">
                   2519: <p><b>Table of Contents</b></p>
                   2520: <dl>
                   2521: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2522: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2523: </dl>
                   2524: </div>
1.148     asau     2525: <div class="sect1">
1.75      rillig   2526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2527: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2528: <p>Once you have built and installed a package, you can create
                   2529:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.136     dholland 2530:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2531:     the same package on a group of hosts and wasting CPU time. It also
                   2532:     provides a simple means for others to install your package, should
                   2533:     you distribute it.</p>
                   2534: <p>To create a binary package, change into the appropriate
1.110     hubertf  2535:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2536:     package</strong></span>:</p>
                   2537: <pre class="screen">
                   2538: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2539: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2540:     </pre>
                   2541: <p>This will build and install your package (if not already done),
                   2542:     and then build a binary package from what was installed. You can
1.110     hubertf  2543:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2544:     it. Binary packages are created by default in
                   2545:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2546:     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   2547:     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  2548: <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      2549:     such a binary package.</p>
1.75      rillig   2550: </div>
1.148     asau     2551: <div class="sect1">
1.75      rillig   2552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2553: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2554: <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   2555: </div>
                   2556: </div>
1.148     asau     2557: <div class="chapter">
1.106     rillig   2558: <div class="titlepage"><div><div><h2 class="title">
                   2559: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2560: builds)</h2></div></div></div>
                   2561: <div class="toc">
                   2562: <p><b>Table of Contents</b></p>
                   2563: <dl>
                   2564: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2565: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2566: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2567: <dd><dl>
                   2568: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2569: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2570: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2571: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2572: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2573: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2574: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2575: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2576: </dl></dd>
                   2577: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig   2578: <dd><dl>
                   2579: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2580: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2581: </dl></dd>
1.106     rillig   2582: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2583: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2584: </dl>
                   2585: </div>
                   2586: <p>When you have multiple machines that should run the same packages,
                   2587: it is wasted time if they all build their packages themselves from
                   2588: source. There are two ways of getting a set of binary packages: The old
                   2589: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2590: system. This chapter describes how to set them up so that the packages
                   2591: are most likely to be usable later.</p>
1.148     asau     2592: <div class="sect1">
1.106     rillig   2593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2594: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2595: <p>Since a bulk build takes several days or even weeks to finish, you
                   2596: should think about the setup before you start everything. Pay attention
                   2597: to at least the following points:</p>
1.148     asau     2598: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2599: <li class="listitem">
1.106     rillig   2600: <p>If you want to upload the binary packages to
                   2601: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2602: packages:</p>
1.148     asau     2603: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2604: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.106     rillig   2605: by a NetBSD developer on a trusted machine (that is, where you and only
                   2606: you have root access).</p></li>
1.128     wiz      2607: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.124     snj      2608: the stable branches (like 2009Q1), so that users browsing the available
1.106     rillig   2609: collections can see at a glance how old the packages
                   2610: are.</p></li>
1.128     wiz      2611: <li class="listitem"><p>The packages must be built as root, since some packages
1.106     rillig   2612: require set-uid binaries at runtime, and creating those packages as
                   2613: unprivileged user doesn't work well at the moment.</p></li>
                   2614: </ul></div>
                   2615: </li>
1.128     wiz      2616: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.106     rillig   2617: your system. Most bulk builds run as root, so they should be run at least
                   2618: in a chroot environment or something even more restrictive, depending on
                   2619: what the operating system provides. There have been numerous cases where
                   2620: certain packages tried to install files outside the
                   2621: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2622: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2623: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2624: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2625: that you don't need any package during the build.</p></li>
                   2626: </ul></div>
                   2627: </div>
1.148     asau     2628: <div class="sect1">
1.106     rillig   2629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2630: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2631: <p>A complete bulk build requires lots of disk space. Some of the
                   2632: disk space can be read-only, some other must be writable. Some can be on
                   2633: remote filesystems (such as NFS) and some should be local. Some can be
                   2634: temporary filesystems, others must survive a sudden reboot.</p>
1.148     asau     2635: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     jnemeth  2636: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2637: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2638: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
1.128     wiz      2639: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
1.169     jnemeth  2640: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
1.128     wiz      2641: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.106     rillig   2642: </ul></div>
1.75      rillig   2643: </div>
1.148     asau     2644: <div class="sect1">
1.75      rillig   2645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2646: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.148     asau     2647: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.116     rillig   2648: <h3 class="title">Note</h3>
                   2649: <p>There are two ways of doing a bulk build. The old-style
1.128     wiz      2650: one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
1.116     rillig   2651: way.</p>
1.106     rillig   2652: </div>
1.148     asau     2653: <div class="sect2">
1.75      rillig   2654: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2655: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.148     asau     2656: <div class="sect3">
1.75      rillig   2657: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2658: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2659: </h4></div></div></div>
1.76      rillig   2660: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2661:        configuration file for bulk builds. You can configure how your
                   2662:        copy of pkgsrc is kept up to date, how the distfiles are
                   2663:        downloaded, how the packages are built and how the report is
                   2664:        generated. You can find an annotated example file in
                   2665:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2666:        it, copy <code class="filename">build.conf-example</code> to
                   2667:        <code class="filename">build.conf</code> and edit it, following the
                   2668:        comments in that file.</p>
1.75      rillig   2669: </div>
1.148     asau     2670: <div class="sect3">
1.75      rillig   2671: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2672: <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   2673: </h4></div></div></div>
1.110     hubertf  2674: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2675:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2676:        details of the default settings. You will want to ensure that
                   2677:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125     wiz      2678:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104     rillig   2679:        completely bypasses the license check.</p>
1.87      wiz      2680: <pre class="programlisting">
1.100     rillig   2681: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2682: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2683: BSDSRCDIR=      /usr/src
                   2684: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2685: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2686: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2687: PKG_DEVELOPER?= yes
1.125     wiz      2688: SKIP_LICENSE_CHECK=    yes
1.100     rillig   2689: </pre>
1.75      rillig   2690: <p>Some options that are especially useful for bulk builds
                   2691:        can be found at the top lines of the file
1.76      rillig   2692:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2693:        options of these are briefly described here.</p>
1.148     asau     2694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2695: <li class="listitem"><p>If you are on a slow machine, you may want to
1.87      wiz      2696:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.128     wiz      2697:          <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
                   2698: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.87      wiz      2699:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2700:          to the directory where all log files are created. Otherwise the
                   2701:          log files are created in the pkgsrc directory.</p></li>
1.128     wiz      2702: <li class="listitem"><p>Another important variable is
1.87      wiz      2703:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2704:          should be always available while building other
                   2705:          packages.</p></li>
1.75      rillig   2706: </ul></div>
                   2707: <p>Some other options are scattered in the pkgsrc
                   2708:        infrastructure:</p>
1.148     asau     2709: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2710: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2711:          should be set to <code class="literal">yes</code>. The purpose of the
                   2712:          bulk builds is creating binary packages, no matter if they
                   2713:          are vulnerable or not. Leaving this variable unset would
                   2714:          prevent the bulk build system from even trying to build
                   2715:          them, so possible building errors would not show
                   2716:          up.</p></li>
                   2717: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2718:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.128     wiz      2719:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
1.87      wiz      2720:          matches the <code class="filename">PLIST</code>.</p></li>
1.128     wiz      2721: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2722:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.128     wiz      2723:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
                   2724:          <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
1.87      wiz      2725:          interpreter.</p></li>
1.128     wiz      2726: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2727:          set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
1.91      rillig   2728:          package's self-test before installing it. Note that some
1.128     wiz      2729:          packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
1.91      rillig   2730:          numbers, so you need to assure that the machine on which you
                   2731:          are doing the bulk builds is not completely idle. Otherwise
                   2732:          some test programs will seem to hang, while they are just
                   2733:          waiting for new random data to be
                   2734:          available.</p></li>
1.75      rillig   2735: </ul></div>
                   2736: </div>
1.148     asau     2737: <div class="sect3">
1.75      rillig   2738: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2739: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2740: </h4></div></div></div>
1.75      rillig   2741: <p>It is possible to configure the bulk build to perform
1.87      wiz      2742:        certain site-specific tasks at the end of the pre-build
                   2743:        stage.  If the file
                   2744:        <code class="filename">pre-build.local</code> exists in
                   2745:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.136     dholland 2746:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87      wiz      2747:        stage.  An example use of
                   2748:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2749: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2750:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2751: <p>to prevent the system from trying to build a particular package
1.87      wiz      2752:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2753: </div>
                   2754: </div>
1.148     asau     2755: <div class="sect2">
1.75      rillig   2756: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2757: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2758: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2759:       deleted at the start of bulk builds, make sure your login
                   2760:       shell is placed somewhere else. Either drop it into
                   2761:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2762:       shell in the passwd file), or (re-)install it via
1.136     dholland 2763:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87      wiz      2764:       you can login after a reboot (remember that your current
                   2765:       process won't die if the package is removed, you just can't
                   2766:       start any new instances of the shell any more).  Also, if you
                   2767:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2768:       version of ssh for some reason, be sure to install ssh before
                   2769:       starting it from <code class="filename">rc.local</code>:</p>
                   2770: <pre class="programlisting">
1.100     rillig   2771: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2772: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2773:   /usr/pkg/etc/rc.d/sshd
                   2774: fi
                   2775: </pre>
1.75      rillig   2776: <p>Not doing so will result in you being not able to log in
1.87      wiz      2777:       via ssh after the bulk build is finished or if the machine
                   2778:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2779: </div>
1.148     asau     2780: <div class="sect2">
1.75      rillig   2781: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2782: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2783: <p>Make sure you don't need any of the packages still
1.87      wiz      2784:       installed.</p>
1.148     asau     2785: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   2786: <h3 class="title">Warning</h3>
1.99      rillig   2787: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2788:        configuration files and some more files from
                   2789:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2790:        possibly other locations will be removed! So don't run a bulk
                   2791:        build with privileges that might harm your
                   2792:        system.</em></span></p>
1.75      rillig   2793: </div>
                   2794: <p>Be sure to remove all other things that might
1.87      wiz      2795:       interfere with builds, like some libs installed in
                   2796:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2797: <pre class="screen">
                   2798: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2799: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2800:       </pre>
1.75      rillig   2801: <p>If for some reason your last build didn't complete (power
1.87      wiz      2802:       failure, system panic, ...), you can continue it by
                   2803:       running:</p>
1.75      rillig   2804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2805: <p>At the end of the bulk build, you will get a summary via mail,
                   2806:       and find build logs in the directory specified by
                   2807:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2808:       file.</p>
1.75      rillig   2809: </div>
1.148     asau     2810: <div class="sect2">
1.75      rillig   2811: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2812: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2813: <p>The bulk builds consist of three steps:</p>
1.148     asau     2814: <div class="variablelist"><dl class="variablelist">
1.75      rillig   2815: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2816: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2817:            cleans out any broken distfiles, and removes all
                   2818:            packages installed.</p></dd>
1.75      rillig   2819: <dt><span class="term">2. the bulk build</span></dt>
1.128     wiz      2820: <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
1.87      wiz      2821:            an optimised order in which packages will be
                   2822:            built. Packages that don't require other packages will
                   2823:            be built first, and packages with many dependencies will
                   2824:            be built later.</p></dd>
1.75      rillig   2825: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2826: <dd><p>Generates a report that's placed in the directory
                   2827:            specified in the <code class="filename">build.conf</code> file
                   2828:            named <code class="filename">broken.html</code>, a short version
                   2829:            of that report will also be mailed to the build's
                   2830:            admin.</p></dd>
1.75      rillig   2831: </dl></div>
1.87      wiz      2832: <p>During the build, a list of broken packages will be compiled
                   2833:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2834:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2835:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2836:       of broken builds can be found in the package's
                   2837:       directory. These files are used by the bulk-targets to mark
                   2838:       broken builds to not waste time trying to rebuild them, and
                   2839:       they can be used to debug these broken package builds
                   2840:       later.</p>
1.75      rillig   2841: </div>
1.148     asau     2842: <div class="sect2">
1.75      rillig   2843: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2844: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2845: <p>Currently, roughly the following requirements are valid for
1.169     jnemeth  2846:       NetBSD 6.99/amd64:</p>
1.148     asau     2847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     jnemeth  2848: <li class="listitem"><p>40 GB - distfiles (NFS ok)</p></li>
                   2849: <li class="listitem"><p>30 GB - full set of all binaries (NFS ok)</p></li>
1.128     wiz      2850: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.87      wiz      2851: </ul></div>
                   2852: <p>Note that all pkgs will be de-installed as soon as they are
                   2853:       turned into a binary package, and that sources are removed,
                   2854:       so there is no excessively huge demand to disk
                   2855:       space. Afterwards, if the package is needed again, it will
1.136     dholland 2856:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87      wiz      2857:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2858: </div>
1.148     asau     2859: <div class="sect2">
1.75      rillig   2860: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2861: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2862: <p>If you don't want all the packages nuked from a machine
                   2863:       (rendering it useless for anything but pkg compiling), there
                   2864:       is the possibility of doing the package bulk build inside a
                   2865:       chroot environment.</p>
                   2866: <p>The first step is to set up a chroot sandbox,
                   2867:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2868:       using null mounts, or manually.</p>
                   2869: <p>There is a shell script called
1.143     wiz      2870:       <code class="filename">mksandbox</code> installed by the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mksandbox/README.html" target="_top"><code class="filename">pkgtools/mksandbox</code></a> package, which will set
1.87      wiz      2871:       up the sandbox environment using null mounts. It will also
                   2872:       create a script called <code class="filename">sandbox</code> in the
                   2873:       root of the sandbox environment, which will allow the null
1.110     hubertf  2874:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2875:       mount</strong></span> command and deactivated using the
1.110     hubertf  2876:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2877: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2878:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2879:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2880:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2881:       are present and properly configured:</p>
1.128     wiz      2882: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2883: <li class="step">
1.75      rillig   2884: <p>Kernel</p>
                   2885: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2886: </li>
1.148     asau     2887: <li class="step">
1.76      rillig   2888: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2890: </li>
1.148     asau     2891: <li class="step">
1.91      rillig   2892: <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   2893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2894: </li>
1.148     asau     2895: <li class="step">
1.75      rillig   2896: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2897: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2898: </li>
1.148     asau     2899: <li class="step">
1.91      rillig   2900: <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   2901: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2902: </li>
1.148     asau     2903: <li class="step">
1.76      rillig   2904: <p><code class="filename">/usr/src</code> (system sources,
1.168     wiz      2905:           rarely used by packages if at all:</p>
1.75      rillig   2906: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2907:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2908: </li>
1.148     asau     2909: <li class="step">
1.76      rillig   2910: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2911: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2912: </li>
1.148     asau     2913: <li class="step">
1.76      rillig   2914: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2915: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2916: </li>
1.148     asau     2917: <li class="step">
1.75      rillig   2918: <p>Checkout pkgsrc via cvs into
1.87      wiz      2919:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2920: <pre class="screen">
                   2921: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2922: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2923:          </pre>
1.75      rillig   2924: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2925:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2926: </li>
1.148     asau     2927: <li class="step"><p>Make
1.87      wiz      2928:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2929:          <code class="filename">.../distfiles</code> point somewhere
                   2930:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.148     asau     2931: <li class="step"><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>
                   2932: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2933: </ol></div>
                   2934: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2935:       the build with the following steps:</p>
                   2936: <pre class="screen">
                   2937: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2938: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2939:       </pre>
                   2940: <p>This will just jump inside the sandbox and start building.  At
                   2941:        the end of the build, mail will be sent with the results of
                   2942:        the build. Created binary pkgs will be in
                   2943:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2944:       (wherever that points/mounts to/from).</p>
1.75      rillig   2945: </div>
1.148     asau     2946: <div class="sect2">
1.75      rillig   2947: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2948: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2949: <p>In addition to building a complete set of all packages in
                   2950:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2951:       may be used to build a subset of the packages contained in
                   2952:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2953:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.148     asau     2954: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2955: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
                   2956: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
                   2957: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
                   2958: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.75      rillig   2959: </ul></div>
1.87      wiz      2960: <p>will define the set of packages which should be built.
                   2961:       The bulk build code will also include any packages which are
                   2962:       needed as dependencies for the explicitly listed packages.</p>
                   2963: <p>One use of this is to do a bulk build with
                   2964:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2965:       periodically to have a complete set of the binary packages
                   2966:       needed for your site available without the overhead of
                   2967:       building extra packages that are not needed.</p>
1.75      rillig   2968: </div>
1.148     asau     2969: <div class="sect2">
1.75      rillig   2970: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2971: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2972: <p>This section describes how pkgsrc developers can upload binary
                   2973:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2974: <p>If you would like to automatically create checksum files for the
                   2975:       binary packages you intend to upload, remember to set
                   2976:       <code class="varname">MKSUMS=yes</code> in your
                   2977:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2978: <p>If you would like to PGP sign the checksum files (highly
                   2979:       recommended!), remember to set
                   2980:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2981:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2982:       your GPG password to sign the files before uploading everything.</p>
                   2983: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2984:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2985:       file, i.e. adjust it to something like one of the following:</p>
1.132     spz      2986: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
                   2987: <p>Please use appropriate values for "20xxQy" (the branch),
                   2988:       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.87      wiz      2989:       is different from your local login, write your login directly
                   2990:       into the variable, e.g. my local account is "feyrer", but for my
                   2991:       login "hubertf", I use:</p>
1.132     spz      2992: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.87      wiz      2993: <p>A separate <code class="filename">upload</code> directory is used
                   2994:       here to allow "closing" the directory during upload. To do
                   2995:       so, run the following command on ftp.NetBSD.org next:</p>
1.132     spz      2996: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</code></strong></pre>
1.87      wiz      2997: <p>Before uploading the binary pkgs, ssh authentication needs
                   2998:       to be set up. This example shows how to set up temporary keys
                   2999:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   3000:       (assuming that no keys should be present there usually):</p>
                   3001: <pre class="screen">
                   3002: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   3003: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.132     spz      3004: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
                   3005: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.87      wiz      3006:       </pre>
1.132     spz      3007: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.87      wiz      3008:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.132     spz      3009:       file on ftp.NetBSD.org. You should remove the key after the
1.87      wiz      3010:       upload is done!</p>
                   3011: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   3012: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      3013: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   3014: <p>Now after all this works, you can exit the sandbox and start
                   3015:       the upload:</p>
                   3016: <pre class="screen">
                   3017: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   3018: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      3019: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   3020:       </pre>
1.136     dholland 3021: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   3022:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87      wiz      3023:       upload. The upload script will take care of not uploading
1.127     spz      3024:       restricted packages.</p>
1.128     wiz      3025: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3026: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3027:       Gdd:x! </pre>
                   3028: <p>Use whatever is needed to remove the key you've entered
                   3029:       before! Last, move the uploaded packages out of the
                   3030:       <code class="filename">upload</code> directory to have them accessible
                   3031:       to everyone:</p>
                   3032: <pre class="screen">
1.132     spz      3033: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.75      rillig   3034: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3035: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.132     spz      3036: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
                   3037: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.87      wiz      3038:       </pre>
1.75      rillig   3039: </div>
                   3040: </div>
1.148     asau     3041: <div class="sect1">
1.75      rillig   3042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3043: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   3044: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     3045: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3046: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   3047: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   3048: </ul></div>
1.148     asau     3049: <div class="sect2">
1.116     rillig   3050: <div class="titlepage"><div><div><h3 class="title">
                   3051: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117     jnemeth  3052: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
1.116     rillig   3053: <pre class="screen">
                   3054: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3055: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   3056: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   3057: </pre>
                   3058: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.148     asau     3059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3060: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3061: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
                   3062: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
                   3063: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
                   3064: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116     rillig   3065: </ul></div>
                   3066: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3067: <pre class="screen">
                   3068: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3069: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3070: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3071: </pre>
                   3072: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
                   3073: </div>
1.148     asau     3074: <div class="sect2">
1.106     rillig   3075: <div class="titlepage"><div><div><h3 class="title">
1.116     rillig   3076: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114     jmcneill 3077: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116     rillig   3078: <p>TODO: continue writing</p>
1.106     rillig   3079: </div>
                   3080: </div>
1.148     asau     3081: <div class="sect1">
1.106     rillig   3082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3083: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3084: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3085:     create a CD-ROM set of the resulting binary packages to assist
                   3086:     in installing packages on other machines.  The
1.91      rillig   3087:     <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      3088:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  3089:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      3090:     way that keeps all the dependencies for a given package on the same
                   3091:     CD as that package.</p>
1.148     asau     3092: <div class="sect2">
1.75      rillig   3093: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3094: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3095: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3096:       man page. The following short example assumes that the binary
                   3097:       packages are left in
                   3098:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3099:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3100:       hold the ISO 9660 images.</p>
                   3101: <pre class="screen">
                   3102: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3103: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3104: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3105:       </pre>
                   3106: <p>If you wish to include a common set of files
                   3107:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3108:       etc.) on each CD in the collection, then you need to create a
                   3109:       directory which contains these files. e.g.</p>
                   3110: <pre class="screen">
                   3111: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3112: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3113: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3114: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3115: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3116: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3117: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3118:       </pre>
1.75      rillig   3119: <p>Now create the images:</p>
                   3120: <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   3121: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3122:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3123:       in their root directories.</p>
1.75      rillig   3124: </div>
                   3125: </div>
                   3126: </div>
1.148     asau     3127: <div class="chapter">
1.75      rillig   3128: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3129: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3130: <div class="toc">
                   3131: <p><b>Table of Contents</b></p>
                   3132: <dl>
1.128     wiz      3133: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3134: <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   3135: </dl>
                   3136: </div>
                   3137: <p>The files that are installed by pkgsrc are organized in a way that
                   3138: is similar to what you find in the <code class="filename">/usr</code> directory
                   3139: of the base system. But some details are different. This is because
                   3140: pkgsrc initially came from FreeBSD and had adopted its file system
                   3141: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3142: which operating system you are using pkgsrc with, you can expect the
                   3143: same layout for pkgsrc.</p>
1.91      rillig   3144: <p>There are mainly four root directories for pkgsrc, which are all
                   3145: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3146: When pkgsrc has been installed as root, the default locations
                   3147: are:</p>
                   3148: <pre class="programlisting">
1.100     rillig   3149: LOCALBASE=              /usr/pkg
                   3150: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3151: VARBASE=                /var
                   3152: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3153: </pre>
                   3154: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3155: user), the default locations are:</p>
                   3156: <pre class="programlisting">
1.100     rillig   3157: LOCALBASE=              ${HOME}/pkg
                   3158: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3159: VARBASE=                ${HOME}/pkg/var
                   3160: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3161: </pre>
                   3162: <p>What these four directories are for, and what they look like is
                   3163: explained below.</p>
1.148     asau     3164: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3165: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   3166: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      3167: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   3168: the well-known subdirectories like <code class="filename">bin</code>,
                   3169: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3170: <code class="filename">share</code> and
                   3171: <code class="filename">sbin</code>.</p></li>
1.128     wiz      3172: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   3173: <code class="filename">/var</code> in the base system. Some programs (especially
                   3174: games, network daemons) need write access to it during normal
                   3175: operation.</p></li>
1.128     wiz      3176: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   3177: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3178: 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   3179: itself.</p></li>
                   3180: </ul></div>
1.148     asau     3181: <div class="sect1">
1.90      rillig   3182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3183: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3184: </h2></div></div></div>
1.90      rillig   3185: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3186: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     3187: <div class="variablelist"><dl class="variablelist">
1.90      rillig   3188: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3189: <dd><p>Contains executable programs that are intended to be
                   3190: directly used by the end user.</p></dd>
                   3191: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3192: <dd><p>Contains files for the emulation layers of various other
                   3193: operating systems, especially for
                   3194: NetBSD.</p></dd>
                   3195: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3196: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3197: <dd><p>Contains
                   3198: the configuration files.</p></dd>
                   3199: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3200: <dd><p>Contains headers for the C and C++ programming
                   3201: languages.</p></dd>
                   3202: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3203: <dd><p>Contains GNU info files of various
                   3204: packages.</p></dd>
                   3205: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3206: <dd><p>Contains shared and static
                   3207: libraries.</p></dd>
                   3208: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3209: <dd><p>Contains data files that don't change after
                   3210: installation. Other data files belong into
                   3211: <code class="filename">${VARBASE}</code>.</p></dd>
                   3212: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3213: <dd><p>Contains programs that are not intended to be used by
                   3214: end users, such as helper programs or network
                   3215: daemons.</p></dd>
                   3216: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3217: <dd><p>Contains programs that are intended to be executed as
                   3218: CGI scripts by a web server.</p></dd>
                   3219: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3220: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3221: <dd><p>Contains brief
                   3222: documentation in form of manual pages.</p></dd>
                   3223: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3224: <dd><p>Contains programs that are intended to be used only by
                   3225: the super-user.</p></dd>
                   3226: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3227: <dd><p>Contains platform-independent data files that don't
                   3228: change after installation.</p></dd>
                   3229: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3230: <dd><p>Contains documentation files provided by the
                   3231: packages.</p></dd>
                   3232: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3233: <dd><p>Contains example files provided by the packages. Among
                   3234: others, the original configuration files are saved here and copied to
                   3235: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3236: installation.</p></dd>
                   3237: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3238: <dd><p>Contains the original files for rc.d
                   3239: scripts.</p></dd>
                   3240: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3241: <code class="filename">${VARBASE}</code>)</span></dt>
                   3242: <dd><p>Contains files
                   3243: that may be modified after
                   3244: installation.</p></dd>
                   3245: </dl></div>
                   3246: </div>
1.148     asau     3247: <div class="sect1">
1.90      rillig   3248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3249: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3250: </h2></div></div></div>
1.148     asau     3251: <div class="variablelist"><dl class="variablelist">
1.90      rillig   3252: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3253: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3254: <dd><p>Contains
                   3255: information about the currently installed
                   3256: packages.</p></dd>
                   3257: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3258: <dd><p>Contains highscore
                   3259: files.</p></dd>
                   3260: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3261: <dd><p>Contains log files.</p></dd>
                   3262: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3263: <dd><p>Contains informational files about daemons that are
                   3264: currently running.</p></dd>
                   3265: </dl></div>
                   3266: </div>
                   3267: </div>
1.148     asau     3268: <div class="chapter">
1.90      rillig   3269: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3270: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3271: <div class="toc">
                   3272: <p><b>Table of Contents</b></p>
                   3273: <dl>
1.106     rillig   3274: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3275: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3276: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3277: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3278: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3279: <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>
                   3280: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.173   ! wiz      3281: <dt><span class="sect1"><a href="#fetch-https">9.8. How to fetch files from HTTPS sites</a></span></dt>
        !          3282: <dt><span class="sect1"><a href="#passive-ftp">9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
        !          3283: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.10. How to fetch all distfiles at once</a></span></dt>
        !          3284: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      3285: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.173   ! wiz      3286: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.12. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
        !          3287: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.13. Using 'sudo' with pkgsrc</a></span></dt>
        !          3288: <dt><span class="sect1"><a href="#faq.conf">9.14. How do I change the location of configuration files?</a></span></dt>
        !          3289: <dt><span class="sect1"><a href="#audit-packages">9.15. Automated security checks</a></span></dt>
        !          3290: <dt><span class="sect1"><a href="#ufaq-cflags">9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !          3291: <dt><span class="sect1"><a href="#ufaq-fail">9.17. A package does not build.  What shall I do?</a></span></dt>
        !          3292: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.18. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   3293: </dl>
                   3294: </div>
                   3295: <p>This section contains hints, tips &amp; tricks on special things in
                   3296: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3297: it contains items for both pkgsrc users and developers.</p>
1.148     asau     3298: <div class="sect1">
1.75      rillig   3299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3300: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3301: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     3302: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3303: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3304:          This is a general purpose list for most issues regarding
                   3305:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3306:          for pkgsrc configuration, unexpected build failures, using
                   3307:          particular packages, upgrading pkgsrc installations,
                   3308:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3309:          proposals for changes that impact the pkgsrc user community,
                   3310:          e.g. major infrastructure changes, new features, package
                   3311:          removals, etc., may also be posted.</p></li>
1.128     wiz      3312: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3313:          A list where the results of pkgsrc bulk builds are sent and
                   3314:          discussed.</p></li>
1.128     wiz      3315: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3316:          This list is for those who are interested in getting a
                   3317:          commit message for every change committed to pkgsrc. It is
                   3318:          also available in digest form, meaning one daily message
                   3319:          containing all commit messages for changes to the package
                   3320:          source tree in that 24 hour period.</p></li>
                   3321: </ul></div>
                   3322: <p>To subscribe, do:</p>
                   3323: <pre class="programlisting">
1.100     rillig   3324: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3325: </pre>
                   3326: <p>Archives for all these mailing lists are available from
1.110     hubertf  3327: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3328: </div>
1.148     asau     3329: <div class="sect1">
1.75      rillig   3330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3331: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3332: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3333: pkgviews User's guide in
1.76      rillig   3334: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3335: </div>
1.148     asau     3336: <div class="sect1">
1.75      rillig   3337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3338: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3339: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3340: a number of useful utilities for both users and developers of pkgsrc.  This
                   3341: section attempts only to make the reader aware of the utilities and when
                   3342: they might be useful, and not to duplicate the documentation that comes
                   3343: with each package.</p>
                   3344: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.148     asau     3345: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><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   3346:       Symlinks for use by buildlink.</p></li></ul></div>
                   3347: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     3348: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3349: <li class="listitem"><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   3350:       Calculates various kinds of checksums (including SHA1).</p></li>
1.128     wiz      3351: <li class="listitem"><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   3352:       Compatibility library for pkgsrc tools.</p></li>
1.128     wiz      3353: <li class="listitem"><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      3354:       non-BSD systems due to lack of native mtree.</p></li>
1.128     wiz      3355: <li class="listitem"><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   3356:       Up-to-date replacement for
1.76      rillig   3357:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3358:       systems where pkg_install is not present.</p></li>
                   3359: </ul></div>
                   3360: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     3361: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3362: <li class="listitem"><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   3363:       Create a binary package from an
1.110     hubertf  3364:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3365:       save the old package.</p></li>
1.128     wiz      3366: <li class="listitem"><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   3367:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3368:       from multiple locations. It currently supports the following
                   3369:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.128     wiz      3370: <li class="listitem"><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
1.117     jnemeth  3371:       the best compiler flags to optimise code for your current
1.128     wiz      3372:       CPU and compiler. </p></li>
1.75      rillig   3373: </ul></div>
                   3374: <p>Utilities for keeping track of installed packages, being up to date,
                   3375: etc:</p>
1.148     asau     3376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.173   ! wiz      3377: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
        !          3378:     update tool similar to apt(1). Download, install, and upgrade
        !          3379:     binary packages easily.</p></li>
1.128     wiz      3380: <li class="listitem"><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   3381:       packages whose installed versions do not match the latest pkgsrc
                   3382:       entries.</p></li>
1.128     wiz      3383: <li class="listitem"><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   3384:       dependency graphs of packages, to aid in choosing a strategy for
                   3385:       updating.</p></li>
1.128     wiz      3386: <li class="listitem"><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
1.91      rillig   3387:       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>
1.128     wiz      3388: <li class="listitem"><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   3389:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.128     wiz      3390: <li class="listitem"><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   3391:       does various checks on the complete pkgsrc system.</p></li>
1.128     wiz      3392: <li class="listitem"><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   3393:       packages you have installed.</p></li>
                   3394: </ul></div>
                   3395: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     3396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3397: <li class="listitem"><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   3398:       making and maintaining patches for a package (includes pkgdiff,
                   3399:       pkgvi, mkpatches, etc.).</p></li>
1.173   ! wiz      3400: <li class="listitem"><p><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   3401:       converting to pkgsrc.</p></li>
                   3402: </ul></div>
                   3403: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3404: utilities)</p>
1.148     asau     3405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3406: <li class="listitem"><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   3407:       packages in a chrooted area.</p></li>
1.128     wiz      3408: <li class="listitem"><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   3409:       kernel version for chrooted cross builds.</p></li>
                   3410: </ul></div>
                   3411: </div>
1.148     asau     3412: <div class="sect1">
1.75      rillig   3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3414: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3415: <p>If you want to use pkgsrc as non-root user, you can set some
                   3416: variables to make pkgsrc work under these conditions.  At the very least,
1.128     wiz      3417: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>; this
1.75      rillig   3418: will turn on unprivileged mode and set multiple related variables to allow
                   3419: installation of packages as non-root.</p>
                   3420: <p>In case the defaults are not enough, you may want to tune some other
                   3421: variables used.  For example, if the automatic user/group detection leads
                   3422: to incorrect values (or not the ones you would like to use), you can change
                   3423: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3424: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3425: <p>As regards bootstrapping, please note that the
1.110     hubertf  3426: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.128     wiz      3427: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.76      rillig   3428: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3429: installation targets.  These directories can be overridden by the
1.128     wiz      3430: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.75      rillig   3431: that allow finer tuning of the tree layout.</p>
                   3432: </div>
1.148     asau     3433: <div class="sect1">
1.75      rillig   3434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3435: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3436: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3437: enable this feature by adding the option
                   3438: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3439: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3440: distfile is found, pkgsrc will try to resume it.</p>
                   3441: <p>You can also
1.168     wiz      3442: use a different program than the platform default program by changing the
1.117     jnemeth  3443: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3444: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3445: by using the value manual.  A value of custom disables the system defaults
                   3446: and dependency tracking for the fetch program.  In that case you have to
                   3447: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3448: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3449: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3450: <p>For example, if you want to use
1.117     jnemeth  3451: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3452: like:</p>
                   3453: <pre class="programlisting">
1.117     jnemeth  3454: FETCH_USING=   wget
1.1       grant    3455: </pre>
1.75      rillig   3456: </div>
1.148     asau     3457: <div class="sect1">
1.75      rillig   3458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3459: <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      3460: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3461: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3462: you will have to add the following line into
1.110     hubertf  3463: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3464: <pre class="programlisting">
1.103     wiz      3465: X11_TYPE=modular
1.1       grant    3466: </pre>
1.148     asau     3467: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   3468: <h3 class="title">Note</h3>
1.103     wiz      3469: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3470: </p>
1.75      rillig   3471: </div>
                   3472: </div>
1.148     asau     3473: <div class="sect1">
1.75      rillig   3474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3475: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3476: <p>If you are sitting behind a firewall which does not allow direct
                   3477: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3478: relevant proxy hosts.  This is done using an environment variable in the
                   3479: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      3480: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   3481: port 80 as the proxy port number.  So the proxy environment variables
                   3482: are:</p>
                   3483: <pre class="programlisting">
1.100     rillig   3484: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3485: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3486: </pre>
1.75      rillig   3487: </div>
1.148     asau     3488: <div class="sect1">
1.75      rillig   3489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3490: <a name="fetch-https"></a>9.8. How to fetch files from HTTPS sites</h2></div></div></div>
        !          3491: <p>Some fetch tools are not prepared to support HTTPS by default
        !          3492: (for example, the one in NetBSD 6.0), or the one installed by the
        !          3493: pkgsrc bootstrap (to avoid an openssl dependency that low in the
        !          3494: dependency graph).</p>
        !          3495: <p>Usually you won't notice, because distribution files are
        !          3496: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
        !          3497: be often enough if you are following pkgsrc-current. In that case, set
        !          3498: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
        !          3499: <span class="quote">&#8220;<span class="quote">curl</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">wget</span>&#8221;</span>, which are both compiled
        !          3500: with HTTPS support by default. Of course, these tools need to be
        !          3501: installed before you can use them this way.</p>
        !          3502: </div>
        !          3503: <div class="sect1">
        !          3504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !          3505: <a name="passive-ftp"></a>9.9. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3506: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3507: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3508: the first available command from the following list:</p>
1.148     asau     3509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3510: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3511: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3512: </ul></div>
                   3513: <p>On a default NetBSD installation, this will be
1.76      rillig   3514: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3515: connections first, and falls back to active connections if the server
                   3516: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3517: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3518: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3519: <p>Having that option present will prevent
1.76      rillig   3520: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3521: transfers.</p>
                   3522: </div>
1.148     asau     3523: <div class="sect1">
1.75      rillig   3524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3525: <a name="fetching-all-distfiles"></a>9.10. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3526: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3527: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3528: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3529: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3530: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3531: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3532: resulting list to your machine at work/school and use it there.  If you
1.136     dholland 3533: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3534: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3535: URL:</p>
                   3536: <p>At home:</p>
                   3537: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3538: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3539: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3540: <p>At work:</p>
                   3541: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3542: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3543: home.</p>
                   3544: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3545: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3546: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3547: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3548: directly by running:</p>
1.75      rillig   3549: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3550: <p>If you even decide to ignore
                   3551: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3552: by running:</p>
                   3553: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3554: </div>
1.148     asau     3555: <div class="sect1">
1.75      rillig   3556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3557: <a name="tmac.andoc-missing"></a>9.11. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      3558: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.91      rillig   3559: <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   3560: package, you get the error from make that it doesn't know how to make
1.76      rillig   3561: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      3562: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   3563: the NetBSD base distribution on your machine.  It is recommended to do
                   3564: that to format man pages.</p>
1.91      rillig   3565: <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   3566: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3567: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3568: </div>
1.148     asau     3569: <div class="sect1">
1.75      rillig   3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3571: <a name="bsd.own.mk-missing"></a>9.12. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      3572: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3573: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3574: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3576: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3577: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3578: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3579: -r</strong></span>).</p>
                   3580: </div>
1.148     asau     3581: <div class="sect1">
1.75      rillig   3582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3583: <a name="using-sudo-with-pkgsrc"></a>9.13. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3584: <p>When installing packages as non-root user and using the just-in-time
1.136     dholland 3585: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><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   3586: password for each required package installed.  To avoid this, the sudo
                   3587: package can be used, which does password caching over a limited time.  To
                   3588: use it, install sudo (either as binary package or from
1.98      wiz      3589: <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  3590: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3591: <span class="emphasis"><em>after</em></span> the definition of the
                   3592: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3593: <pre class="programlisting">
1.100     rillig   3594: .if exists(${LOCALBASE}/bin/sudo)
                   3595: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3596: .endif
1.1       grant    3597: </pre>
1.75      rillig   3598: </div>
1.148     asau     3599: <div class="sect1">
1.75      rillig   3600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3601: <a name="faq.conf"></a>9.14. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3602: <p>As the system administrator, you can choose where configuration files
                   3603: are installed.  The default settings make all these files go into
1.76      rillig   3604: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3605: be suboptimal depending on your expectations (e.g., a read-only,
                   3606: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3607: configuration of the provided packages).</p>
                   3608: <p>In order to change the defaults, you can modify the
                   3609: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3610: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3611: directory; some common examples include <code class="filename">/etc</code> or
                   3612: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3613: <p>Furthermore, you can change this value on a per-package basis by
                   3614: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3615: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3616: package you would like to modify, that is, the contents of
                   3617: <code class="varname">PKGBASE</code>.</p>
                   3618: <p>Note that after changing these settings, you must rebuild and
                   3619: reinstall any affected packages.</p>
                   3620: </div>
1.148     asau     3621: <div class="sect1">
1.75      rillig   3622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3623: <a name="audit-packages"></a>9.15. Automated security checks</h2></div></div></div>
1.75      rillig   3624: <p>Please be aware that there can often be bugs in third-party software,
                   3625: and some of these bugs can leave a machine vulnerable to exploitation by
                   3626: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3627: maintains a database of known-exploits to packages which have at one time
                   3628: been included in pkgsrc.  The database can be downloaded automatically, and
                   3629: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3630: do this, refer to the following two tools (installed as part of the
                   3631: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3632: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3633: <li class="listitem">
1.122     reed     3634: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3635:     download a list of the security vulnerabilities information.  This list
1.132     spz      3636:     is kept up to date by the pkgsrc security team, and is distributed
                   3637:     from the NetBSD ftp server:</p>
                   3638: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3639: </li>
1.128     wiz      3640: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3641:     current machine, checking each known vulnerability.  If a
1.75      rillig   3642:     vulnerable package is installed, it will be shown by output to stdout,
                   3643:     including a description of the type of vulnerability, and a URL
                   3644:     containing more information.</p></li>
                   3645: </ol></div>
1.114     jmcneill 3646: <p>Use of these tools is strongly recommended!  After
1.128     wiz      3647: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.75      rillig   3648: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3649: pkg_install</code></strong>.</p>
1.87      wiz      3650: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3651: 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      3652: check.</p>
1.75      rillig   3653: </div>
1.148     asau     3654: <div class="sect1">
1.75      rillig   3655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3656: <a name="ufaq-cflags"></a>9.16. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3657: <p>When you add your own preferences to the
                   3658:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3659:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3660:        environment variables to the <code class="filename">./configure</code>
1.136     dholland 3661:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3662:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3663:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3664:        package.</p>
                   3665: <p>Currently there is no solution to this problem. If you
                   3666:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3667:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3668:        directory and then inspect any <code class="filename">Makefile</code> and
                   3669:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3670:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3671:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3672:        programmers write so bad code that it only works for the
                   3673:        specific combination of <code class="varname">CFLAGS</code> they have
                   3674:        chosen.</p>
                   3675: </div>
1.148     asau     3676: <div class="sect1">
1.80      rillig   3677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3678: <a name="ufaq-fail"></a>9.17. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3679: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3680: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3681:        case that occurs often is that people only update pkgsrc in
                   3682:        parts, because of performance reasons. Since pkgsrc is one large
                   3683:        system, not a collection of many small systems, there are
                   3684:        sometimes changes that only work when the whole pkgsrc tree is
                   3685:        updated.</p></li>
1.148     asau     3686: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3687:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3688:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3689:        files.</p></li>
1.148     asau     3690: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3691:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3692:        verify this.</p></li>
1.148     asau     3693: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3694:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3695: </ol></div>
                   3696: </div>
1.148     asau     3697: <div class="sect1">
1.88      wiz      3698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.173   ! wiz      3699: <a name="faq.rcs-conflicts"></a>9.18. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   3700: <p>You have modified a file from pkgsrc, and someone else has
                   3701: modified that same file afterwards in the CVS repository. Both changes
                   3702: are in the same region of the file, so when you updated pkgsrc, the
                   3703: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3704: file. Because of these markers, the file is no longer a valid
                   3705: <code class="filename">Makefile</code>.</p>
                   3706: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3707: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3708: -dP</strong></span> in that directory to download the current version.</p>
                   3709: </div>
1.75      rillig   3710: </div>
                   3711: </div>
1.148     asau     3712: <div class="part">
1.75      rillig   3713: <div class="titlepage"><div><div><h1 class="title">
                   3714: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3715: <div class="partintro">
1.77      rillig   3716: <div></div>
                   3717: <p>This part of the book deals with creating and
1.128     wiz      3718:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3719:        guide on creating a new package. The remaining chapters are more
                   3720:        like a reference manual for pkgsrc.</p>
1.75      rillig   3721: <div class="toc">
                   3722: <p><b>Table of Contents</b></p>
                   3723: <dl>
1.106     rillig   3724: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3725: <dd><dl>
1.106     rillig   3726: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3727: <dd><dl>
1.106     rillig   3728: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3729: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3730: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3731: </dl></dd>
1.106     rillig   3732: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3733: <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>
                   3734: </dl></dd>
                   3735: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3736: <dd><dl>
1.128     wiz      3737: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3738: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   3739: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3740: <dd><dl>
                   3741: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3742: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3745: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3746: </dl></dd>
                   3747: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3748: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3749: <dd><dl>
                   3750: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3751: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3752: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3753: </dl></dd>
1.128     wiz      3754: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3755: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3756: </dl></dd>
1.128     wiz      3757: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3758: <dd><dl>
                   3759: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      3760: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   3761: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3762: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3763: <dd><dl>
                   3764: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3765: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3767: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3769: </dl></dd>
                   3770: </dl></dd>
                   3771: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3772: <dd><dl>
                   3773: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      3774: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3775: <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   3776: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      3778: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   3779: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3780: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3781: </dl></dd>
                   3782: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3783: <dd><dl>
                   3784: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      3785: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3786: <dd><dl>
                   3787: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      3788: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3789:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3790:       and
                   3791:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3792:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3793: </dl></dd>
1.128     wiz      3794: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   3795: <dd><dl>
1.128     wiz      3796: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   3797: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3798: </dl></dd>
                   3799: </dl></dd>
                   3800: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3801: <dd><dl>
                   3802: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3803: <dd><dl>
                   3804: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3805: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3806: </dl></dd>
                   3807: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3808: <dd><dl>
1.128     wiz      3809: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   3810: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3811: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3813: </dl></dd>
                   3814: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3815: <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>
                   3816: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3817: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3818: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3819: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3820: <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>
                   3821: </dl></dd>
                   3822: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3823: <dd><dl>
                   3824: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      3825: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   3826: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3827: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3828: </dl></dd>
                   3829: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3830: <dd><dl>
                   3831: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3832: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3833: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3834: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      3835: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3836: <dd><dl>
                   3837: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3838: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3839: </dl></dd>
1.128     wiz      3840: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3841: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3842: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3843: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3844: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3845: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3846: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3847: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3848: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3849: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   3850: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3851: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3852: </dl></dd>
                   3853: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3854: <dd><dl>
                   3855: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3856: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3857: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3858: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3859: </dl></dd>
                   3860: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3861: <dd><dl>
                   3862: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3863: <dd><dl>
                   3864: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128     wiz      3865: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig   3866: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3867: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3870: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3871: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3872: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3873: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3874: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3875: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3876: </dl></dd>
1.128     wiz      3877: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3878: <dd><dl>
                   3879: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3880: <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>
                   3881: </dl></dd>
1.128     wiz      3882: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   3883: <dd><dl>
                   3884: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3885: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3886: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3887: </dl></dd>
                   3888: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3889: <dd><dl>
                   3890: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3891: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3892: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      3893: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   3894: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   3895: </dl></dd>
1.128     wiz      3896: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   3897: <dd><dl>
                   3898: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3899: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      3900: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig   3901: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3902: </dl></dd>
1.128     wiz      3903: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   3904: <dd><dl>
                   3905: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3906: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3907: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3908: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3909: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3910: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3911: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3912: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3913: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   3914: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3915: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3916: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3917: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3918: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3919: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3920: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3921: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3922: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3923:     emulation</a></span></dt>
1.106     rillig   3924: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3925: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3926: </dl></dd>
1.106     rillig   3927: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3928: </dl></dd>
1.106     rillig   3929: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3930: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3931: <dd><dl>
1.106     rillig   3932: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3933: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3934: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      3935: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   3936: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     3937: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3938: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   3939: </dl></dd>
                   3940: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3941: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3942: <dd><dl>
                   3943: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3944: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3945: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3946: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3947: </dl></dd>
1.75      rillig   3948: </dl>
                   3949: </div>
1.77      rillig   3950: </div>
1.148     asau     3951: <div class="chapter">
1.77      rillig   3952: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3953: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3954: <div class="toc">
                   3955: <p><b>Table of Contents</b></p>
                   3956: <dl>
1.106     rillig   3957: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3958: <dd><dl>
1.106     rillig   3959: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3960: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3961: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3962: </dl></dd>
1.106     rillig   3963: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3964: <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   3965: </dl>
                   3966: </div>
1.77      rillig   3967: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3968: most likely have a URL from where you can download the source
                   3969: code. Starting with this URL, creating a package involves only a
                   3970: few steps.</p>
1.128     wiz      3971: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3972: <li class="step"><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>
                   3973: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3974: category in which you want to place your package. You can also create a
                   3975: directory of your own (maybe called <code class="filename">local</code>). In that
                   3976: category directory, create another directory for your package and change
                   3977: into it.</p></li>
1.148     asau     3978: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3979: you for a URL. Enter the URL of the distribution file (in most cases a
                   3980: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3981: of your package are created automatically. The distribution file is
                   3982: extracted automatically to fill in some details in the
                   3983: <code class="filename">Makefile</code> that would otherwise have to be done
                   3984: manually.</p></li>
1.148     asau     3985: <li class="step">
1.91      rillig   3986: <p>Examine the extracted files to determine the dependencies of
                   3987: your package. Ideally, this is mentioned in some
                   3988: <code class="filename">README</code> file, but things may differ. For each of
                   3989: these dependencies, look where it exists in pkgsrc, and if there is a
                   3990: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3991: line to your package <code class="filename">Makefile</code> which includes that
                   3992: file just before the last line. If the
1.132     spz      3993: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3994: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3995: <p>If you just need binaries from a package, add a
1.91      rillig   3996: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3997: version of the dependency and where it can be found in pkgsrc. This line
                   3998: should be placed in the third paragraph. If the dependency is only
                   3999: needed for building the package, but not when using it, use
                   4000: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   4001: Your package may then look like this:</p>
1.77      rillig   4002: <pre class="programlisting">
1.100     rillig   4003: [...]
1.77      rillig   4004: 
1.100     rillig   4005: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   4006: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   4007: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   4008: 
1.100     rillig   4009: [...]
1.77      rillig   4010: 
1.100     rillig   4011: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   4012: .include "../../devel/glib2/buildlink3.mk"
                   4013: .include "../../mk/bsd.pkg.mk"
1.77      rillig   4014: </pre>
                   4015: </li>
1.148     asau     4016: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      4017: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.110     hubertf  4018: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   4019: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   4020: -e</strong></span>, which outputs additional
                   4021: explanations.</p></li>
1.148     asau     4022: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  4023: 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   4024: over there, you can hopefully continue here.</p></li>
1.148     asau     4025: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   4026: directory from the extracted files. Besides these files, a lot of cache
                   4027: files and other system information has been saved in the working
                   4028: directory, which may become wrong after you edited the
                   4029: <code class="filename">Makefile</code>.</p></li>
1.148     asau     4030: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  4031: 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.148     asau     4032: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  4033: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   4034: everything works.</p></li>
1.148     asau     4035: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   4036: contains a list of the files that are installed by the package, is
1.110     hubertf  4037: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   4038: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   4039: the file using your preferred text editor to see if the list of
                   4040: files looks plausible.</p></li>
1.148     asau     4041: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   4042: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     4043: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   4044: has been registered in the database of installed files, but with an
1.110     hubertf  4045: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   4046: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   4047: registered with the list of files from
                   4048: <code class="filename">PLIST</code>.</p></li>
1.148     asau     4049: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   4050: package from the set of installed files.</p></li>
1.77      rillig   4051: </ol></div>
1.148     asau     4052: <div class="sect1">
1.91      rillig   4053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4054: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     4055: <div class="sect2">
1.91      rillig   4056: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4057: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   4058: <p>Simple Perl modules are handled automatically by
1.110     hubertf  4059: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   4060: </div>
1.148     asau     4061: <div class="sect2">
1.91      rillig   4062: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4063: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   4064: <p>KDE applications should always include
                   4065: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4066: settings that are typical of KDE packages.</p>
                   4067: </div>
1.148     asau     4068: <div class="sect2">
1.118     imil     4069: <div class="titlepage"><div><div><h3 class="title">
                   4070: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   4071: <p>Python modules and programs packages are easily created using a
                   4072: set of predefined variables.</p>
                   4073: <p>
1.171     wiz      4074: If some Python versions are not supported by the software, set the
                   4075: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   4076: that are not supported, e.g.
1.118     imil     4077: </p>
                   4078: <pre class="programlisting">
1.172     wiz      4079: PYTHON_VERSIONS_INCOMPATIBLE=       26
1.118     imil     4080: </pre>
                   4081: <p>
                   4082: If the packaged software is a Python module, include
1.128     wiz      4083: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
1.118     imil     4084: In this case, the package directory should be called
1.128     wiz      4085: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   4086: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     4087: </p>
                   4088: <pre class="programlisting">
                   4089: DISTNAME=   foopymodule-1.2.10
                   4090: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   4091: </pre>
1.171     wiz      4092: <p>If it is an application, include
                   4093: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   4094: In order to correctly set the path to the Python interpreter, use the
1.118     imil     4095: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      4096: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      4097: For example:
1.118     imil     4098: </p>
                   4099: <pre class="programlisting">
1.142     wiz      4100: REPLACE_PYTHON=   *.py
1.118     imil     4101: </pre>
1.171     wiz      4102: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   4103: easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   4104: If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   4105: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   4106: so pkgsrc will use this framework.
                   4107: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   4108: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   4109: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   4110: to the name of the script.</p>
                   4111: <p>Otherwise, if the packaged software is egg-aware, you only need
                   4112: to include
                   4113: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
                   4114: <p>Some Python modules have separate distributions for Python-2.x
                   4115: and Python-3.x support. In pkgsrc this is handled by the
                   4116: <code class="filename">versioned_dependencies.mk</code> file. Set
                   4117: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   4118: packages that should be depended upon and include
                   4119: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   4120: then the pkgsrc infrastructure will depend on the appropriate package
                   4121: version. For example:
                   4122: </p>
                   4123: <pre class="programlisting">
                   4124: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
                   4125: </pre>
                   4126: <p>
                   4127: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   4128: of supported packages.</p>
1.118     imil     4129: </div>
1.91      rillig   4130: </div>
1.148     asau     4131: <div class="sect1">
1.91      rillig   4132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4133: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     4134: <div class="sect2">
1.91      rillig   4135: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4136: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     4137: <div class="sect3">
1.91      rillig   4138: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4139: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   4140: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      4141: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   4142: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      4143: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   4144: <pre class="programlisting">
1.100     rillig   4145: <code class="prompt">$</code> mkdir www/nvu
                   4146: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4147: </pre>
                   4148: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  4149: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   4150: <pre class="programlisting">
1.100     rillig   4151: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4152: </pre>
                   4153: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4154: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      4155: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.91      rillig   4156: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4157: <code class="varname">COMMENT</code> fields. Then the package
                   4158: <code class="filename">Makefile</code> looked like that:</p>
                   4159: <pre class="programlisting">
1.100     rillig   4160: # $NetBSD$
                   4161: #
1.91      rillig   4162: 
1.100     rillig   4163: DISTNAME=       nvu-1.0-sources
                   4164: PKGNAME=        nvu-1.0
                   4165: CATEGORIES=     www
                   4166: MASTER_SITES=   http://cvs.nvu.com/download/
                   4167: EXTRACT_SUFX=   .tar.bz2
                   4168: 
                   4169: MAINTAINER=     rillig@NetBSD.org
                   4170: HOMEPAGE=       http://cvs.nvu.com/
                   4171: COMMENT=        Web Authoring System
1.91      rillig   4172: 
1.100     rillig   4173: # url2pkg-marker (please do not remove this line.)
                   4174: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4175: </pre>
                   4176: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4177: source archive:</p>
                   4178: <pre class="programlisting">
1.100     rillig   4179: url2pkg&gt; Running "make makesum" ...
                   4180: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4181: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4182: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4183: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4184: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4185: url2pkg&gt; Running "make extract" ...
                   4186: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4187: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4188: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4189: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4190: ===&gt; Installing dependencies for nvu-1.0
                   4191: ===&gt; Overriding tools for nvu-1.0
                   4192: ===&gt; Extracting for nvu-1.0
                   4193: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4194: 
1.100     rillig   4195: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4196: 
1.100     rillig   4197: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4198: </pre>
                   4199: </div>
1.148     asau     4200: <div class="sect3">
1.91      rillig   4201: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4202: <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   4203: <p>Now that the package has been extracted, let's see what's inside
                   4204: it. The package has a <code class="filename">README.txt</code>, but that only
                   4205: says something about mozilla, so it's probably useless for seeing what
                   4206: dependencies this package has. But since there is a GNU configure script
                   4207: in the package, let's hope that it will complain about everything it
                   4208: needs.</p>
                   4209: <pre class="programlisting">
1.100     rillig   4210: <code class="prompt">$</code> bmake
                   4211: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4212: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4213: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4214: ===&gt; Patching for nvu-1.0
                   4215: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4216: ===&gt; Configuring for nvu-1.0
                   4217: [...]
                   4218: configure: error: Perl 5.004 or higher is required.
                   4219: [...]
                   4220: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4221: [...]
1.91      rillig   4222: </pre>
                   4223: <p>That worked quite well. So I opened the package Makefile in my
                   4224: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      4225: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   4226: package have changed now, and since a perl wrapper is automatically
1.128     wiz      4227: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   4228: from scratch.</p>
                   4229: <pre class="programlisting">
1.100     rillig   4230: <code class="prompt">$</code> bmake clean
                   4231: ===&gt; Cleaning for nvu-1.0
                   4232: <code class="prompt">$</code> bmake
                   4233: [...]
                   4234: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4235: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4236: [...]
1.91      rillig   4237: </pre>
1.128     wiz      4238: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   4239: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4240: <pre class="programlisting">
1.100     rillig   4241: [...]
                   4242: checking for GTK - version &gt;= 1.2.0... no
                   4243: *** Could not run GTK test program, checking why...
                   4244: [...]
1.91      rillig   4245: </pre>
                   4246: <p>Now to the other dependencies. The first question is: Where is the
                   4247: GTK package hidden in pkgsrc?</p>
                   4248: <pre class="programlisting">
1.100     rillig   4249: <code class="prompt">$</code> echo ../../*/gtk*
                   4250: [many packages ...]
                   4251: <code class="prompt">$</code> echo ../../*/gtk
                   4252: ../../x11/gtk
                   4253: <code class="prompt">$</code> echo ../../*/gtk2
                   4254: ../../x11/gtk2
                   4255: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4256: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4257: </pre>
                   4258: <p>The first try was definitely too broad. The second one had exactly
                   4259: one result, which is very good. But there is one pitfall with GNOME
                   4260: packages. Before GNOME 2 had been released, there were already many
                   4261: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4262: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      4263: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   4264: whether this was the case here, and indeed it was.</p>
                   4265: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4266: file, adding the dependency is very easy. I just inserted an
                   4267: <code class="literal">.include</code> line before the last line of the package
                   4268: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4269: <pre class="programlisting">
1.100     rillig   4270: [...]
                   4271: .include "../../x11/gtk2/buildlink3.mk"
                   4272: .include "../../mk/bsd.pkg.mk
1.91      rillig   4273: </pre>
1.110     hubertf  4274: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4275: was:</p>
                   4276: <pre class="programlisting">
1.100     rillig   4277: [...]
                   4278: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4279: checking for GTK - version &gt;= 1.2.0... no
                   4280: *** Could not run GTK test program, checking why...
                   4281: *** The test program failed to compile or link. See the file config.log for the
                   4282: *** exact error that occured. This usually means GTK was incorrectly installed
                   4283: *** or that you have moved GTK since it was installed. In the latter case, you
                   4284: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4285: configure: error: Test for GTK failed.
                   4286: [...]
1.91      rillig   4287: </pre>
1.128     wiz      4288: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   4289: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   4290: told me that this package really wanted to have the GNOME 1 version of
                   4291: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4292: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4293: So I changed the <code class="literal">x11/gtk2</code> to
                   4294: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4295: and tried again.</p>
                   4296: <pre class="programlisting">
1.100     rillig   4297: [...]
1.166     jnemeth  4298: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   4299: In file included from xpidl.c:42:
                   4300: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4301: In file included from xpidl.c:42:
                   4302: xpidl.h:132: error: parse error before "IDL_ns"
                   4303: [...]
1.91      rillig   4304: </pre>
                   4305: <p>The package still does not find all of its dependencies. Now the
                   4306: question is: Which package provides the
                   4307: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4308: <pre class="programlisting">
1.100     rillig   4309: <code class="prompt">$</code> echo ../../*/*idl*
                   4310: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4311: <code class="prompt">$</code> echo ../../*/*IDL*
                   4312: ../../net/libIDL
1.91      rillig   4313: </pre>
                   4314: <p>Let's take the one from the second try. So I included the
                   4315: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4316: again. But the error didn't change. After digging through some of the
                   4317: code, I concluded that the build process of the package was broken and
                   4318: couldn't have ever worked, but since the Mozilla source tree is quite
                   4319: large, I didn't want to fix it. So I added the following to the package
                   4320: <code class="filename">Makefile</code> and tried again:</p>
                   4321: <pre class="programlisting">
1.100     rillig   4322: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4323: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4324: </pre>
                   4325: <p>The latter line is needed because the package expects the library
                   4326: <code class="filename">libIDL.so</code>, but only
                   4327: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4328: wrapper to rewrite that on the fly.</p>
                   4329: <p>The next problem was related to a recent change of the FreeType
                   4330: 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>
                   4331: which patch files were relevant for this issue and copied them to the
                   4332: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4333: patches so that they applied cleanly and retried again. This time,
                   4334: everything worked.</p>
                   4335: </div>
1.148     asau     4336: <div class="sect3">
1.91      rillig   4337: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4338: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4339: <pre class="programlisting">
1.100     rillig   4340: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4341: [...]
                   4342: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4343: <code class="prompt">$</code> bmake deinstall
                   4344: <code class="prompt">$</code> bmake install
1.91      rillig   4345: </pre>
                   4346: </div>
                   4347: </div>
                   4348: </div>
1.77      rillig   4349: </div>
1.148     asau     4350: <div class="chapter">
1.75      rillig   4351: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4352: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4353: <div class="toc">
                   4354: <p><b>Table of Contents</b></p>
                   4355: <dl>
1.128     wiz      4356: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4357: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.106     rillig   4358: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4359: <dd><dl>
                   4360: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4361: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4362: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4363: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4364: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4365: </dl></dd>
                   4366: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4367: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4368: <dd><dl>
                   4369: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4370: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4371: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4372: </dl></dd>
1.128     wiz      4373: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4374: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4375: </dl>
                   4376: </div>
1.87      wiz      4377: <p>Whenever you're preparing a package, there are a number of
                   4378: files involved which are described in the following
                   4379: sections.</p>
1.148     asau     4380: <div class="sect1">
1.75      rillig   4381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4382: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4383: </h2></div></div></div>
1.75      rillig   4384: <p>Building, installation and creation of a binary package are all
1.87      wiz      4385:   controlled by the package's <code class="filename">Makefile</code>.
                   4386:   The <code class="filename">Makefile</code> describes various things about
                   4387:   a package, for example from where to get it, how to configure,
                   4388:   build, and install it.</p>
1.76      rillig   4389: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4390:   sections that describe the package.</p>
1.75      rillig   4391: <p>In the first section there are the following variables, which
1.87      wiz      4392:   should appear exactly in the order given here.  The order and
                   4393:   grouping of the variables is mostly historical and has no further
                   4394:   meaning.</p>
1.148     asau     4395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4396: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4397:     distribution file to be downloaded from the package's
                   4398:     website.</p></li>
1.128     wiz      4399: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4400:     package, as used by pkgsrc. You only need to provide it if
                   4401:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4402:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4403:     directory name together with the version number. It must match the
                   4404:     regular expression
                   4405:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4406:     starts with a letter or digit, and contains only letters, digits,
                   4407:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      4408: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.87      wiz      4409:     the package file to create if the <code class="varname">PKGNAME</code>
                   4410:     isn't unique on a SVR4 system. The default is
                   4411:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4412:     <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      4413:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4414:     does not produce an unique package name on a SVR4 system.
                   4415:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4416:     characters.</p></li>
1.128     wiz      4417: <li class="listitem">
1.75      rillig   4418: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4419:     which the package fits in. You can choose any of the top-level
                   4420:     directories of pkgsrc for it.</p>
1.75      rillig   4421: <p>Currently the following values are available for
1.87      wiz      4422:     <code class="varname">CATEGORIES</code>. If more than
                   4423:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4424: <pre class="programlisting">
1.100     rillig   4425: archivers     cross         geography     meta-pkgs     security
                   4426: audio         databases     graphics      misc          shells
                   4427: benchmarks    devel         ham           multimedia    sysutils
                   4428: biology       editors       inputmethod   net           textproc
                   4429: cad           emulators     lang          news          time
                   4430: chat          finance       mail          parallel      wm
                   4431: comms         fonts         math          pkgtools      www
                   4432: converters    games         mbone         print         x11
                   4433: </pre>
1.75      rillig   4434: </li>
1.128     wiz      4435: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4436:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4437:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4438:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.128     wiz      4439:     <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   4440: </ul></div>
                   4441: <p>The second section contains information about separately
1.87      wiz      4442:   downloaded patches, if any.
                   4443:   </p>
1.148     asau     4444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4445: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4446:     Name(s) of additional files that contain distribution patches.
                   4447:     There is no default. pkgsrc will look for them at
                   4448:     <code class="varname">PATCH_SITES</code>.
                   4449:     They will automatically be uncompressed before patching if
                   4450:     the names end with <code class="filename">.gz</code> or
                   4451:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      4452: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4453:     Primary location(s) for distribution patch files (see
                   4454:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4455: </ul></div>
                   4456: <p>The third section contains the following variables.
1.87      wiz      4457:   </p>
1.148     asau     4458: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4459: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 4460:     address of the person who feels responsible for this package,
                   4461:     and who is most likely to look at problems or questions regarding
1.136     dholland 4462:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114     jmcneill 4463:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4464:     before making changes to the package, but are not required to
                   4465:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4466:     to yourself. If you really can't maintain the package for future
                   4467:     updates, set it to
1.110     hubertf  4468:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.128     wiz      4469: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 4470:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4471:     developers to update or change the package without contacting
                   4472:     you first. A package Makefile should contain one of
                   4473:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4474:     not both.  </p></li>
1.128     wiz      4475: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4476:     find more information about the package.</p></li>
1.128     wiz      4477: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4478:     description of the package (should not include the package
                   4479:     name).</p></li>
1.75      rillig   4480: </ul></div>
                   4481: <p>Other variables that affect the build:
1.87      wiz      4482:   </p>
1.148     asau     4483: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   4484: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4485:       interesting distribution files of the package are found. The
                   4486:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4487:       works for most packages.</p>
1.75      rillig   4488: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4489:       (most GNU software does, for instance), but extracts itself in
                   4490:       the current directory, you should set
                   4491:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4492: <p>If a package doesn't create a subdirectory with the
                   4493:       name of <code class="varname">DISTNAME</code> but some different name,
                   4494:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4495:       <code class="filename">${WRKDIR}</code>, for example
                   4496:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4497:       <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   4498: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4499:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4500:       variable. By default, its value is
                   4501:       <code class="filename">work</code>. If you want to use the same
                   4502:       pkgsrc tree for building different kinds of binary packages,
                   4503:       you can change the variable according to your needs. Two
                   4504:       other variables handle common cases of setting
                   4505:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4506:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4507:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4508:       the host's name is attached to the directory name. If
                   4509:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4510:       is attached, which might look like
                   4511:       <code class="filename">work.i386</code> or
                   4512:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4513: </li></ul></div>
                   4514: <p>Please pay attention to the following gotchas:</p>
1.148     asau     4515: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4516: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4517:       installed in compressed form by the package.  For packages using
                   4518:       BSD-style makefiles which honor MANZ, there is
                   4519:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      4520: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4521:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      4522:       below).</p></li>
1.128     wiz      4523: <li class="listitem"><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   4524: </ul></div>
                   4525: </div>
1.148     asau     4526: <div class="sect1">
1.75      rillig   4527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4528: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4529: </h2></div></div></div>
1.76      rillig   4530: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4531:   digest, or checksum, of each distfile needed for the package. This
                   4532:   ensures that the distfiles retrieved from the Internet have not been
                   4533:   corrupted during transfer or altered by a malign force to introduce
                   4534:   a security hole. Due to recent rumor about weaknesses of digest
                   4535:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4536:   message digests, as well as the file size.</p>
1.76      rillig   4537: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4538:   checksums for all the patches found in the
1.110     hubertf  4539:   <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   4540: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4541:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4542:   command.</p>
1.75      rillig   4543: <p>Some packages have different sets of distfiles depending on
1.128     wiz      4544:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      4545:   <code class="filename">distinfo</code> file and care should be taken when
                   4546:   upgrading such a package to ensure distfile information is not
                   4547:   lost.</p>
1.75      rillig   4548: </div>
1.148     asau     4549: <div class="sect1">
1.75      rillig   4550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4551: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4552: <p>Many packages still don't work out-of-the box on the various
                   4553:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4554:   patch files are needed to make the package work. These patch files are
                   4555:   found in the <code class="filename">patches/</code> directory.</p>
                   4556: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4557:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4558:   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.130     wiz      4559:   order</a>.</p>
1.148     asau     4560: <div class="sect2">
1.93      rillig   4561: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4562: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4563: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4564:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4565:   problems. (To force patches to apply with fuzz you can set
                   4566:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4567:   should contain only changes for a single file, and no file should be
1.93      rillig   4568:   patched by more than one patch file. This helps to keep future
                   4569:   modifications simple.</p>
                   4570: <p>Each patch file is structured as follows: In the first line,
                   4571:   there is the RCS Id of the patch itself. The second line should be
                   4572:   empty for aesthetic reasons. After that, there should be a comment for
                   4573:   each change that the patch does. There are a number of standard
                   4574:   cases:</p>
1.148     asau     4575: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4576: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   4577:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      4578: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   4579:   platform and other environment (for example, the compiler) that the
                   4580:   patch is needed for.</p></li>
                   4581: </ul></div>
1.130     wiz      4582: <p>In all, the patch should be commented so that any
1.93      rillig   4583:   developer who knows the code of the application can make some use of
                   4584:   the patch. Special care should be taken for the upstream developers,
                   4585:   since we generally want that they accept our patches, so we have less
                   4586:   work in the future.</p>
                   4587: </div>
1.148     asau     4588: <div class="sect2">
1.93      rillig   4589: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4590: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4591: <p>One important thing to mention is to pay attention that no RCS
                   4592:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4593:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4594:   <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   4595:   problems.</p>
1.87      wiz      4596: <p>For even more automation, we recommend using
1.110     hubertf  4597:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4598:   whole set of patches. You just have to backup files before you
                   4599:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4600:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4601:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4602:   you upgrade a package this way, you can easily compare the new
                   4603:   set of patches with the previously existing one with
1.130     wiz      4604:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4605:   are replaced by new files, so carefully check if you want to take all
                   4606:   the changes.</p>
1.87      wiz      4607: <p>When you have finished a package, remember to generate
1.110     hubertf  4608:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      4609:   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      4610: <p>When adding a patch that corrects a problem in the
                   4611:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4612:   man pages should go), send the patch as a bug report to the
                   4613:   maintainer.  This benefits non-pkgsrc users of the package,
                   4614:   and usually makes it possible to remove the patch in future
                   4615:   version.</p>
1.101     rillig   4616: <p>The file names of the patch files are usually of the form
1.130     wiz      4617:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4618:   Many packages still use the previous convention
                   4619:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4620:   but new patches should be of the form containing the filename.
                   4621:   <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
                   4622:   automatically.</p>
1.93      rillig   4623: </div>
1.148     asau     4624: <div class="sect2">
1.93      rillig   4625: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4626: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4627: <p>If you want to share patches between multiple packages
                   4628:   in pkgsrc, e.g. because they use the same distfiles, set
                   4629:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4630:   can be found, e.g.:</p>
                   4631: <pre class="programlisting">
1.100     rillig   4632: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4633: </pre>
1.75      rillig   4634: <p>Patch files that are distributed by the author or other
1.87      wiz      4635:     maintainers can be listed in
                   4636:     <code class="varname">PATCHFILES</code>.</p>
                   4637: <p>If it is desired to store any patches that should not be
                   4638:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4639:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4640:     directory tree there is expected to have the same
1.128     wiz      4641:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      4642:     patches are expected to be stored inside these dirs (also
                   4643:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4644:     example, if you want to keep a private patch for
                   4645:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4646:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4647:     files in the named directory are expected to be patch files,
                   4648:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4649:     applied</em></span>.</p>
1.93      rillig   4650: </div>
1.148     asau     4651: <div class="sect2">
1.85      jmmv     4652: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4653: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4654: <p>When fixing a portability issue in the code do not use
                   4655:       preprocessor magic to check for the current operating system nor
                   4656:       platform.  Doing so hurts portability to other platforms because
                   4657:       the OS-specific details are not abstracted appropriately.</p>
                   4658: <p>The general rule to follow is: instead of checking for the
                   4659:       operating system the application is being built on, check for the
                   4660:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4661:       instead of assuming that kqueue is available under NetBSD and
                   4662:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 4663:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4664:       yes, this generally involves patching the
1.110     hubertf  4665:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4666:       that prevents some OSes from adopting interfaces from other OSes
                   4667:       (e.g. Linux implementing kqueue), something that the above checks
                   4668:       cannot take into account.</p>
                   4669: <p>Of course, checking for features generally involves more
                   4670:       work on the developer's side, but the resulting changes are
1.87      wiz      4671:       cleaner and there are chances they will work on many other
1.85      jmmv     4672:       platforms.  Not to mention that there are higher chances of being
                   4673:       later integrated into the mainstream sources.  Remember:
                   4674:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4675: <p>Some typical examples:</p>
                   4676: <div class="table">
1.106     rillig   4677: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4678: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4679: <colgroup>
                   4680: <col>
                   4681: <col>
                   4682: <col>
                   4683: </colgroup>
                   4684: <thead><tr>
                   4685: <th>Where</th>
                   4686: <th>Incorrect</th>
                   4687: <th>Correct</th>
                   4688: </tr></thead>
                   4689: <tbody>
                   4690: <tr>
                   4691: <td>configure script</td>
                   4692: <td>
1.100     rillig   4693: <pre class="programlisting">
                   4694: case ${target_os} in
                   4695: netbsd*) have_kvm=yes ;;
                   4696: *)       have_kvm=no  ;;
                   4697: esac
                   4698: </pre>
1.85      jmmv     4699:              </td>
                   4700: <td>
1.100     rillig   4701: <pre class="programlisting">
                   4702: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4703: </pre>
1.85      jmmv     4704:              </td>
                   4705: </tr>
                   4706: <tr>
                   4707: <td>C source file</td>
                   4708: <td>
1.100     rillig   4709: <pre class="programlisting">
                   4710: #if defined(__NetBSD__)
                   4711: #  include &lt;sys/event.h&gt;
                   4712: #endif
                   4713: </pre>
1.85      jmmv     4714:              </td>
                   4715: <td>
1.100     rillig   4716: <pre class="programlisting">
                   4717: #if defined(HAVE_SYS_EVENT_H)
                   4718: #  include &lt;sys/event.h&gt;
                   4719: #endif
                   4720: </pre>
1.85      jmmv     4721:              </td>
                   4722: </tr>
                   4723: <tr>
                   4724: <td>C source file</td>
                   4725: <td>
1.100     rillig   4726: <pre class="programlisting">
                   4727: int
                   4728: monitor_file(...)
                   4729: {
                   4730: #if defined(__NetBSD__)
                   4731:         int fd = kqueue();
                   4732:         ...
                   4733: #else
                   4734:         ...
                   4735: #endif
                   4736: }
                   4737: </pre>
1.85      jmmv     4738:              </td>
                   4739: <td>
1.100     rillig   4740: <pre class="programlisting">
                   4741: int
                   4742: monitor_file(...)
                   4743: {
                   4744: #if defined(HAVE_KQUEUE)
                   4745:         int fd = kqueue();
                   4746:         ...
                   4747: #else
                   4748:        ...
                   4749: #endif
                   4750: }
                   4751: </pre>
1.85      jmmv     4752:              </td>
                   4753: </tr>
                   4754: </tbody>
1.91      rillig   4755: </table></div>
1.85      jmmv     4756: </div>
1.91      rillig   4757: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4758:       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
                   4759:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4760:       2</a>).  It summarizes multiple details on how to make
                   4761:       software easier to package; all the suggestions in it were
                   4762:       collected from our experience in pkgsrc work, so they are possibly
                   4763:       helpful when creating patches too.</p>
                   4764: </div>
1.148     asau     4765: <div class="sect2">
1.85      jmmv     4766: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4767: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4768: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4769:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4770:       improvements you do to a package to the mainstream developers.
                   4771:       This is the only way to get their attention on portability issues
                   4772:       and to ensure that future versions can be built out-of-the box on
                   4773:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4774:       the fixes straight from the packaged code.</p>
1.93      rillig   4775: <p>This generally involves cleaning up the patches
                   4776:       (because sometimes the patches that are
1.147     wiz      4777:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     4778:       appropriate trackers for the projects and working with the
                   4779:       mainstream authors to accept your changes.  It is
                   4780:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4781:       the packages in pkgsrc are kept simple and thus further changes
                   4782:       can be done without much hassle.</p>
1.130     wiz      4783: <p>When you have done this, please add a URL to the upstream
                   4784:       bug report to the patch comment.</p>
1.85      jmmv     4785: <p>Support the idea of free software!</p>
                   4786: </div>
1.75      rillig   4787: </div>
1.148     asau     4788: <div class="sect1">
1.75      rillig   4789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4790: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     4791: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4792: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4793: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4794:          any credits where they are due.  Please bear in mind that others do not
                   4795:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4796:          will read everything that you write here.</p></dd>
1.76      rillig   4797: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4798: <dd><p>This file governs the files that are installed on your
                   4799:          system: all the binaries, manual pages, etc. There are other
                   4800:          directives which may be entered in this file, to control the
                   4801:          creation and deletion of directories, and the location of
1.110     hubertf  4802:          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      4803:          information.</p></dd>
1.75      rillig   4804: </dl></div>
                   4805: </div>
1.148     asau     4806: <div class="sect1">
1.75      rillig   4807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4808: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     4809: <div class="sect2">
1.78      rillig   4810: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4811: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     4812: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4813: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      4814: <dd>
1.136     dholland 4815: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4816:            First time after package extraction and before files are
                   4817:            moved in place, the second time after the files to install
                   4818:            are moved in place. This can be used to do any custom
                   4819:            procedures not possible with @exec commands in
1.136     dholland 4820:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4821:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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>.
1.135     wiz      4822:            Please note that you can modify variables in it easily by using
                   4823:            <code class="varname">FILES_SUBST</code> in the package's
                   4824:            <code class="filename">Makefile</code>:</p>
                   4825: <pre class="programlisting">
                   4826: FILES_SUBST+=  SOMEVAR="somevalue"
                   4827: </pre>
                   4828: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4829:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4830:            performed for <code class="varname">PREFIX</code>,
                   4831:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4832:            <code class="varname">VARBASE</code>, and a few others, type
                   4833:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4834:            complete list.</p>
                   4835: </dd>
1.76      rillig   4836: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4837: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4838:            this script's responsibility to clean up any additional messy details
                   4839:            around the package's installation, since all pkg_delete knows is how to
                   4840:            delete the files created in the original distribution.
1.136     dholland 4841:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4842:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      4843:            The same methods to replace variables can be used as for
                   4844:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   4845: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4846: <dd>
                   4847: <p>This file is displayed after installation of the package.
1.87      wiz      4848:            Useful for things like legal notices on almost-free
                   4849:            software and hints for updating config files after
                   4850:            installing modules for apache, PHP etc.
                   4851:            Please note that you can modify variables in it easily by using
                   4852:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4853:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4854: <pre class="programlisting">
1.100     rillig   4855: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4856: </pre>
1.128     wiz      4857: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      4858:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4859:            performed for <code class="varname">PKGNAME</code>,
                   4860:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4861:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4862:            <code class="varname">X11BASE</code>,
                   4863:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4864:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4865:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4866: <p>You can display a different or additional files by
                   4867:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4868:            default is <code class="filename">MESSAGE</code>, if the file
                   4869:            exists.</p>
1.75      rillig   4870: </dd>
1.78      rillig   4871: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4872: <dd><p>FIXME: There is no documentation on the
                   4873:        alternatives framework.</p></dd>
                   4874: </dl></div>
                   4875: </div>
1.148     asau     4876: <div class="sect2">
1.78      rillig   4877: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4878: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     4879: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4880: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4881: <dd><p>This file contains arbitrary things that could
                   4882:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4883:        to be used by more than one package. This file should only be
                   4884:        used when the packages that will use the file are known in
                   4885:        advance. For other purposes it is often better to write a
                   4886:        <code class="filename">*.mk</code> file and give it a good name that
                   4887:        describes what it does.</p></dd>
                   4888: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4889: <dd><p>This file contains the dependency information
1.110     hubertf  4890:        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   4891: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4892: <dd><p>This file contains workarounds for compiler bugs
                   4893:        and similar things. It is included automatically by the pkgsrc
                   4894:        infrastructure, so you don't need an extra
                   4895:        <code class="literal">.include</code> line for
                   4896:        it.</p></dd>
                   4897: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4898: <dd><p>This file contains the code for the
1.110     hubertf  4899:        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   4900:        selected by the user. If a package has only one or two options,
                   4901:        it is equally acceptable to put the code directly into the
                   4902:        <code class="filename">Makefile</code>.</p></dd>
                   4903: </dl></div>
                   4904: </div>
1.148     asau     4905: <div class="sect2">
1.78      rillig   4906: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4907: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     4908: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4909: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4910: <dd><p>These files do not take place in the creation of
                   4911:        a package and thus are purely informative to the package
                   4912:        developer.</p></dd>
                   4913: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4914: <dd><p>This file contains things that need to be done
                   4915:        to make the package even
                   4916:        better.</p></dd>
1.75      rillig   4917: </dl></div>
                   4918: </div>
1.78      rillig   4919: </div>
1.148     asau     4920: <div class="sect1">
1.75      rillig   4921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4922: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4923: </h2></div></div></div>
1.110     hubertf  4924: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4925:     unpacked into the directory denoted by
                   4926:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4927:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4928:     directory is also used to keep various timestamp files.
                   4929:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4930:     The default is <code class="filename">${.CURDIR}/work</code>
                   4931:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4932:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4933: </div>
1.148     asau     4934: <div class="sect1">
1.75      rillig   4935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4936: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4937: </h2></div></div></div>
1.75      rillig   4938: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4939:     to configuration or building, you could place these files here and use
1.110     hubertf  4940:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      4941:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      4942:     this. Alternatively, you could simply diff the file against
                   4943:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4944:     the creation of this file.</p>
                   4945: <p>If you want to share files in this way with other
                   4946:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4947:     to the other package's <code class="filename">files</code> directory,
                   4948:     e.g.:</p>
                   4949: <pre class="programlisting">
1.100     rillig   4950: FILESDIR=${.CURDIR}/../xemacs/files
                   4951: </pre>
1.75      rillig   4952: </div>
                   4953: </div>
1.148     asau     4954: <div class="chapter">
1.75      rillig   4955: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4956: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4957: <div class="toc">
                   4958: <p><b>Table of Contents</b></p>
                   4959: <dl>
1.106     rillig   4960: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      4961: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4962: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4963: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4964: <dd><dl>
                   4965: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4966: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4967: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4968: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4969: <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   4970: </dl></dd>
                   4971: </dl>
                   4972: </div>
1.76      rillig   4973: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4974:   each of which forms a well-defined part of the pkgsrc system. Using
1.136     dholland 4975:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4976:   like pkgsrc requires some discipline to keep the code correct and
                   4977:   understandable.</p>
1.76      rillig   4978: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4979:   programming are variables (which are actually macros) and shell
                   4980:   commands. Among these shell commands may even be more complex ones
1.136     dholland 4981:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4982:   as intended it is necessary to quote all variables correctly when they
                   4983:   are used.</p>
                   4984: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4985:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4986:   with them.</p>
1.148     asau     4987: <div class="sect1">
1.75      rillig   4988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4989: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4990: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4991: <p>When you are creating a file as a
                   4992:     target of a rule, always write the data to a temporary file first
                   4993:     and finally rename that file. Otherwise there might occur an error
                   4994:     in the middle of generating the file, and when the user runs
1.136     dholland 4995:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><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   4996:     regenerated properly. Example:</p>
                   4997: <pre class="programlisting">
1.100     rillig   4998: wrong:
                   4999:         @echo "line 1" &gt; ${.TARGET}
                   5000:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5001:         @false
                   5002: 
                   5003: correct:
                   5004:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5005:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5006:         @false
                   5007:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   5008: </pre>
1.110     hubertf  5009: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   5010:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  5011:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   5012:     correct</strong></span> gives an error message twice, as expected.</p>
1.136     dholland 5013: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   5014:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5015:     happens when it is interrupted, for example by pressing
                   5016:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.136     dholland 5017:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   5018: </li></ul></div>
                   5019: </div>
1.148     asau     5020: <div class="sect1">
1.97      rillig   5021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5022: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   5023: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   5024:     can be processed using the five operators ``='', ``+='', ``?='',
1.136     dholland 5025:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   5026:     page.</p>
                   5027: <p>When a variable's value is parsed from a
1.76      rillig   5028:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   5029:     backslash character ``\'' are handled specially. If a backslash is
                   5030:     followed by a newline, any whitespace immediately in front of the
                   5031:     backslash, the backslash, the newline, and any whitespace
                   5032:     immediately behind the newline are replaced with a single space. A
                   5033:     backslash character and an immediately following hash character are
                   5034:     replaced with a single hash character. Otherwise, the backslash is
                   5035:     passed as is. In a variable assignment, any hash character that is
                   5036:     not preceded by a backslash starts a comment that continues upto the
                   5037:     end of the logical line.</p>
                   5038: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   5039:     the only way to create a variable consisting of a single backslash
                   5040:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   5041: <p>So far for defining variables. The other thing you can do with
                   5042:     variables is evaluating them. A variable is evaluated when it is
                   5043:     part of the right side of the ``:='' or the ``!='' operator, or
                   5044:     directly before executing a shell command which the variable is part
1.136     dholland 5045:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   5046:     is, variables are not evaluated until there's no other way. The
                   5047:     ``modifiers'' mentioned in the man page also evaluate the
                   5048:     variable.</p>
                   5049: <p>Some of the modifiers split the string into words and then
                   5050:     operate on the words, others operate on the string as a whole. When
                   5051:     a string is split into words, it is split as you would expect
1.136     dholland 5052:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.126     jakllsch 5053: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.75      rillig   5054:     loop does not follow the shell quoting rules but splits at sequences
                   5055:     of whitespace.</p>
                   5056: <p>There are several types of variables that should be handled
                   5057:     differently. Strings and two types of lists.</p>
1.148     asau     5058: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5059: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   5060:       characters. Nevertheless, you should restrict yourself to only
                   5061:       using printable characters. Examples are
                   5062:       <code class="varname">PREFIX</code> and
                   5063:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      5064: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   5065:       are never exported to any shell command. Their elements are
                   5066:       separated by whitespace. Therefore, the elements themselves cannot
                   5067:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  5068:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   5069:       Examples are <code class="varname">DEPENDS</code> and
                   5070:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      5071: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   5072:       may be exported to a shell command. Their elements can contain any
                   5073:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  5074:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   5075:       <code class="varname">DISTFILES</code> and
                   5076:       <code class="varname">MASTER_SITES</code>.</p></li>
                   5077: </ul></div>
1.148     asau     5078: <div class="sect2">
1.75      rillig   5079: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5080: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     5081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5082: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   5083:        are reserved for use by the pkgsrc infrastructure. They shall
                   5084:        not be used by package
1.76      rillig   5085:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      5086: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   5087:        lowercase variable names for the iteration
                   5088:        variables.</p></li>
1.128     wiz      5089: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   5090:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   5091:        <code class="varname">DISTFILES</code>.</p></li>
                   5092: </ul></div>
                   5093: </div>
                   5094: </div>
1.148     asau     5095: <div class="sect1">
1.75      rillig   5096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5097: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   5098: <p>This section presents you with some code snippets you should
                   5099:     use in your own code. If you don't find anything appropriate here,
                   5100:     you should test your code and add it here.</p>
1.148     asau     5101: <div class="sect2">
1.75      rillig   5102: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5103: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   5104: <pre class="programlisting">
1.100     rillig   5105: STRING=                 foo * bar `date`
                   5106: INT_LIST=               # empty
                   5107: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5108: EXT_LIST=               # empty
                   5109: ANOTHER_EXT_LIST=       a=b c=d
                   5110: 
                   5111: INT_LIST+=              ${STRING}               # 1
                   5112: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5113: EXT_LIST+=              ${STRING:Q}             # 3
                   5114: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    5115: </pre>
1.75      rillig   5116: <p>When you add a string to an external list (example 3), it
                   5117:       must be quoted. In all other cases, you must not add a quoting
                   5118:       level. You must not merge internal and external lists, unless you
                   5119:       are sure that all entries are correctly interpreted in both
                   5120:       lists.</p>
                   5121: </div>
1.148     asau     5122: <div class="sect2">
1.75      rillig   5123: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5124: <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   5125: <pre class="programlisting">
1.100     rillig   5126: EXT_LIST=       # empty
                   5127: .for i in ${INT_LIST}
                   5128: EXT_LIST+=      ${i:Q}""
                   5129: .endfor
1.1       grant    5130: </pre>
1.75      rillig   5131: <p>This code converts the internal list
                   5132:       <code class="varname">INT_LIST</code> into the external list
                   5133:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5134:       are unquoted they must be quoted here. The reason for appending
                   5135:       <code class="varname">""</code> is explained below.</p>
                   5136: </div>
1.148     asau     5137: <div class="sect2">
1.75      rillig   5138: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5139: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   5140: <p>Sometimes you may want to print an arbitrary string. There
                   5141:        are many ways to get it wrong and only few that can handle every
                   5142:        nastiness.</p>
1.75      rillig   5143: <pre class="programlisting">
1.100     rillig   5144: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5145: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5146: 
1.100     rillig   5147: all:
                   5148:         echo ${STRING}                  # 1
                   5149:         echo "${STRING}"                # 2
                   5150:         echo "${STRING:Q}"              # 3
                   5151:         echo ${STRING:Q}                # 4
                   5152:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5153:         printf "%s\\n" ${STRING:Q}""    # 6
                   5154:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5155: </pre>
1.75      rillig   5156: <p>Example 1 leads to a syntax error in the shell, as the
                   5157:       characters are just copied.</p>
                   5158: <p>Example 2 leads to a syntax error too, and if you leave out
                   5159:       the last " character from <code class="varname">${STRING}</code>,
1.136     dholland 5160:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   5161:       variable would be evaluated, too.</p>
                   5162: <p>Example 3 outputs each space character preceded by a
                   5163:       backslash (or not), depending on the implementation of the
1.136     dholland 5164:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   5165: <p>Example 4 handles correctly every string that does not start
                   5166:       with a dash. In that case, the result depends on the
1.136     dholland 5167:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   5168:       guarantee that your input does not start with a dash, this form is
                   5169:       appropriate.</p>
                   5170: <p>Example 5 handles even the case of a leading dash
                   5171:       correctly.</p>
1.79      rillig   5172: <p>Example 6 also works with every string and is the
                   5173:       light-weight solution, since it does not involve a pipe, which has
                   5174:       its own problems.</p>
1.75      rillig   5175: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5176:       because the quoting has already been done when adding elements to
                   5177:       the list.</p>
                   5178: <p>As internal lists shall not be passed to the shell, there is
                   5179:       no example for it.</p>
                   5180: </div>
1.148     asau     5181: <div class="sect2">
1.75      rillig   5182: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5183: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5184: <p>There are many possible sources of wrongly quoted variables.
                   5185:       This section lists some of the commonly known ones.</p>
1.148     asau     5186: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5187: <li class="listitem">
1.75      rillig   5188: <p>Whenever you use the value of a list, think
                   5189:        about what happens to leading or trailing whitespace. If the
                   5190:        list is a well-formed shell expression, you can apply the
                   5191:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5192:        whitespace from each word. The <code class="varname">:M</code> operator
                   5193:        first splits its argument according to the rules of the shell,
                   5194:        and then creates a new list consisting of all words that match
                   5195:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5196:        One class of situations where this is needed is when adding a
                   5197:        variable like <code class="varname">CPPFLAGS</code> to
                   5198:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5199:        invokes other configure scripts, it strips the leading and
                   5200:        trailing whitespace from the variable and then passes it to the
                   5201:        other configure scripts. But these configure scripts expect the
                   5202:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5203:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5204:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5205:        here is how we do it:</p>
                   5206: <pre class="programlisting">
1.100     rillig   5207: CPPFLAGS=               # empty
                   5208: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5209: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5210: 
                   5211: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5212: 
                   5213: all:
                   5214:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5215:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5216: </pre>
1.75      rillig   5217: </li>
1.128     wiz      5218: <li class="listitem"><p>The example above contains one bug: The
1.75      rillig   5219:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5220:        expression, but there is the C compiler after it, which also
                   5221:        expects a properly quoted string (this time in C syntax). The
                   5222:        version above is therefore only correct if
                   5223:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5224:        or double quotes. If you want to allow these, you have to add
                   5225:        another layer of quoting to each variable that is used as a C
                   5226:        string literal. You cannot use the <code class="varname">:Q</code>
                   5227:        operator for it, as this operator only works for the
                   5228:        shell.</p></li>
1.128     wiz      5229: <li class="listitem">
1.75      rillig   5230: <p>Whenever a variable can be empty, the
                   5231:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5232:        are two completely different cases which can be solved with the
                   5233:        same trick.</p>
                   5234: <pre class="programlisting">
1.100     rillig   5235: EMPTY=                  # empty
                   5236: empty_test:
                   5237:         for i in a ${EMPTY:Q} c; do \
                   5238:             echo "$$i"; \
                   5239:         done
                   5240: 
                   5241: for_test:
                   5242: .for i in a:\ a:\test.txt
                   5243:         echo ${i:Q}
                   5244:         echo "foo"
                   5245: .endfor
1.1       grant    5246: </pre>
1.75      rillig   5247: <p>The first example will only print two of the three lines
                   5248:        we might have expected. This is because
                   5249:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5250:        the shell cannot see. The workaround is to write
                   5251:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5252:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5253:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5254: <p>The second example will only print three lines instead of
                   5255:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5256:        This is because the backslash of the value
                   5257:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.136     dholland 5258:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5259:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   5260:        <code class="varname">${i:Q}""</code>.</p>
                   5261: </li>
                   5262: </ul></div>
                   5263: </div>
1.148     asau     5264: <div class="sect2">
1.75      rillig   5265: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5266: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5267: <p>The pkgsrc bmake program does not handle the following
                   5268:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5269:       contains a ``-'' character, one of the closing braces is included
                   5270:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5271: <pre class="programlisting">
1.100     rillig   5272: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5273: </pre>
1.75      rillig   5274: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5275:       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   5276:       <code class="varname">bug1</code>.</p>
                   5277: </div>
                   5278: </div>
                   5279: </div>
1.148     asau     5280: <div class="chapter">
1.75      rillig   5281: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5282: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5283: <div class="toc">
                   5284: <p><b>Table of Contents</b></p>
                   5285: <dl>
1.106     rillig   5286: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      5287: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5288: <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   5289: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5290: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      5291: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   5292: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5293: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5294: </dl>
                   5295: </div>
1.87      wiz      5296: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      5297:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      5298:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5299:   directory it's been installed in) plus some additional statements
1.136     dholland 5300:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      5301:   This chapter addresses some issues that need attention when
                   5302:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5303:   below!).</p>
1.148     asau     5304: <div class="sect1">
1.75      rillig   5305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5306: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5307: <p>Be sure to add a RCS ID line as the first thing in any
                   5308:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5309: <pre class="programlisting">
1.100     rillig   5310: @comment $NetBSD$
1.87      wiz      5311:     </pre>
1.75      rillig   5312: </div>
1.148     asau     5313: <div class="sect1">
1.75      rillig   5314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5315: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5316: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5317:     to output a PLIST that matches any new files since the package
1.110     hubertf  5318:     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      5319:     more information on this target.</p>
1.75      rillig   5320: </div>
1.148     asau     5321: <div class="sect1">
1.75      rillig   5322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5323: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5324: </h2></div></div></div>
1.87      wiz      5325: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5326:     <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
                   5327:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5328:     <code class="varname">@comment</code>s instead of real
                   5329:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5330:     specific directories and files, so that the results of that
                   5331:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5332:     lot</em></span> during the update of packages.</p>
                   5333: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5334:     of AWK patterns and actions that are used to filter the output of
                   5335:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5336:     scripting you like to it, but be careful with quoting.</p>
                   5337: <p>For example, to get all files inside the
                   5338:     <code class="filename">libdata/foo</code> directory removed from the
                   5339:     resulting PLIST:</p>
                   5340: <pre class="programlisting">
1.100     rillig   5341: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5342:     </pre>
                   5343: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5344:     to a specific (shared) directory converted to
                   5345:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5346: <pre class="programlisting">
1.100     rillig   5347: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5348:     </pre>
1.75      rillig   5349: </div>
1.148     asau     5350: <div class="sect1">
1.75      rillig   5351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5352: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5353: <p>A number of variables are substituted automatically in
                   5354:     PLISTs when a package is installed on a system. This includes the
                   5355:     following variables:</p>
1.148     asau     5356: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5357: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5358: <dd>
                   5359: <p>Some packages like emacs and perl embed information
1.87      wiz      5360:          about which architecture they were built on into the
                   5361:          pathnames where they install their files. To handle this
                   5362:          case, PLIST will be preprocessed before actually used, and
                   5363:          the symbol
1.128     wiz      5364:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  5365:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5366:          same is done if the string
                   5367:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5368:          PLIST somewhere - use this on packages that have GNU
                   5369:          autoconf-created configure scripts.</p>
1.148     asau     5370: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   5371: <h3 class="title">Legacy note</h3>
                   5372: <p>There used to be a symbol
1.128     wiz      5373:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  5374:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5375:            -m</strong></span>, but that's no longer supported and has
                   5376:            been removed.</p>
1.75      rillig   5377: </div>
                   5378: </dd>
                   5379: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5380: <dd>
                   5381: <p>Some packages want to embed the OS name and version
1.87      wiz      5382:          into some paths.  To do this, use these variables in the
                   5383:          <code class="filename">PLIST</code>:
                   5384:          </p>
1.148     asau     5385: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5386: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</span></p></li>
                   5387: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">&#8220;<span class="quote">solaris</span>&#8221;</span>)</p></li>
                   5388: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
1.75      rillig   5389: </ul></div>
                   5390: </dd>
                   5391: </dl></div>
1.87      wiz      5392: <p>For a complete list of values which are replaced by
                   5393:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5394:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5395: <p>If you want to change other variables not listed above, you
                   5396:     can add variables and their expansions to this variable in the
1.110     hubertf  5397:     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   5398: <pre class="programlisting">
1.100     rillig   5399: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5400:     </pre>
1.128     wiz      5401: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      5402:     in the <code class="filename">PLIST</code> with
1.128     wiz      5403:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      5404: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   5405:     the common case of conditionally including some
                   5406:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5407:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      5408:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5409:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      5410:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   5411:     in the <code class="filename">PLIST</code> with either
1.128     wiz      5412:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5413:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   5414:     For example, in <code class="filename">Makefile</code>:</p>
                   5415: <pre class="programlisting">
                   5416: PLIST_VARS+=   foo
                   5417: .if <em class="replaceable"><code>condition</code></em>
                   5418: PLIST.foo=     yes
                   5419: .else
                   5420:     </pre>
                   5421: <p>And then in <code class="filename">PLIST</code>:</p>
                   5422: <pre class="programlisting">
                   5423: @comment $NetBSD$
                   5424: bin/bar
                   5425: man/man1/bar.1
                   5426: ${PLIST.foo}bin/foo
                   5427: ${PLIST.foo}man/man1/foo.1
                   5428: ${PLIST.foo}share/bar/foo.data
                   5429: ${PLIST.foo}@dirrm share/bar
                   5430:     </pre>
1.75      rillig   5431: </div>
1.148     asau     5432: <div class="sect1">
1.75      rillig   5433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5434: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5435: <p>Man pages should be installed in compressed form if
1.87      wiz      5436:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5437:     and uncompressed otherwise. To handle this in the
1.128     wiz      5438:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      5439:     appended/removed automatically for man pages according to
                   5440:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5441:     or not, see above for details. This modification of the
                   5442:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5443:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5444: </div>
1.148     asau     5445: <div class="sect1">
1.75      rillig   5446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5447: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5448: </h2></div></div></div>
1.76      rillig   5449: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5450:     in generating the binary package, set the variable
                   5451:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.136     dholland 5452:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5453:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5454:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5455: </div>
1.148     asau     5456: <div class="sect1">
1.75      rillig   5457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5458: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5459: <p>Some packages decide to install a different set of files based on
1.87      wiz      5460:     the operating system being used. These differences can be
                   5461:     automatically handled by using the following files:</p>
1.148     asau     5462: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5463: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5464: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5465: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5466: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5467: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5468: </ul></div>
                   5469: </div>
1.148     asau     5470: <div class="sect1">
1.75      rillig   5471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5472: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.128     wiz      5473: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      5474:     multiple (and unrelated) packages install files.  These
1.125     wiz      5475:     directories were problematic because you had to add special
                   5476:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      5477:     centralized package handle them.</p>
1.125     wiz      5478: <p>In pkgsrc, it is now easy: Each package should create
                   5479:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5480:     will remove any directories left empty after uninstalling a
                   5481:     package.</p>
                   5482: <p>If a package needs an empty directory to work, create
                   5483:     the directory during installation as usual, and also add an
                   5484:     entry to the PLIST:
                   5485:     </p>
1.87      wiz      5486: <pre class="programlisting">
1.125     wiz      5487: @pkgdir path/to/empty/directory
1.87      wiz      5488:     </pre>
1.125     wiz      5489: <p>
                   5490:     </p>
1.75      rillig   5491: </div>
                   5492: </div>
1.148     asau     5493: <div class="chapter">
1.75      rillig   5494: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5495: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5496: <div class="toc">
                   5497: <p><b>Table of Contents</b></p>
                   5498: <dl>
1.106     rillig   5499: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      5500: <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   5501: <dd><dl>
1.106     rillig   5502: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      5503: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5504:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5505:       and
                   5506:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5507:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5508: </dl></dd>
1.128     wiz      5509: <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   5510: <dd><dl>
1.128     wiz      5511: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.106     rillig   5512: <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   5513: </dl></dd>
                   5514: </dl>
                   5515: </div>
                   5516: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5517:   are seen by a package's configure and build processes.  This is implemented
                   5518:   in a two step process:</p>
1.128     wiz      5519: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5520: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      5521:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5522:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      5523: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5524:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5525:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5526:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5527:       native compiler on some operating systems look like GCC, so that
                   5528:       packages that expect GCC won't require modifications to build with
                   5529:       those native compilers.</p></li>
1.75      rillig   5530: </ol></div>
                   5531: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5532:   package may be built consistently despite what other software may be
                   5533:   installed. Please note that the normal system header and library paths,
                   5534:   e.g. <code class="filename">/usr/include</code>,
                   5535:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5536:   designed to insulate the package build from non-system-supplied
                   5537:   software.</p>
1.148     asau     5538: <div class="sect1">
1.75      rillig   5539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5540: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5541: <p>The process of converting packages to use the buildlink3
1.128     wiz      5542:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      5543:     The things to keep in mind are:</p>
1.128     wiz      5544: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5545: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      5546:        instead of the actual toolchain.  Some packages are tricky,
                   5547:        and the only way to know for sure is the check
                   5548:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5549:        wrappers are being invoked.</p></li>
1.128     wiz      5550: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      5551:        the package Makefile, e.g. Java VMs, standalone shells,
                   5552:        etc., because the code to symlink files into
                   5553:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      5554:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.87      wiz      5555:        </p></li>
1.128     wiz      5556: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      5557:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5558:        package's Makefile are added as dependencies for that package.
                   5559:        </p></li>
1.75      rillig   5560: </ol></div>
1.87      wiz      5561: <p>If a dependency on a particular package is required for its libraries and
                   5562:     headers, then we replace:</p>
1.75      rillig   5563: <pre class="programlisting">
1.100     rillig   5564: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5565: </pre>
1.75      rillig   5566: <p>with</p>
                   5567: <pre class="programlisting">
1.100     rillig   5568: .include "../../category/foo/buildlink3.mk"
                   5569: </pre>
1.75      rillig   5570: <p>The buildlink3.mk files usually define the required dependencies.
                   5571:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5572:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5573: <pre class="programlisting">
1.100     rillig   5574: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5575: .include "../../category/foo/buildlink3.mk"
                   5576: </pre>
1.76      rillig   5577: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5578:     files in <code class="filename">pkgsrc/mk</code>
                   5579:     that handle special package issues:</p>
1.148     asau     5580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5581: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5582:        the native or a pkgsrc Berkeley DB implementation based on
                   5583:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5584:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      5585: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5586:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5587:        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.128     wiz      5588: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5589:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5590:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5591:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      5592: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      5593:        system-provided Motif installation or adds a dependency on
1.151     obache   5594:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</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.128     wiz      5595:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.151     obache   5596:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   5597:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.88      wiz      5598:        which Motif version will be used.</p></li>
1.161     ryoon    5599: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      5600:        system-provided GNU readline or editline (libedit) installation,
1.161     ryoon    5601:        or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   5602:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
                   5603:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   5604:        If your package really needs GNU readline library, its Makefile
                   5605:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   5606:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      5607: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5608:        variables that may be used by packages that use the
                   5609:        Open Sound System (OSS) API.</p></li>
1.128     wiz      5610: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      5611:        any of the Postgres versions in the variable
                   5612:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   5613:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      5614:        the file for more information.</p></li>
1.128     wiz      5615: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5616:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5617:        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.128     wiz      5618: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5619:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5620:        library.</p></li>
1.75      rillig   5621: </ul></div>
1.76      rillig   5622: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5623:     files provide a more complete
                   5624:     description of how to use them properly.</p>
1.75      rillig   5625: </div>
1.148     asau     5626: <div class="sect1">
1.75      rillig   5627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5628: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5629: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5630:     included by Makefiles to indicate the need to compile and link
                   5631:     against header files and libraries provided by the package.  A
                   5632:     <code class="filename">buildlink3.mk</code> file should always provide
                   5633:     enough information to add the correct type of dependency
                   5634:     relationship and include any other
                   5635:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5636:     headers and libraries that it needs in turn.</p>
                   5637: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5638:     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      5639:     package is highly recommended.  For most packages, the following
                   5640:     command will generate a good starting point for
                   5641:     <code class="filename">buildlink3.mk</code> files:</p>
                   5642: <pre class="screen">
                   5643: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5644: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5645:     </pre>
1.148     asau     5646: <div class="sect2">
1.75      rillig   5647: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5648: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5649: <p>The following real-life example
1.87      wiz      5650:       <code class="filename">buildlink3.mk</code> is taken
                   5651:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5652: <pre class="programlisting">
1.120     snj      5653: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    5654: 
1.120     snj      5655: BUILDLINK_TREE+=       tiff
1.1       grant    5656: 
1.120     snj      5657: .if !defined(TIFF_BUILDLINK3_MK)
                   5658: TIFF_BUILDLINK3_MK:=
1.87      wiz      5659: 
1.120     snj      5660: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5661: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5662: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.87      wiz      5663: 
1.100     rillig   5664: .include "../../devel/zlib/buildlink3.mk"
                   5665: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      5666: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      5667: 
1.120     snj      5668: BUILDLINK_TREE+=       -tiff
1.100     rillig   5669: </pre>
1.87      wiz      5670: <p>The header and footer manipulate
1.120     snj      5671:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      5672:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      5673:       the dependency tree.</p>
                   5674: <p>The main section is protected from multiple inclusion
1.87      wiz      5675:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5676:       added.  Several important variables are set in the section:</p>
1.148     asau     5677: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5678: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5679:          is the actual dependency recorded in the installed
                   5680:          package; this should always be set using
1.110     hubertf  5681:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5682:          we're appending to any pre-existing list of values.  This
                   5683:          variable should be set to the first version of the
1.133     wiz      5684:          package that had an backwards-incompatible API change.
1.87      wiz      5685:          </p></li>
1.128     wiz      5686: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5687:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5688:          pkgsrc directory.</p></li>
1.128     wiz      5689: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5690:          (not shown above) controls whether we use
                   5691:          <code class="varname">BUILD_DEPENDS</code> or
                   5692:          <code class="varname">DEPENDS</code> to add the dependency on
                   5693:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5694:          selected by setting
                   5695:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5696:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      5697:          used.</p></li>
1.128     wiz      5698: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5699:            and
                   5700:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5701:            (not shown above) are lists of subdirectories of
1.76      rillig   5702:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5703:            to add to the header and library search paths.  These
1.128     wiz      5704:            default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
1.87      wiz      5705:          respectively.</p></li>
1.128     wiz      5706: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5707:            (not shown above) is the list of preprocessor flags to add
                   5708:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      5709:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   5710:            should be avoided and instead be handled using
                   5711:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5712:          above.</p></li>
1.75      rillig   5713: </ul></div>
1.87      wiz      5714: <p>The following variables are all optionally defined within
                   5715:       this second section (protected against multiple inclusion) and
                   5716:       control which package files are symlinked into
                   5717:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5718:       transformed during the symlinking:</p>
1.148     asau     5719: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5720: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5721:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5722:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5723:            to be symlinked into
1.76      rillig   5724:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5725:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      5726: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5727:            (not shown above) is a shell pipeline that
                   5728:            outputs to stdout a list of files relative to
                   5729:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5730:            The resulting files are to be symlinked
                   5731:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5732:            this takes the <code class="filename">+CONTENTS</code> of a
                   5733:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5734:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      5735: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5736:            (not shown above) is a filter command that filters
1.76      rillig   5737:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5738:            relative to
1.76      rillig   5739:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5740:            on stdout.  By default for overwrite packages,
                   5741:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5742:            outputs the contents of the <code class="filename">include</code>
                   5743:            and <code class="filename">lib</code> directories in the package
                   5744:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5745:            it outputs any libtool archives in
1.87      wiz      5746:            <code class="filename">lib</code> directories.</p></li>
1.128     wiz      5747: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5748:            (not shown above) is a list of sed arguments used to
                   5749:            transform the name of the source filename into a
1.110     hubertf  5750:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5751:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5752: </ul></div>
1.120     snj      5753: <p>This section can additionally include any
1.87      wiz      5754:       <code class="filename">buildlink3.mk</code> needed for
                   5755:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5756:       Including these <code class="filename">buildlink3.mk</code> files
                   5757:       means that the headers and libraries for these
                   5758:       dependencies are also symlinked into
                   5759:       <code class="filename">${BUILDLINK_DIR}</code>
                   5760:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5761:       <code class="filename">buildlink3.mk</code>
1.120     snj      5762:       file is included. Dependencies are only added for directly
                   5763:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      5764: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   5765:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      5766:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      5767:       header files are automatically exposed when the package is
                   5768:       use.</p>
                   5769: <p>In particular, if only an executable
                   5770:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   5771:       library does not need to be propagated in the
                   5772:       <code class="filename">buildlink3.mk</code> file.</p>
                   5773: <p>The following steps should help you decide if a
                   5774:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   5775:       </p>
                   5776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5777: <li class="listitem"><p>Look at the installed header files: What
                   5778:        headers do they include? The packages providing these files
                   5779:        must be buildlinked.</p></li>
1.155     wiz      5780: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   5781:        libraries and look against what other libraries they link.
                   5782:        Some of the packages providing these probably need to be
                   5783:        buildlinked; however, it's not automatic, since e.g. GTK on
                   5784:        some systems pulls in the X libraries, so they will show up in
                   5785:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      5786:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      5787:        used as a hint.</p></li>
1.153     wiz      5788: </ul></div>
                   5789: <p>
                   5790:       </p>
1.75      rillig   5791: </div>
1.148     asau     5792: <div class="sect2">
1.75      rillig   5793: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      5794: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      5795:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5796:       and
                   5797:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5798:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5799: <p>These two variables differ in that one describes source
                   5800:       compatibility (API) and the other binary compatibility (ABI).
                   5801:       The difference is that a change in the API breaks compilation of
                   5802:       programs while changes in the ABI stop compiled programs from
                   5803:       running.</p>
                   5804: <p>Changes to the
1.134     wiz      5805:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5806:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5807:       very rarely. One possible reason is that all packages depending
                   5808:       on this already need a newer version. In case it is bumped see
                   5809:       the description below.</p>
                   5810: <p>The most common example of an ABI change is that the major
                   5811:       version of a shared library is increased. In this case,
                   5812:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5813:       should be adjusted to require at least the new package version.
                   5814:       Then the packages that depend on this package need their
                   5815:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5816:       <code class="filename">buildlink3.mk</code> files, their
                   5817:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5818:       adjusted, too. This is needed so pkgsrc will require the correct
                   5819:       package dependency and not settle for an older one when building
                   5820:       the source.</p>
1.110     hubertf  5821: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.133     wiz      5822:       more information about dependencies on other packages,
                   5823:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5824:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5825: <p>Please take careful consideration before adjusting
                   5826:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5827:       or
                   5828:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5829:       as we don't want to cause unneeded package deletions and
                   5830:       rebuilds.  In many cases, new versions of packages work just
                   5831:       fine with older dependencies.</p>
                   5832: <p>Also it is not needed to set
1.133     wiz      5833:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5834:       when it is identical to
1.87      wiz      5835:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5836: </div>
                   5837: </div>
1.148     asau     5838: <div class="sect1">
1.75      rillig   5839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5840: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5841: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5842:       coincide with headers and libraries present in the base system.
1.76      rillig   5843:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5844:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5845:       file that includes the necessary checks to decide whether using
                   5846:       the built-in software or the pkgsrc software is
1.87      wiz      5847:     appropriate.</p>
                   5848: <p>The only requirements of a builtin.mk file for
                   5849:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      5850: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5851: <li class="listitem"><p>It should set
1.87      wiz      5852:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5853:        to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
1.87      wiz      5854:        after it is included.</p></li>
1.128     wiz      5855: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      5856:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5857:        which is already set before the
                   5858:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      5859: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      5860:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5861:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5862: </ol></div>
1.148     asau     5863: <div class="sect2">
1.75      rillig   5864: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5865: <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   5866: <p>The following is the recommended template for builtin.mk
1.87      wiz      5867:       files:</p>
1.75      rillig   5868: <pre class="programlisting">
1.100     rillig   5869: .if !defined(IS_BUILTIN.foo)
                   5870: #
                   5871: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5872: # genuinely exists in the system or not.
                   5873: #
                   5874: IS_BUILTIN.foo?=        no
                   5875: 
                   5876: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5877: # version can be determined.
                   5878: #
                   5879: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5880: BUILTIN_PKG.foo?=       foo-1.0
                   5881: .  endif
                   5882: .endif  # IS_BUILTIN.foo
                   5883: 
                   5884: .if !defined(USE_BUILTIN.foo)
                   5885: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5886: .  if defined(BUILTIN_PKG.foo)
                   5887: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5888: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5889: USE_BUILTIN.foo!=                                                       \
                   5890:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5891:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5892: .      endif
                   5893: .    endfor
                   5894: .  endif
                   5895: .endif  # USE_BUILTIN.foo
                   5896: 
                   5897: CHECK_BUILTIN.foo?=     no
                   5898: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5899: #
                   5900: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5901: # "yes" or "no".
                   5902: #
                   5903: .endif  # CHECK_BUILTIN.foo
                   5904: </pre>
1.87      wiz      5905: <p>The first section sets
                   5906:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5907:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5908:       in the base system.  This should not be a base system software
                   5909:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      5910:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      5911:       included as part of the base system.  This variable is only
                   5912:       used internally within the <code class="filename">builtin.mk</code>
                   5913:       file.</p>
                   5914: <p>The second section sets
                   5915:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5916:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5917:       system if it exists (if
                   5918:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5919:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      5920:       within the <code class="filename">builtin.mk</code> file.</p>
                   5921: <p>The third section sets
                   5922:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5923:       and is <span class="emphasis"><em>required</em></span> in all
                   5924:       <code class="filename">builtin.mk</code> files.  The code in this
                   5925:       section must make the determination whether the built-in
                   5926:       software is adequate to satisfy the dependencies listed in
                   5927:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5928:       This is typically done by comparing
                   5929:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5930:       against each of the dependencies in
                   5931:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5932:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5933:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5934:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5935:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5936:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      5937:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5938:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      5939:       that the built-in version of the software is similar enough to
                   5940:       be used as a replacement.</p>
                   5941: <p>The last section is guarded by
                   5942:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5943:       and includes code that uses the value of
                   5944:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5945:       set in the previous section.  This typically includes, e.g.,
                   5946:       adding additional dependency restrictions and listing additional
                   5947:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5948:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5949: </div>
1.148     asau     5950: <div class="sect2">
1.75      rillig   5951: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5952: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5953: <p>When building packages, it's possible to choose whether to set
                   5954:        a global preference for using either the built-in (native)
                   5955:        version or the pkgsrc version of software to satisfy a
                   5956:        dependency.  This is controlled by setting
                   5957:        <code class="varname">PREFER_PKGSRC</code> and
                   5958:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      5959:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
1.87      wiz      5960:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5961:        use the pkgsrc versions of software, while
                   5962:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5963:        built-in versions.  Preferences are determined by the most
                   5964:        specific instance of the package in either
                   5965:        <code class="varname">PREFER_PKGSRC</code> or
                   5966:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5967:        in neither or in both variables, then
                   5968:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5969:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5970:        using pkgsrc versions of software for all but the most basic
                   5971:       bits on a NetBSD system, you can set:</p>
                   5972: <pre class="programlisting">
1.100     rillig   5973: PREFER_PKGSRC=  yes
                   5974: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5975: </pre>
1.87      wiz      5976: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5977:       <code class="filename">builtin.mk</code>
                   5978:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5979:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5980: </div>
                   5981: </div>
                   5982: </div>
1.148     asau     5983: <div class="chapter">
1.75      rillig   5984: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5985: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5986: <div class="toc">
                   5987: <p><b>Table of Contents</b></p>
                   5988: <dl>
1.106     rillig   5989: <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   5990: <dd><dl>
1.106     rillig   5991: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5992: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5993: </dl></dd>
1.106     rillig   5994: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5995: <dd><dl>
1.128     wiz      5996: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   5997: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5998: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5999: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   6000: </dl></dd>
                   6001: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   6002: <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>
                   6003: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   6004: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   6005: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6006: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   6007: <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   6008: </dl>
                   6009: </div>
                   6010: <p>This chapter describes the framework known as
                   6011: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     6012: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6013: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   6014:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      6015: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   6016:     provided that packages are correctly designed.</p></li>
1.128     wiz      6017: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6018: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6019: <li class="listitem"><p>Registration of system shells.</p></li>
                   6020: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   6021: </ul></div>
                   6022: <p>The following sections inspect each of the above points in detail.</p>
                   6023: <p>You may be thinking that many of the things described here could be
                   6024: easily done with simple code in the package's post-installation target
                   6025: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6026: as the code in them is only executed when building from source.  Machines
                   6027: using binary packages could not benefit from it at all (as the code itself
                   6028: could be unavailable).  Therefore, the only way to achieve any of the items
                   6029: described above is by means of the installation scripts, which are
                   6030: automatically generated by pkginstall.</p>
1.148     asau     6031: <div class="sect1">
1.75      rillig   6032: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6033: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   6034: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   6035: of files and directories that belong to a package.  The names used in it
1.76      rillig   6036: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   6037: which means that it cannot register files outside this directory (absolute
                   6038: path names are not allowed).  Despite this restriction, some packages need
                   6039: to install files outside this location; e.g., under
1.76      rillig   6040: <code class="filename">${VARBASE}</code> or
1.87      wiz      6041: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6042: is to create such files during installation time by using
                   6043: installation scripts.</p>
                   6044: <p>The generic installation scripts are shell scripts that can
                   6045: contain arbitrary code.  The list of scripts to execute is taken from
                   6046: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6047: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6048: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6049: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6050: commands, so they have the potential to create and manage files
                   6051: anywhere in the file system.</p>
                   6052: <p>Using these general installation files is not recommended, but
                   6053: may be needed in some special cases.  One reason for avoiding them is
                   6054: that the user has to trust the packager that there is no unwanted or
                   6055: simply erroneous code included in the installation script. Also,
                   6056: previously there were many similar scripts for the same functionality,
                   6057: and fixing a common error involved finding and changing all of
                   6058: them.</p>
                   6059: <p>The pkginstall framework offers another, standardized way.  It
                   6060: provides generic scripts to abstract the manipulation of such files
                   6061: and directories based on variables set in the package's
                   6062: <code class="filename">Makefile</code>.  The rest of this section describes
                   6063: these variables.</p>
1.148     asau     6064: <div class="sect2">
1.75      rillig   6065: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6066: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   6067: <p>The following variables can be set to request the creation of
                   6068: directories anywhere in the file system:</p>
1.148     asau     6069: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6070: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   6071:     contain a list of directories that should be created and should attempt
                   6072:     to be destroyed by the installation scripts.  The difference between
                   6073:     the two is that the latter prompts the administrator to remove any
                   6074:     directories that may be left after deinstallation (because they were
                   6075:     not empty), while the former does not.</p></li>
1.128     wiz      6076: <li class="listitem">
1.75      rillig   6077: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6078:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6079:     which directories should be created and should attempt to be destroyed
                   6080:     by the installation scripts.  Each tuple holds the following values,
                   6081:     separated by spaces: the directory name, its owner, its group and its
                   6082:     numerical mode.  For example:</p>
                   6083: <pre class="programlisting">
1.100     rillig   6084: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6085: </pre>
1.75      rillig   6086: <p>The difference between the two is exactly the same as their
                   6087:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6088: </li>
                   6089: </ul></div>
                   6090: </div>
1.148     asau     6091: <div class="sect2">
1.75      rillig   6092: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6093: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   6094: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   6095: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   6096: To overcome this problem, the only solution is to extract the file in the
                   6097: known place (i.e., inside the installation prefix) and copy it to the
                   6098: appropriate location during installation (done by the installation scripts
                   6099: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6100: file</em></span> in the following paragraphs, which describe the variables
                   6101: that can be used to automatically and consistently handle files outside the
                   6102: installation prefix:</p>
1.148     asau     6103: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6104: <li class="listitem">
1.75      rillig   6105: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      6106:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   6107:     During installation time, the master file is copied to the target one
                   6108:     if and only if the latter does not exist.  Upon deinstallation, the
                   6109:     target file is removed provided that it was not modified by the
                   6110:     installation.</p>
                   6111: <p>The difference between the two is that the latter prompts the
                   6112:     administrator to remove any files that may be left after
                   6113:     deinstallation (because they were not empty), while the former does
                   6114:     not.</p>
                   6115: </li>
1.128     wiz      6116: <li class="listitem">
1.75      rillig   6117: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      6118:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   6119:     files as well as their target locations.  For each of them, it also
                   6120:     specifies their owner, their group and their numeric permissions, in
                   6121:     this order.  For example:</p>
                   6122: <pre class="programlisting">
1.137     wiz      6123: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6124: </pre>
1.75      rillig   6125: <p>The difference between the two is exactly the same as their
                   6126:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6127: </li>
                   6128: </ul></div>
                   6129: </div>
                   6130: </div>
1.148     asau     6131: <div class="sect1">
1.75      rillig   6132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6133: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   6134: <p>Configuration files are special in the sense that they are installed
                   6135: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6136: need special treatment during installation (most of which is automated by
                   6137: pkginstall).  The main concept you must bear in mind is that files marked
                   6138: as configuration files are automatically copied to the right place (somewhere
                   6139: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6140: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6141: be removed if they have local modifications.  This ensures that
                   6142: administrators never lose any custom changes they may have made.</p>
1.148     asau     6143: <div class="sect2">
1.75      rillig   6144: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6145: <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   6146: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6147: specifies where configuration files shall be installed.  Its contents are
                   6148: set based upon the following variables:</p>
1.148     asau     6149: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6150: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   6151:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   6152:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   6153:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   6154:     Packages must not use it directly.</p></li>
1.128     wiz      6155: <li class="listitem">
1.75      rillig   6156: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6157:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6158:     for the package being built shall be installed.  The definition of this
                   6159:     variable only makes sense in the package's
1.76      rillig   6160:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   6161: <p>As an example, consider the Apache package,
1.91      rillig   6162:     <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   6163:     configuration files under the
1.76      rillig   6164:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6165:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6166:     Makefile.</p>
                   6167: </li>
1.128     wiz      6168: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   6169:     variable that holds this package's configuration directory (if
                   6170:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6171:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6172:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      6173: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   6174:     directory where the configuration files for the package identified by
                   6175:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6176: </ul></div>
                   6177: <p>Based on the above variables, pkginstall determines the value of
                   6178: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6179: variable that can be used within a package to refer to its configuration
                   6180: directory.  The algorithm used to set its value is basically the
                   6181: following:</p>
1.128     wiz      6182: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6183: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   6184:     its value is used.</p></li>
1.128     wiz      6185: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   6186:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6187:     <code class="filename">Makefile</code>, the resulting value is
                   6188:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      6189: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   6190:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6191: </ol></div>
1.76      rillig   6192: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  6193: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
                   6194: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6195: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   6196: </div>
1.148     asau     6197: <div class="sect2">
1.75      rillig   6198: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6199: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6200: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6201: known place, you need to teach each package where it shall install its
                   6202: files.  In some cases you will have to patch the package Makefiles to
                   6203: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6204: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6205: generated files:</p>
                   6206: <pre class="programlisting">
1.100     rillig   6207: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6208: </pre>
1.75      rillig   6209: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6210: for</em></span> its configuration files, not where they will be originally
                   6211: installed (although the difference is never explicit,
                   6212: unfortunately).</p>
                   6213: </div>
1.148     asau     6214: <div class="sect2">
1.75      rillig   6215: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6216: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6217: <p>As said before, pkginstall automatically handles configuration files.
                   6218: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6219: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6220: directly</strong></span>.  Bad news is that many software installation scripts
                   6221: will, out of the box, mess with the contents of that directory.  So what is
                   6222: the correct procedure to fix this issue?</p>
                   6223: <p>You must teach the package (usually by manually patching it) to
                   6224: install any configuration files under the examples hierarchy,
1.76      rillig   6225: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6226: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6227: has the original copies available.</p>
                   6228: <p>Once the required configuration files are in place (i.e., under the
                   6229: examples hierarchy), the pkginstall framework can use them as master copies
                   6230: during the package installation to update what is in
1.76      rillig   6231: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6232: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  6233: 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   6234: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6235: <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   6236: <pre class="programlisting">
1.100     rillig   6237: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6238: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6239: </pre>
1.75      rillig   6240: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6241: package and has no meaning outside it.</p>
                   6242: </div>
1.148     asau     6243: <div class="sect2">
1.75      rillig   6244: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6245: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6246: <p>The automatic copying of config files can be toggled by setting the
                   6247: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6248: installation.</p>
                   6249: </div>
                   6250: </div>
1.148     asau     6251: <div class="sect1">
1.75      rillig   6252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6253: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   6254: <p>System startup scripts are special files because they must be
                   6255: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  6256: 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   6257: can be used.  However, pkginstall provides a special mechanism to handle
                   6258: these files.</p>
                   6259: <p>In order to provide system startup scripts, the package has
                   6260: to:</p>
1.128     wiz      6261: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6262: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6263:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6264:     <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   6265:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      6266: <li class="listitem">
1.75      rillig   6267: <p>Tell pkginstall to handle it, appending the name of the script,
                   6268:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6269:     Continuing the previous example:</p>
                   6270: <pre class="programlisting">
1.100     rillig   6271: RCD_SCRIPTS+=   cupsd
1.1       grant    6272: </pre>
1.75      rillig   6273: </li>
                   6274: </ol></div>
                   6275: <p>Once this is done, pkginstall will do the following steps for each
                   6276: script in an automated fashion:</p>
1.128     wiz      6277: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6278: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   6279:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6280:     variable.</p></li>
1.128     wiz      6281: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   6282:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6283:     that this master file must be explicitly registered in the
1.76      rillig   6284:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      6285: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   6286:     from the examples hierarchy into the system-wide startup scripts
                   6287:     directory.</p></li>
                   6288: </ol></div>
1.148     asau     6289: <div class="sect2">
1.75      rillig   6290: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6291: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6292: <p>The automatic copying of config files can be toggled by setting the
                   6293: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6294: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6295: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6296: matter what the value of this variable is.</p>
                   6297: </div>
                   6298: </div>
1.148     asau     6299: <div class="sect1">
1.75      rillig   6300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6301: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6302: <p>If a package needs to create special users and/or groups during
                   6303: installation, it can do so by using the pkginstall framework.</p>
                   6304: <p>Users can be created by adding entries to the
                   6305: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6306: syntax:</p>
                   6307: <pre class="programlisting">
1.100     rillig   6308: user:group
1.1       grant    6309: </pre>
1.87      wiz      6310: <p>Further specification of user details may be done by setting
                   6311: per-user variables.
                   6312: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6313: numeric UID for the user.
                   6314: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6315: user's description or comment.
                   6316: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6317: user's home directory, and defaults to
                   6318: <code class="filename">/nonexistent</code> if not specified.
                   6319: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6320: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6321: not specified.</p>
1.75      rillig   6322: <p>Similarly, groups can be created by adding entries to the
                   6323: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6324: <pre class="programlisting">
1.100     rillig   6325: group
1.1       grant    6326: </pre>
1.93      rillig   6327: <p>The numeric GID of the group may be set by defining
1.75      rillig   6328: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6329: <p>If a package needs to create the users and groups at an earlier
                   6330: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6331: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6332: indicate the phase before which the users and groups are created.  In
                   6333: this case, the numeric UIDs and GIDs of the created users and groups
                   6334: are automatically hardcoded into the final installation scripts.</p>
                   6335: </div>
1.148     asau     6336: <div class="sect1">
1.75      rillig   6337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6338: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6339: <p>Packages that install system shells should register them in the shell
1.76      rillig   6340: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6341: administrator.  This must be done from the installation scripts to keep
                   6342: binary packages working on any system.  pkginstall provides an easy way to
                   6343: accomplish this task.</p>
                   6344: <p>When a package provides a shell interpreter, it has to set the
                   6345: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6346: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6347: 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   6348: <pre class="programlisting">
1.100     rillig   6349: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6350: </pre>
1.148     asau     6351: <div class="sect2">
1.75      rillig   6352: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6353: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6354: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6355: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6356: environment variable to <code class="literal">NO</code>.</p>
                   6357: </div>
                   6358: </div>
1.148     asau     6359: <div class="sect1">
1.75      rillig   6360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6361: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6362: <p>Packages that install X11 fonts should update the database files
                   6363: that index the fonts within each fonts directory.  This can easily be
                   6364: accomplished within the pkginstall framework.</p>
                   6365: <p>When a package installs X11 fonts, it must list the directories in
                   6366: which fonts are installed in the
                   6367: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      6368: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   6369: <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
1.75      rillig   6370: installation scripts to run the appropriate commands to update the fonts
                   6371: database files within each of those directories.  For convenience, if the
                   6372: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6373: 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   6374: <pre class="programlisting">
1.100     rillig   6375: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6376: </pre>
1.148     asau     6377: <div class="sect2">
1.75      rillig   6378: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6379: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6380: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6381: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6382: environment variable to <code class="literal">NO</code>.</p>
                   6383: </div>
                   6384: </div>
                   6385: </div>
1.148     asau     6386: <div class="chapter">
1.75      rillig   6387: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6388: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6389: <div class="toc">
                   6390: <p><b>Table of Contents</b></p>
                   6391: <dl>
1.106     rillig   6392: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      6393: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.106     rillig   6394: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6395: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6396: </dl>
                   6397: </div>
                   6398: <p>Many packages have the ability to be built to support different
1.76      rillig   6399: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6400: in pkgsrc that provides generic handling of those options that
                   6401: determine different ways in which the packages can be built.  It's
                   6402: possible for the user to specify exactly which sets of options will be
                   6403: built into a package or to allow a set of global default options
                   6404: apply.</p>
1.107     rillig   6405: <p>There are two broad classes of behaviors that one might want to
                   6406: control via options.  One is whether some particular feature is
                   6407: enabled in a program that will be built anyway, often by including or
                   6408: not including a dependency on some other package.  The other is
                   6409: whether or not an additional program will be built as part of the
                   6410: package.  Generally, it is better to make a split package for such
                   6411: additional programs instead of using options, because it enables
                   6412: binary packages to be built which can then be added separately.  For
                   6413: example, the foo package might have minimal dependencies (those
                   6414: packages without which foo doesn't make sense), and then the foo-gfoo
                   6415: package might include the GTK frontend program gfoo.  This is better
                   6416: than including a gtk option to foo that adds gfoo, because either that
                   6417: option is default, in which case binary users can't get foo without
                   6418: gfoo, or not default, in which case they can't get gfoo.  With split
                   6419: packages, they can install foo without having GTK, and later decide to
                   6420: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6421: source users too, avoiding the need for rebuilds.</p>
                   6422: <p>Plugins with widely varying dependencies should usually be split
                   6423: instead of options.</p>
                   6424: <p>It is often more work to maintain split packages, especially if
                   6425: the upstream package does not support this.  The decision of split
                   6426: vs. option should be made based on the likelihood that users will want
                   6427: or object to the various pieces, the size of the dependencies that are
                   6428: included, and the amount of work.</p>
                   6429: <p>A further consideration is licensing.  Non-free parts, or parts
                   6430: that depend on non-free dependencies (especially plugins) should
                   6431: almost always be split if feasible.</p>
1.148     asau     6432: <div class="sect1">
1.75      rillig   6433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6434: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6435: <p>Global default options are listed in
                   6436: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6437: that should be built into every package if that option is supported.
1.110     hubertf  6438: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6439: </div>
1.148     asau     6440: <div class="sect1">
1.75      rillig   6441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6442: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6443: </h2></div></div></div>
1.75      rillig   6444: <p>The following example shows how
1.76      rillig   6445: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6446: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6447: <code class="filename">Makefile</code>, or in a file,
                   6448: e.g. <code class="filename">options.mk</code>, that is included by the
                   6449: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6450: <pre class="programlisting">
1.100     rillig   6451: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6452: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6453: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6454: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6455: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6456: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6457: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6458: 
                   6459: .include "../../mk/bsd.prefs.mk"
                   6460: 
                   6461: # this package was previously named wibble2
                   6462: .if defined(PKG_OPTIONS.wibble2)
                   6463: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6464: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6465:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6466: .endif
                   6467: 
                   6468: .include "../../mk/bsd.options.mk"
                   6469: 
                   6470: # Package-specific option-handling
                   6471: 
                   6472: ###
                   6473: ### FOO support
                   6474: ###
                   6475: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6476: CONFIGURE_ARGS+=    --enable-foo
                   6477: .endif
                   6478: 
                   6479: ###
                   6480: ### LDAP support
                   6481: ###
                   6482: .if !empty(PKG_OPTIONS:Mldap)
                   6483: .  include "../../databases/openldap-client/buildlink3.mk"
                   6484: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6485: .endif
                   6486: 
                   6487: ###
                   6488: ### database support
                   6489: ###
                   6490: .if !empty(PKG_OPTIONS:Mmysql)
                   6491: .  include "../../mk/mysql.buildlink3.mk"
                   6492: .endif
                   6493: .if !empty(PKG_OPTIONS:Mpgsql)
                   6494: .  include "../../mk/pgsql.buildlink3.mk"
                   6495: .endif
1.75      rillig   6496: </pre>
                   6497: <p>The first section contains the information about which build
                   6498: options are supported by the package, and any default options settings
                   6499: if needed.</p>
1.128     wiz      6500: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6501: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.136     dholland 6502: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6503: options.  It should be set to
1.78      rillig   6504: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6505: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6506: at the point where the options are processed.</p></li>
1.128     wiz      6507: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   6508: build options supported by the package.</p></li>
1.128     wiz      6509: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   6510: list of names of groups of mutually exclusive options.  The options in
                   6511: each group are listed in
                   6512: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6513: The most specific setting of any option from the group takes
                   6514: precedence over all other options in the group.  Options from the
                   6515: groups will be automatically added to
                   6516: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      6517: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   6518: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6519: packages will fail if no option from the group is
                   6520: selected.</p></li>
1.128     wiz      6521: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   6522: of names of sets of options.  At least one option from each set must
                   6523: be selected.  The options in each set are listed in
                   6524: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6525: Options from the sets will be automatically added to
                   6526: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6527: fail if no option from the set is selected.</p></li>
1.128     wiz      6528: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   6529: build options which are enabled by default.</p></li>
1.128     wiz      6530: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   6531: of
1.128     wiz      6532: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
1.110     hubertf  6533: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6534: their option counterparts.  Pairs should be added with
1.128     wiz      6535: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   6536: warning will be issued if the user uses a legacy
                   6537: variable.</p></li>
1.128     wiz      6538: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   6539: of
1.128     wiz      6540: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
1.75      rillig   6541: pairs that map options that have been renamed to their new
1.128     wiz      6542: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   6543: the listing of global legacy options.  A warning will be issued if
                   6544: the user uses a legacy option.</p></li>
1.128     wiz      6545: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   6546: options implied by deprecated variables used.  This can be used for
                   6547: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6548: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6549: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      6550: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   6551: a list of warnings about deprecated variables or options used, and
                   6552: what to use instead.</p></li>
                   6553: </ol></div>
                   6554: <p>A package should never modify
                   6555: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6556: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6557: To suggest a default set of options, use
                   6558: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6559: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6560: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6561: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6562: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6563: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6564: happen with platform-specific options if none of them is supported on
                   6565: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6566: empty list and the package is otherwise treated as not using the
                   6567: options framework.</p>
1.76      rillig   6568: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6569: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6570: build options, properly filtered to remove unsupported and duplicate
                   6571: options.</p>
                   6572: <p>The remaining sections contain the logic that is specific to
                   6573: each option.  The correct way to check for an option is to check
                   6574: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6575: <pre class="programlisting">
1.100     rillig   6576: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6577: </pre>
                   6578: </div>
1.148     asau     6579: <div class="sect1">
1.75      rillig   6580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6581: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6582: <p>Options that enable similar features in different packages (like
                   6583: optional support for a library) should use a common name in all
                   6584: packages that support it (like the name of the library).  If another
                   6585: package already has an option with the same meaning, use the same
                   6586: name.</p>
                   6587: <p>Options that enable features specific to one package, where it's
                   6588: unlikely that another (unrelated) package has the same (or a similar)
                   6589: optional feature, should use a name prefixed with
                   6590: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6591: <p>If a group of related packages share an optional feature
                   6592: specific to that group, prefix it with the name of the
1.128     wiz      6593: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   6594: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6595: <p>For new options, add a line to
1.76      rillig   6596: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6597: fields, separated by tab.  The first field is the option name, the
                   6598: second its description.  The description should be a whole sentence
                   6599: (starting with an uppercase letter and ending with a period) that
1.128     wiz      6600: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6601: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   6602: </div>
1.148     asau     6603: <div class="sect1">
1.107     rillig   6604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6605: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6606: <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   6607: different dependencies based on the options with which the package was
                   6608: built. For querying these options, the file
                   6609: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6610: typical example looks like this:</p>
                   6611: <pre class="programlisting">
                   6612: pkgbase := libpurple
                   6613: .include "../../mk/pkg-build-options.mk"
                   6614: 
                   6615: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6616: ...
                   6617: .endif
                   6618: </pre>
                   6619: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6620: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6621: options of the libpurple package, which can then be queried like
                   6622: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6623: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6624: details.</p>
                   6625: </div>
1.75      rillig   6626: </div>
1.148     asau     6627: <div class="chapter">
1.75      rillig   6628: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6629: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6630: <div class="toc">
                   6631: <p><b>Table of Contents</b></p>
                   6632: <dl>
1.106     rillig   6633: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6634: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6635: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6636: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      6637: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   6638: <dd><dl>
                   6639: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6640: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6641: </dl></dd>
1.128     wiz      6642: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6643: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6644: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6645: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6646: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6647: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6648: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6649: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6650: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6651: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   6652: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6653: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6654: </dl>
                   6655: </div>
1.148     asau     6656: <div class="sect1">
1.75      rillig   6657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6658: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6659: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6660:     built. Building a package is separated into different
                   6661:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6662:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      6663:     described in the following sections. Each phase is split into
1.87      wiz      6664:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6665:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6666:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6667:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6668:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6669: <p>Never override the regular targets (like
                   6670:     <code class="varname">fetch</code>), if you have to, override the
                   6671:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6672: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6673:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6674:     the local system and then extracted. After any pkgsrc-specific patches
                   6675:     to compile properly are applied, the software can be configured, then
                   6676:     built (usually by compiling), and finally the generated binaries, etc.
                   6677:     can be put into place on the system.</p>
1.97      rillig   6678: <p>To get more details about what is happening at each step,
                   6679:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6680:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6681:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6682: </div>
1.148     asau     6683: <div class="sect1">
1.75      rillig   6684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6685: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6686: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6687:     the next section, here's a brief discussion on where programs are
                   6688:     installed, and which variables influence this.</p>
1.75      rillig   6689: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6690:     where all files of the final program shall be installed. It is
                   6691:     usually set to <code class="varname">LOCALBASE</code>
                   6692:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6693:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6694:     <code class="varname">PREFIX</code> needs to be put
                   6695:     into the various places in the program's source where paths to
1.110     hubertf  6696:     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   6697: <p>When choosing which of these variables to use,
1.87      wiz      6698:     follow the following rules:</p>
1.148     asau     6699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6700: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      6701:        where the current pkg will be installed.  When referring to a
                   6702:        pkg's own installation path, use
1.128     wiz      6703:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6704: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      6705:        are installed.  If you need to construct a -I or -L argument
                   6706:        to the compiler to find includes and libraries installed by
1.128     wiz      6707:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      6708:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6709:        installed all packages in <code class="filename">/usr/local</code>. As
                   6710:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6711:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      6712: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      6713:        distribution (from xsrc, etc.) is installed. When looking for
                   6714:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      6715:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   6716: <li class="listitem">
1.88      wiz      6717: <p>X11-based packages are special in that they may be
                   6718:        installed in either <code class="varname">X11BASE</code> or
                   6719:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6720: <p>Usually, X11 packages should be installed under
1.88      wiz      6721:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6722:        will need to include
                   6723:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6724:        request the presence of X11 and to get the right compilation
                   6725:        flags.</p>
1.75      rillig   6726: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6727:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6728:        files. These packages are special and they must be placed under
                   6729:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6730:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6731:        your package.</p>
1.75      rillig   6732: <p>Some notes: If you need
1.87      wiz      6733:        to find includes or libraries installed by a pkg that has
                   6734:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6735:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6736:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6737:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6738:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6739:        <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      6740:        is enabled by default.</p>
1.75      rillig   6741: </li>
1.128     wiz      6742: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.88      wiz      6743:        the installed location of an X11
                   6744:        package. <code class="varname">X11PREFIX</code> will be set to
                   6745:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6746:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6747:        installed.</p></li>
1.128     wiz      6748: <li class="listitem">
1.88      wiz      6749: <p>If xpkgwedge is installed, it is possible to have some
                   6750:        packages installed in <code class="varname">X11BASE</code> and some in
                   6751:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6752:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6753:        definition can be used. It takes pairs in the format
1.136     dholland 6754:        <span class="quote">&#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6755:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6756:        of the installed package &lt;package&gt;, or
1.128     wiz      6757:        <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
1.88      wiz      6758:        installed.</p>
1.75      rillig   6759: <p>This is best illustrated by example.</p>
                   6760: <p>The following lines are taken from
1.87      wiz      6761:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6762: <pre class="programlisting">
1.100     rillig   6763: EVAL_PREFIX+=           GTKDIR=gtk+
                   6764: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6765: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6766: CONFIGURE_ARGS+=        --enable-multibyte
                   6767: </pre>
1.88      wiz      6768: <p>Specific defaults can be defined for the packages
                   6769:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6770:        definition of the form:</p>
1.75      rillig   6771: <pre class="programlisting">
1.100     rillig   6772: GTKDIR_DEFAULT= ${LOCALBASE}
                   6773: </pre>
1.75      rillig   6774: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6775:        to the first definition in
                   6776:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6777: </li>
1.128     wiz      6778: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.136     dholland 6779:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6780:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6781:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6782: </ul></div>
                   6783: </div>
1.148     asau     6784: <div class="sect1">
1.75      rillig   6785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6786: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6787: <p>When building a package, various directories are used to store
1.87      wiz      6788:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6789:     directories are explained here.</p>
1.75      rillig   6790: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6791:     are two common base directories for these relative directories:
                   6792:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6793:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6794:     inside the package itself.</p>
1.148     asau     6795: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6796: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6797: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6798:       root directory. Generally, you don't need
                   6799:       it.</p></dd>
1.97      rillig   6800: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6801: <dd><p>This is an absolute pathname that points to the
                   6802:       current package.</p></dd>
1.75      rillig   6803: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6804: <dd><p>This is a pathname relative to
1.87      wiz      6805:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6806:       package.</p></dd>
1.75      rillig   6807: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6808: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6809:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6810:       directory. It also contains temporary directories and log files used by
                   6811:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6812:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6813: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6814: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6815:       where the distfiles are extracted. It is usually a direct subdirectory
                   6816:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6817:       that isn't hidden. This variable may be changed by a package
                   6818:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6819: </dl></div>
1.114     jmcneill 6820: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6821:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6822:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6823:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6824:     If users would like to have their pkgsrc trees behave in a
                   6825:     read-only manner, then the value of
                   6826:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6827:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6828: </div>
1.148     asau     6829: <div class="sect1">
1.75      rillig   6830: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6831: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6832: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6833:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6834:     phase. This will automatically run all phases that are required for this
                   6835:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6836:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6837:     the package will be built, but not installed.</p>
1.75      rillig   6838: </div>
1.148     asau     6839: <div class="sect1">
1.75      rillig   6840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6841: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6842: <p>The first step in building a package is to fetch the
1.88      wiz      6843:     distribution files (distfiles) from the sites that are providing
                   6844:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6845:     phase.</p>
1.148     asau     6846: <div class="sect2">
1.81      rillig   6847: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6848: <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      6849: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6850:       defines all URLs from where the distfile, whose name is
                   6851:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6852:       fetched. The more complicated cases are described
                   6853:       below.</p>
                   6854: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6855:       the list of distfiles that have to be fetched. Its value
                   6856:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6857:       so that most packages don't need to define it at all.
                   6858:       <code class="varname">EXTRACT_SUFX</code> is
                   6859:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6860:       freely. Note that if your package requires additional
                   6861:       distfiles to the default one, you cannot just append the
                   6862:       additional filenames using the <code class="literal">+=</code>
                   6863:       operator, but you have write for example:</p>
1.81      rillig   6864: <pre class="programlisting">
1.100     rillig   6865: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6866: </pre>
1.88      wiz      6867: <p>Each distfile is fetched from a list of sites, usually
                   6868:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6869:       <code class="varname">DISTFILES</code> or multiple
                   6870:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6871:       set
                   6872:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6873:       to the list of URLs where the file
                   6874:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6875:       (including the suffix) can be found.</p>
                   6876: <pre class="programlisting">
1.100     rillig   6877: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6878: DISTFILES+=     foo-file.tar.gz
                   6879: SITES.foo-file.tar.gz= \
                   6880: http://www.somewhere.com/somehow/ \
                   6881: http://www.somewhereelse.com/mirror/somehow/
                   6882: </pre>
1.81      rillig   6883: <p>When actually fetching the distfiles, each item from
1.88      wiz      6884:       <code class="varname">MASTER_SITES</code> or
                   6885:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6886:       appended to it, without an intermediate slash. Therefore,
                   6887:       all site values have to end with a slash or other separator
                   6888:       character. This allows for example to set
                   6889:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6890:       that gets the name of the distfile as a parameter. In this
                   6891:       case, the definition would look like:</p>
1.81      rillig   6892: <pre class="programlisting">
1.100     rillig   6893: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6894: </pre>
1.125     wiz      6895: <p> The exception to this rule are URLs starting with a dash.
                   6896:       In that case the URL is taken as is, fetched and the result stored
                   6897:       under the name of the distfile.</p>
1.81      rillig   6898: <p>There are some predefined values for
1.88      wiz      6899:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6900:       packages.  The names of the variables should speak for
                   6901:       themselves.</p>
                   6902: <pre class="programlisting">
1.100     rillig   6903: ${MASTER_SITE_APACHE}
                   6904: ${MASTER_SITE_BACKUP}
                   6905: ${MASTER_SITE_CYGWIN}
                   6906: ${MASTER_SITE_DEBIAN}
                   6907: ${MASTER_SITE_FREEBSD}
                   6908: ${MASTER_SITE_FREEBSD_LOCAL}
                   6909: ${MASTER_SITE_GENTOO}
                   6910: ${MASTER_SITE_GNOME}
                   6911: ${MASTER_SITE_GNU}
                   6912: ${MASTER_SITE_GNUSTEP}
                   6913: ${MASTER_SITE_IFARCHIVE}
                   6914: ${MASTER_SITE_KDE}
                   6915: ${MASTER_SITE_MOZILLA}
                   6916: ${MASTER_SITE_MYSQL}
                   6917: ${MASTER_SITE_OPENOFFICE}
                   6918: ${MASTER_SITE_PERL_CPAN}
                   6919: ${MASTER_SITE_PGSQL}
                   6920: ${MASTER_SITE_R_CRAN}
                   6921: ${MASTER_SITE_SOURCEFORGE}
                   6922: ${MASTER_SITE_SOURCEFORGE_JP}
                   6923: ${MASTER_SITE_SUNSITE}
                   6924: ${MASTER_SITE_SUSE}
                   6925: ${MASTER_SITE_TEX_CTAN}
                   6926: ${MASTER_SITE_XCONTRIB}
                   6927: ${MASTER_SITE_XEMACS}
                   6928: </pre>
1.88      wiz      6929: <p>Some explanations for the less self-explaining ones:
                   6930:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      6931:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.132     spz      6932:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6933: <p>If you choose one of these predefined sites, you may
                   6934:       want to specify a subdirectory of that site. Since these
                   6935:       macros may expand to more than one actual site, you
                   6936:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6937:       specify a subdirectory:</p>
1.81      rillig   6938: <pre class="programlisting">
1.100     rillig   6939: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6940: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6941: </pre>
1.81      rillig   6942: <p>Note the trailing slash after the subdirectory
1.88      wiz      6943:       name.</p>
1.81      rillig   6944: </div>
1.148     asau     6945: <div class="sect2">
1.81      rillig   6946: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6947: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6948: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6949:       all the distfiles exist in a local directory
1.93      rillig   6950:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6951:       user). If the files do not exist, they are fetched using
                   6952:       commands of the form</p>
1.75      rillig   6953: <pre class="programlisting">
1.100     rillig   6954: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6955: </pre>
1.88      wiz      6956: <p>where <code class="literal">${site}</code> varies through
                   6957:       several possibilities in turn: first,
                   6958:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6959:       sites specified in either <code class="varname">SITES.file</code> if
                   6960:       defined, else <code class="varname">MASTER_SITES</code> or
                   6961:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6962:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6963:       all except the first and the last can be optionally sorted
                   6964:       by the user, via setting either
                   6965:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6966:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6967:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6968: <p> The specific command and arguments used depend on the
                   6969:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6970:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6971: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6972:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6973:       distfiles, if they are freely distributable.  Packages setting
                   6974:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      6975:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   6976:       mirrored.</p>
1.81      rillig   6977: </div>
1.75      rillig   6978: </div>
1.148     asau     6979: <div class="sect1">
1.75      rillig   6980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6981: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6982: <p>After the distfile(s) are fetched, their checksum is
                   6983:     generated and compared with the checksums stored in the
                   6984:     distinfo file. If the checksums don't match, the build is
                   6985:     aborted. This is to ensure the same distfile is used for
                   6986:     building, and that the distfile wasn't changed, e.g. by some
                   6987:     malign force, deliberately changed distfiles on the master
                   6988:     distribution site or network lossage.</p>
1.75      rillig   6989: </div>
1.148     asau     6990: <div class="sect1">
1.75      rillig   6991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6992: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6993: <p>When the distfiles are present on the local system, they
1.88      wiz      6994:     need to be extracted, as they usually come in the form of some
                   6995:     compressed archive format.</p>
1.75      rillig   6996: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6997:     extracted. If you only need some of them, you can set the
                   6998:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6999:     files.</p>
                   7000: <p>Extracting the files is usually done by a little
1.93      rillig   7001:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      7002:     already knows how to extract various archive formats, so most
                   7003:     likely you will not need to change anything here. But if you
                   7004:     need, the following variables may help you:</p>
1.148     asau     7005: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7006: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   7007: <dd><p>Use these variables to override the default
1.88      wiz      7008:       options for an extract command, which are defined in
1.93      rillig   7009:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   7010: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   7011: <dd><p>This variable can be set to
1.114     jmcneill 7012:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   7013:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      7014:       absolute pathname pointing to the command with which tar
1.114     jmcneill 7015:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   7016:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   7017: </dl></div>
1.88      wiz      7018: <p>If the <code class="filename">extract</code> program doesn't
                   7019:     serve your needs, you can also override the
                   7020:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   7021:     command used for extracting the files. This command is
                   7022:     executed in the <code class="filename">${WRKSRC}</code>
                   7023:     directory. During execution of this command, the shell
                   7024:     variable <code class="varname">extract_file</code> holds the absolute
                   7025:     pathname of the file that is going to be extracted.</p>
1.75      rillig   7026: <p>And if that still does not suffice, you can override the
1.88      wiz      7027:     <code class="varname">do-extract</code> target in the package
                   7028:     Makefile.</p>
1.75      rillig   7029: </div>
1.148     asau     7030: <div class="sect1">
1.75      rillig   7031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7032: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   7033: <p>After extraction, all the patches named by the
1.88      wiz      7034:     <code class="varname">PATCHFILES</code>, those present in the patches
                   7035:     subdirectory of the package as well as in
                   7036:     $LOCALPATCHES/$PKGPATH (e.g.
                   7037:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   7038:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   7039:     <code class="filename">.gz</code> are uncompressed before they are
                   7040:     applied, files ending in <code class="filename">.orig</code> or
                   7041:     <code class="filename">.rej</code> are ignored. Any special options to
1.136     dholland 7042:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.110     hubertf  7043:     <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>
1.136     dholland 7044: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      7045:     it fail if the patches apply with some lines of fuzz. Please
                   7046:     fix (regen) the patches so that they apply cleanly. The
                   7047:     rationale behind this is that patches that don't apply cleanly
                   7048:     may end up being applied in the wrong place, and cause severe
                   7049:     harm there.</p>
1.75      rillig   7050: </div>
1.148     asau     7051: <div class="sect1">
1.75      rillig   7052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7053: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  7054: <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      7055:     </p>
1.75      rillig   7056: </div>
1.148     asau     7057: <div class="sect1">
1.75      rillig   7058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7059: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   7060: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      7061:     linkers. The following variables can be used to tweak the
                   7062:     wrappers.</p>
1.148     asau     7063: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7064: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   7065: <dd><p>The command used to print progress
1.88      wiz      7066:       messages. Does nothing by default. Set to
                   7067:       <code class="literal">${ECHO}</code> to see the progress
                   7068:       messages.</p></dd>
1.75      rillig   7069: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   7070: <dd><p>This variable can be set to
1.88      wiz      7071:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   7072:       depending on whether you want additional information in the
                   7073:       wrapper log file.</p></dd>
1.75      rillig   7074: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   7075: <dd><p>This variable can be set to
1.88      wiz      7076:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   7077:       on whether the wrapper should use its cache, which will
                   7078:       improve the speed. The default value is
                   7079:       <code class="literal">yes</code>, but is forced to
                   7080:       <code class="literal">no</code> if the platform does not support
                   7081:       it.</p></dd>
1.75      rillig   7082: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      7083: <dd><p>A list of reordering commands. A reordering
                   7084:       command has the form
                   7085:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   7086:       It ensures that that
                   7087:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   7088:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   7089:       </p></dd>
1.75      rillig   7090: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   7091: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      7092:       investigate further]</p></dd>
1.75      rillig   7093: </dl></div>
                   7094: </div>
1.148     asau     7095: <div class="sect1">
1.75      rillig   7096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7097: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      7098: <p>Most pieces of software need information on the header
                   7099:     files, system calls, and library routines which are available
                   7100:     on the platform they run on. The process of determining this
                   7101:     information is known as configuration, and is usually
                   7102:     automated. In most cases, a script is supplied with the
                   7103:     distfiles, and its invocation results in generation of header
                   7104:     files, Makefiles, etc.</p>
                   7105: <p>If the package contains a configure script, this can be
                   7106:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      7107:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      7108:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      7109:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      7110:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   7111: <pre class="programlisting">
1.100     rillig   7112: .for d in ${CONFIGURE_DIRS}
                   7113:         cd ${WRKSRC} \
                   7114:         &amp;&amp; cd ${d} \
                   7115:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   7116: .endfor
                   7117: </pre>
1.88      wiz      7118: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      7119:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      7120:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   7121:     configure script is run with the environment
                   7122:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7123:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7124:     <code class="varname">CONFIGURE_ENV</code>,
                   7125:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      7126:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      7127:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7128:     package.</p>
1.144     wiz      7129: <p>If the program uses the Perl way of configuration (mainly Perl
                   7130:     modules, but not only), i.e. a file called
                   7131:     <code class="filename">Makefile.PL</code>, it should include
                   7132:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   7133:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   7134:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      7135: <p>If the program uses an <code class="filename">Imakefile</code>
                   7136:     for configuration, the appropriate steps can be invoked by
                   7137:     setting <code class="varname">USE_IMAKE</code> to
1.128     wiz      7138:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
1.88      wiz      7139:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   7140:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7141:     xmkmf's environment by adding them to the
                   7142:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   7143: <p>If the program uses <code class="filename">cmake</code>
                   7144:     for configuration, the appropriate steps can be invoked by
1.128     wiz      7145:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   7146:     You can add variables to cmake's environment by adding them to the
                   7147:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7148:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7149:     The top directory argument is given by the
                   7150:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      7151:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   7152: <p>If there is no configure step at all, set
1.128     wiz      7153:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   7154: </div>
1.148     asau     7155: <div class="sect1">
1.75      rillig   7156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7157: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      7158: <p>For building a package, a rough equivalent of the
                   7159:     following code is executed.</p>
1.75      rillig   7160: <pre class="programlisting">
1.100     rillig   7161: .for d in ${BUILD_DIRS}
                   7162:         cd ${WRKSRC} \
                   7163:         &amp;&amp; cd ${d} \
                   7164:         &amp;&amp; env ${MAKE_ENV} \
                   7165:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7166:                 -f ${MAKE_FILE} \
                   7167:                 ${BUILD_TARGET}
                   7168: .endfor
                   7169: </pre>
1.88      wiz      7170: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      7171:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      7172:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7173:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7174:     <code class="varname">MAKE_ENV</code> and arguments
                   7175:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7176:     <code class="varname">MAKE_ENV</code>,
                   7177:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7178:     <code class="varname">MAKE_FILE</code> and
                   7179:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7180:     package.</p>
1.75      rillig   7181: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      7182:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   7183:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.88      wiz      7184:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      7185:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   7186:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   7187: <p>If there is no build step at all, set
1.128     wiz      7188:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   7189: </div>
1.148     asau     7190: <div class="sect1">
1.75      rillig   7191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7192: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   7193: <p>[TODO]</p>
                   7194: </div>
1.148     asau     7195: <div class="sect1">
1.75      rillig   7196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7197: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   7198: <p>Once the build stage has completed, the final step is to
1.88      wiz      7199:     install the software in public directories, so users can
                   7200:     access the programs and files.</p>
1.75      rillig   7201: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      7202:     equivalent of the following code is executed. Additionally,
                   7203:     before and after this code, much magic is performed to do
                   7204:     consistency checks, registering the package, and so on.</p>
                   7205: <pre class="programlisting">
1.100     rillig   7206: .for d in ${INSTALL_DIRS}
                   7207:         cd ${WRKSRC} \
                   7208:         &amp;&amp; cd ${d} \
                   7209:         &amp;&amp; env ${MAKE_ENV} \
                   7210:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7211:                 -f ${MAKE_FILE} \
                   7212:                 ${INSTALL_TARGET}
                   7213: .endfor
                   7214: </pre>
1.75      rillig   7215: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      7216:     <span class="emphasis"><em>build</em></span> phase.
                   7217:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7218:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      7219:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   7220:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      7221:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7222:     defined.</p>
1.75      rillig   7223: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      7224:     variables are useful. They are all variations of the
1.136     dholland 7225:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      7226:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7227:     install command. The specialized variants, together with their
                   7228:     intended use, are:</p>
1.148     asau     7229: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7230: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      7231: <dd><p>directories that contain
                   7232:       binaries</p></dd>
1.75      rillig   7233: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7234: <dd><p>directories that contain
                   7235:       scripts</p></dd>
1.75      rillig   7236: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7237: <dd><p>directories that contain shared and static
                   7238:       libraries</p></dd>
1.75      rillig   7239: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7240: <dd><p>directories that contain data
                   7241:       files</p></dd>
1.75      rillig   7242: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7243: <dd><p>directories that contain man
                   7244:       pages</p></dd>
1.75      rillig   7245: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7246: <dd><p>binaries that can be stripped from debugging
                   7247:       symbols</p></dd>
1.75      rillig   7248: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7249: <dd><p>binaries that cannot be
                   7250:       stripped</p></dd>
1.75      rillig   7251: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7252: <dd><p>game
                   7253:       binaries</p></dd>
1.75      rillig   7254: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7255: <dd><p>shared and static
                   7256:       libraries</p></dd>
1.75      rillig   7257: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7258: <dd><p>data files</p></dd>
                   7259: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7260: <dd><p>data files for
                   7261:       games</p></dd>
1.75      rillig   7262: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7263: <dd><p>man pages</p></dd>
                   7264: </dl></div>
                   7265: <p>Some other variables are:</p>
1.148     asau     7266: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7267: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7268: <dd><p>A list of directories relative to
1.88      wiz      7269:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7270:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7271:       The package is supposed to create all needed directories itself
                   7272:       before installing files to it and list all other directories here.
                   7273:       </p></dd>
1.75      rillig   7274: </dl></div>
1.97      rillig   7275: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      7276:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   7277:     mostly relevant for packages in the <code class="filename">regress</code>
                   7278:     category.</p>
1.75      rillig   7279: </div>
1.148     asau     7280: <div class="sect1">
1.75      rillig   7281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7282: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7283: <p>Once the install stage has completed, a binary package of
                   7284:     the installed files can be built.  These binary packages can be
                   7285:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  7286:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7287:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7288: <p>By default, the binary packages are created in
                   7289:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7290:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7291:     one for each category in the <code class="varname">CATEGORIES</code>
                   7292:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7293:     <code class="filename">pkgsrc/packages</code>.</p>
                   7294: </div>
1.148     asau     7295: <div class="sect1">
1.88      wiz      7296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7297: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7298: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7299:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7300:     to clean the work directories of all dependencies too, use
1.110     hubertf  7301:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7302: </div>
1.148     asau     7303: <div class="sect1">
1.75      rillig   7304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7305: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     7306: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7307: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7308: <dd><p>For any of the main targets described in the
                   7309:          previous section, two auxiliary targets exist with
1.128     wiz      7310:          <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
1.87      wiz      7311:          prefix for the main target's name.  These targets are
1.88      wiz      7312:          invoked before and after the main target is called,
                   7313:          allowing extra configuration or installation steps be
                   7314:          performed from a package's Makefile, for example, which
                   7315:          a program's configure script or install target
                   7316:          omitted.</p></dd>
1.75      rillig   7317: <dt><span class="term">do-*</span></dt>
1.88      wiz      7318: <dd><p>Should one of the main targets do the wrong thing,
                   7319:          and should there be no variable to fix this, you can
                   7320:          redefine it with the do-* target.  (Note that redefining
                   7321:          the target itself instead of the do-* target is a bad
                   7322:          idea, as the pre-* and post-* targets won't be called
                   7323:          anymore, etc.) You will not usually need to do
                   7324:          this.</p></dd>
1.75      rillig   7325: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7326: <dd>
1.110     hubertf  7327: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7328:          you noticed some file was not installed properly, you
                   7329:          can repeat the installation with this target, which will
1.128     wiz      7330:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      7331: <p>This is the default value of
                   7332:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7333:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7334:          package</strong></span>, where the defaults are
1.128     wiz      7335:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.88      wiz      7336:          respectively.</p>
                   7337: </dd>
1.75      rillig   7338: <dt><span class="term">deinstall</span></dt>
                   7339: <dd>
1.136     dholland 7340: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      7341:          current directory, effectively de-installing the
                   7342:          package. The following variables can be used to tune the
                   7343:          behaviour:</p>
1.148     asau     7344: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7345: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.136     dholland 7346: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   7347: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7348: <dd><p>Remove all packages that require (depend on)
                   7349:                the given package.  This can be used to remove any
                   7350:                packages that may have been pulled in by a given
1.110     hubertf  7351:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7352:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7353:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7354:                likely to remove whole KDE. Works by adding
1.136     dholland 7355:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      7356:                command line.</p></dd>
1.75      rillig   7357: </dl></div>
                   7358: </dd>
1.88      wiz      7359: <dt><span class="term">bin-install</span></dt>
                   7360: <dd><p>Install a binary package from local disk and via FTP
                   7361:          from a list of sites (see the
                   7362:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7363:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7364:          available anywhere.  The arguments given to
1.110     hubertf  7365:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7366:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7367:          operation, etc.</p></dd>
1.75      rillig   7368: <dt><span class="term">update</span></dt>
                   7369: <dd>
1.88      wiz      7370: <p>This target causes the current package to be
                   7371:          updated to the latest version.  The package and all
                   7372:          depending packages first get de-installed, then current
                   7373:          versions of the corresponding packages get compiled and
                   7374:          installed.  This is similar to manually noting which
                   7375:          packages are currently installed, then performing a
1.110     hubertf  7376:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7377:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7378:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7379:          packages.</p>
1.128     wiz      7380: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  7381:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7382:          update</strong></span> was interrupted for some reason.
                   7383:          However, in this case, make sure you don't call
1.110     hubertf  7384:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7385:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7386:          Otherwise, you lose the ability to automatically update
                   7387:          the current package along with the dependent packages
                   7388:          you have installed.</p>
1.110     hubertf  7389: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7390:          update</strong></span> will only work as long as the package
                   7391:          tree remains unchanged.  If the source code for one of
                   7392:          the packages to be updated has been changed, resuming
1.110     hubertf  7393:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7394:          fail!</p>
                   7395: <p>The following variables can be used either on the
1.110     hubertf  7396:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7397:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7398:          update</strong></span>:</p>
1.148     asau     7399: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7400: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7401: <dd><p>Install target to recursively use for the
                   7402:                updated package and the dependent packages.
                   7403:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      7404:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  7405:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      7406:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7407:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7408:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      7409:                endless loop!</p></dd>
1.75      rillig   7410: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7411: <dd><p>Don't clean up after updating.  Useful if
                   7412:                you want to leave the work sources of the updated
                   7413:                packages around for inspection or other purposes.
                   7414:                Be sure you eventually clean up the source tree
1.128     wiz      7415:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      7416:                or you may run into troubles with old source code
                   7417:                still lying around on your next
1.110     hubertf  7418:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7419:                update</strong></span>.</p></dd>
1.75      rillig   7420: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7421: <dd><p>Deinstall each package before installing
                   7422:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7423:                may be necessary if the
1.128     wiz      7424:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  7425:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7426:                update</strong></span>.</p></dd>
1.75      rillig   7427: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7428: <dd><p>Allows you to disable recursion and hardcode
                   7429:                the target for packages.  The default is
1.128     wiz      7430:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      7431:                facilitating a recursive update of prerequisite
                   7432:                packages.  Only set
                   7433:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7434:                disable recursive updates. Use
                   7435:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7436:                set a specific target for each package to be
1.110     hubertf  7437:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7438:                (see above).</p></dd>
1.75      rillig   7439: </dl></div>
                   7440: </dd>
                   7441: <dt><span class="term">clean-update</span></dt>
                   7442: <dd>
1.88      wiz      7443: <p>Clean the source tree for all packages that would
1.110     hubertf  7444:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7445:          from the current directory.  This target should not be
                   7446:          used if the current package (or any of its depending
                   7447:          packages) have already been de-installed (e.g., after
1.110     hubertf  7448:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7449:          some packages you intended to update. As a rule of
                   7450:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7451:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7452:          and only if you have a dirty package tree (e.g., if you
                   7453:          used <code class="varname">NOCLEAN</code>).</p>
                   7454: <p>If you are unsure about whether your tree is
1.110     hubertf  7455:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7456:          clean</strong></span> at the top of the tree, or use the
                   7457:          following sequence of commands from the directory of the
                   7458:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7459:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7460:          time, otherwise you lose all the packages you wanted to
                   7461:          update!):</p>
1.87      wiz      7462: <pre class="screen">
                   7463: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7464: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7465: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7466:          </pre>
1.88      wiz      7467: <p>The following variables can be used either on the
1.110     hubertf  7468:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7469:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     7470: <div class="variablelist"><dl class="variablelist">
1.75      rillig   7471: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7472: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7473:                reconstruct the list of directories to update for
1.110     hubertf  7474:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7475:                update</strong></span> successfully installed all
                   7476:                packages you wanted to update.  Normally, this is
1.110     hubertf  7477:                done automatically on <span class="command"><strong>make
1.88      wiz      7478:                update</strong></span>, but may have been suppressed by
                   7479:                the <code class="varname">NOCLEAN</code> variable (see
                   7480:                above).</p></dd>
1.75      rillig   7481: </dl></div>
                   7482: </dd>
1.88      wiz      7483: <dt><span class="term">replace</span></dt>
                   7484: <dd>
                   7485: <p>Update the installation of the current package.  This
                   7486:          differs from update in that it does not replace dependent
1.93      rillig   7487:          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      7488:          target to work.</p>
                   7489: <p><span class="emphasis"><em>Be careful when using this
                   7490:          target!</em></span> There are no guarantees that dependent
                   7491:          packages will still work, in particular they will most
1.110     hubertf  7492:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7493:          library package whose shared library major version changed
                   7494:          between your installed version and the new one.  For this
                   7495:          reason, this target is not officially supported and only
                   7496:          recommended for advanced users.</p>
                   7497: </dd>
1.75      rillig   7498: <dt><span class="term">info</span></dt>
1.136     dholland 7499: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7500:          package. You can use this to check which version of a
                   7501:          package is installed.</p></dd>
                   7502: <dt><span class="term">index</span></dt>
                   7503: <dd>
                   7504: <p>This is a top-level command, i.e. it should be used in
                   7505:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7506:          database of all packages in the local pkgsrc tree, including
                   7507:          dependencies, comment, maintainer, and some other useful
                   7508:          information.  Individual entries are created by running
1.110     hubertf  7509:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7510:          directories.  This index file is saved as
                   7511:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7512:          verbose format by running <span class="command"><strong>make
1.88      wiz      7513:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7514:          <span class="command"><strong>make search
1.88      wiz      7515:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7516:          extract a list of all packages that depend on a particular
1.110     hubertf  7517:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7518:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7519: <p>Running this command takes a very long time, some
                   7520:          hours even on fast machines!</p>
                   7521: </dd>
1.75      rillig   7522: <dt><span class="term">readme</span></dt>
1.88      wiz      7523: <dd>
                   7524: <p>This target generates a
                   7525:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7526:          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      7527:          contain references to any packages which are in the
                   7528:          <code class="varname">PACKAGES</code> directory on the local
                   7529:          host. The generated files can be made to refer to URLs
                   7530:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7531:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7532:          wanted to generate <code class="filename">README.html</code>
                   7533:          files which pointed to binary packages on the local
                   7534:          machine, in the directory
                   7535:          <code class="filename">/usr/packages</code>, set
                   7536:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7537:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7538:          <code class="varname">${PACKAGES}</code> directory and its
                   7539:          subdirectories will be searched for all the binary
                   7540:          packages.</p>
                   7541: <p>The target can be run at the toplevel or in category
                   7542:          directories, in which case it descends recursively.</p>
                   7543: </dd>
1.75      rillig   7544: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7545: <dd><p>This is a top-level command, run it in
                   7546:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7547:          file <code class="filename">README-all.html</code> which contains a
                   7548:          list of all packages currently available in the NetBSD
                   7549:          Packages Collection, together with the category they belong
                   7550:          to and a short description. This file is compiled from the
                   7551:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7552:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7553:          readme</strong></span>.</p></dd>
1.75      rillig   7554: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7555: <dd><p>This is very much the same as the
1.128     wiz      7556:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      7557:          used when generating a pkgsrc tree to be written to a
                   7558:          CD-ROM.  This target also produces
                   7559:          <code class="filename">README.html</code> files, and can be made
                   7560:          to refer to URLs based on
                   7561:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7562:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7563: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7564: <dd><p>This target shows which distfiles and patchfiles
                   7565:          are needed to build the package
                   7566:          (<code class="varname">ALLFILES</code>, which contains all
                   7567:          <code class="varname">DISTFILES</code> and
1.87      wiz      7568:          <code class="varname">PATCHFILES</code>, but not
                   7569:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7570: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7571: <dd><p>This target shows nothing if the package is not
                   7572:          installed. If a version of this package is installed,
                   7573:          but is not the version provided in this version of
                   7574:          pkgsrc, then a warning message is displayed. This target
                   7575:          can be used to show which of your installed packages are
                   7576:          downlevel, and so the old versions can be deleted, and
                   7577:          the current ones added.</p></dd>
1.75      rillig   7578: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7579: <dd><p>This target shows the directory in the pkgsrc
                   7580:          hierarchy from which the package can be built and
                   7581:          installed. This may not be the same directory as the one
                   7582:          from which the package was installed. This target is
                   7583:          intended to be used by people who may wish to upgrade
                   7584:          many packages on a single host, and can be invoked from
                   7585:          the top-level pkgsrc Makefile by using the
1.128     wiz      7586:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   7587: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7588: <dd><p>This target shows which installed packages match
                   7589:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7590:          if out of date dependencies are causing build
                   7591:          problems.</p></dd>
1.75      rillig   7592: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7593: <dd><p>After a package is installed, check all its
                   7594:          binaries and (on ELF platforms) shared libraries to see
                   7595:          if they find the shared libs they need.  Run by default
1.110     hubertf  7596:          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   7597: <dt><span class="term">print-PLIST</span></dt>
                   7598: <dd>
1.128     wiz      7599: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      7600:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7601:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7602:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7603:          to care for shared libs etc., but it is
1.87      wiz      7604:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7605:          result before putting it into
                   7606:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7607:          diff the output of this command against an already
                   7608:          existing <code class="filename">PLIST</code> file.</p>
1.136     dholland 7609: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7610:          other methods that don't update file access times, be
                   7611:          sure to add these files manually to your
1.128     wiz      7612:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7613:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      7614:          them!</p>
1.128     wiz      7615: <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      7616:          information on this target.</p>
1.75      rillig   7617: </dd>
                   7618: <dt><span class="term">bulk-package</span></dt>
                   7619: <dd>
1.88      wiz      7620: <p>Used to do bulk builds. If an appropriate binary
                   7621:          package already exists, no action is taken. If not, this
                   7622:          target will compile, install and package it (and its
                   7623:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7624:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7625:          After creating the binary package, the sources, the
                   7626:          just-installed package and its required packages are
                   7627:          removed, preserving free disk space.</p>
                   7628: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7629:          all packages installed on a system!</em></span></p>
1.75      rillig   7630: </dd>
                   7631: <dt><span class="term">bulk-install</span></dt>
                   7632: <dd>
1.88      wiz      7633: <p>Used during bulk-installs to install required
                   7634:          packages. If an up-to-date binary package is available,
1.136     dholland 7635:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  7636:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7637:          but the installed binary won't be removed.</p>
1.88      wiz      7638: <p>A binary package is considered
1.128     wiz      7639:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.136     dholland 7640:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     7641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7642: <li class="listitem"><p>None of the package's files
1.88      wiz      7643:              (<code class="filename">Makefile</code>, ...) were modified
                   7644:              since it was built.</p></li>
1.128     wiz      7645: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      7646:              packages were modified since it was built.</p></li>
1.75      rillig   7647: </ul></div>
1.88      wiz      7648: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7649:          all packages installed on a system!</em></span></p>
1.75      rillig   7650: </dd>
                   7651: </dl></div>
                   7652: </div>
                   7653: </div>
1.148     asau     7654: <div class="chapter">
1.75      rillig   7655: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7656: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7657: <div class="toc">
                   7658: <p><b>Table of Contents</b></p>
                   7659: <dl>
1.106     rillig   7660: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7661: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7662: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7663: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7664: </dl>
                   7665: </div>
1.87      wiz      7666: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7667: by pkgsrc and also for individual packages to define what commands
                   7668: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7669: or for later run-time of an installed packaged (such as
                   7670: <code class="varname">DEPENDS</code>).
                   7671: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7672: package will not be used.</p>
                   7673: <p>When building a package, the replacement tools are
1.75      rillig   7674: made available in a directory (as symlinks or wrapper scripts)
                   7675: that is early in the executable search path. Just like the buildlink
1.87      wiz      7676: system, this helps with consistent builds.</p>
                   7677: <p>A tool may be needed to help build a specific package. For example,
                   7678: perl, GNU make (gmake) or yacc may be needed.</p>
                   7679: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7680: tool may be inefficient for building a package with pkgsrc.
                   7681: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7682: yacc) or a better sed.</p>
                   7683: <p>The tools used by a package can be listed by running
1.110     hubertf  7684: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     7685: <div class="sect1">
1.75      rillig   7686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7687: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7688: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7689: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7690: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7691: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7692: These can be seen by running:
1.110     hubertf  7693: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7694: <p>If a package needs a specific program to build
1.75      rillig   7695: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7696: to define the tools needed.</p>
1.75      rillig   7697: </div>
1.148     asau     7698: <div class="sect1">
1.75      rillig   7699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7700: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      7701: <p>In the following examples, the :run means that it is needed at
                   7702: run-time (and becomes a DEPENDS).
1.75      rillig   7703: The default is a build dependency which can be set with
                   7704: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7705: and pkg-config:build.)</p>
1.75      rillig   7706: <pre class="programlisting">
                   7707: USE_TOOLS+=     gmake perl:run pkg-config
                   7708: </pre>
1.87      wiz      7709: <p>When using the tools framework, a
1.75      rillig   7710: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7711: which contains the full path to the appropriate tool. For example,
1.128     wiz      7712: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      7713: on Linux systems.</p>
                   7714: <p>If you always need a pkgsrc version of the
1.75      rillig   7715: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7716: </p>
                   7717: </div>
1.148     asau     7718: <div class="sect1">
1.75      rillig   7719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7720: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7721: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7722: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7723: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7724: the name of the common tools. For example:</p>
                   7725: <pre class="programlisting">
                   7726: .if exists(/usr/bin/bzcat)
                   7727: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7728: .elif exists(/usr/bin/bzip2)
                   7729: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7730: .endif
1.69      rillig   7731: 
1.75      rillig   7732: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7733: </pre>
                   7734: </div>
1.148     asau     7735: <div class="sect1">
1.97      rillig   7736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7737: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148     asau     7738: <div class="qandaset">
1.173   ! wiz      7739: <a name="idm73061424"></a><dl>
1.106     rillig   7740: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7741: </dt>
1.106     rillig   7742: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7743:        tools?</a>
                   7744: </dt>
1.106     rillig   7745: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7746:        package is using while being built? I want to know whether it
                   7747:        uses sed or not.</a>
                   7748: </dt>
                   7749: </dl>
1.148     asau     7750: <table border="0" style="width: 100%;">
                   7751: <colgroup>
1.97      rillig   7752: <col align="left" width="1%">
1.128     wiz      7753: <col>
1.148     asau     7754: </colgroup>
1.97      rillig   7755: <tbody>
1.148     asau     7756: <tr class="question">
1.97      rillig   7757: <td align="left" valign="top">
1.173   ! wiz      7758: <a name="tools.new"></a><a name="idm73061040"></a><p><b>18.4.1.</b></p>
1.97      rillig   7759: </td>
                   7760: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7761: </tr>
                   7762: <tr class="answer">
                   7763: <td align="left" valign="top"></td>
                   7764: <td align="left" valign="top"><p>TODO</p></td>
                   7765: </tr>
1.148     asau     7766: <tr class="question">
1.97      rillig   7767: <td align="left" valign="top">
1.173   ! wiz      7768: <a name="tools.listall"></a><a name="idm73060016"></a><p><b>18.4.2.</b></p>
1.97      rillig   7769: </td>
                   7770: <td align="left" valign="top"><p>How do I get a list of all available
                   7771:        tools?</p></td>
                   7772: </tr>
                   7773: <tr class="answer">
                   7774: <td align="left" valign="top"></td>
                   7775: <td align="left" valign="top"><p>TODO</p></td>
                   7776: </tr>
1.148     asau     7777: <tr class="question">
1.97      rillig   7778: <td align="left" valign="top">
1.173   ! wiz      7779: <a name="tools.used"></a><a name="idm73058992"></a><p><b>18.4.3.</b></p>
1.97      rillig   7780: </td>
                   7781: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7782:        package is using while being built? I want to know whether it
                   7783:        uses sed or not.</p></td>
                   7784: </tr>
                   7785: <tr class="answer">
                   7786: <td align="left" valign="top"></td>
                   7787: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7788:        to do it.)</p></td>
                   7789: </tr>
                   7790: </tbody>
                   7791: </table>
                   7792: </div>
                   7793: </div>
1.75      rillig   7794: </div>
1.148     asau     7795: <div class="chapter">
1.75      rillig   7796: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7797: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7798: <div class="toc">
                   7799: <p><b>Table of Contents</b></p>
                   7800: <dl>
1.106     rillig   7801: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7802: <dd><dl>
1.106     rillig   7803: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.128     wiz      7804: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.106     rillig   7805: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7806: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7807: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7808: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7809: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7810: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7811: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7812: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7813: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7814: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7815: </dl></dd>
1.128     wiz      7816: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   7817: <dd><dl>
                   7818: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7819: <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>
                   7820: </dl></dd>
1.128     wiz      7821: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   7822: <dd><dl>
                   7823: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7824: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7825: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7826: </dl></dd>
                   7827: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7828: <dd><dl>
                   7829: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7830: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7831: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      7832: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   7833: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   7834: </dl></dd>
1.128     wiz      7835: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   7836: <dd><dl>
                   7837: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7838: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      7839: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.106     rillig   7840: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7841: </dl></dd>
1.128     wiz      7842: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   7843: <dd><dl>
                   7844: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7845: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7846: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7847: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7848: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7849: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7850: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7851: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7852: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   7853: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7854: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7855: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7856: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7857: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7858: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7859: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7860: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7861: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7862:     emulation</a></span></dt>
1.106     rillig   7863: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7864: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7865: </dl></dd>
1.106     rillig   7866: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7867: </dl>
                   7868: </div>
1.148     asau     7869: <div class="sect1">
1.75      rillig   7870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7871: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.148     asau     7872: <div class="sect2">
1.75      rillig   7873: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7874: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7875: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7876:     different platforms. As a result, it is important to ensure,
                   7877:     where possible, that packages in pkgsrc are portable. This
                   7878:     chapter mentions some particular details you should pay
                   7879:     attention to while working on pkgsrc.</p>
1.78      rillig   7880: </div>
1.148     asau     7881: <div class="sect2">
1.78      rillig   7882: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7883: <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   7884: </h3></div></div></div>
1.78      rillig   7885: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7886:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7887:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7888:     want to use those variables in the preprocessor directives of
1.136     dholland 7889:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7890:     <code class="literal">.for</code>), you need to include the file
                   7891:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7892:     loads the user preferences.</p>
1.78      rillig   7893: <p>But note that some variables may not be completely defined
1.87      wiz      7894:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7895:     included, as they may contain references to variables that are
                   7896:     not yet defined. In shell commands this is no problem, since
                   7897:     variables are actually macros, which are only expanded when they
                   7898:     are used. But in the preprocessor directives mentioned above and
                   7899:     in dependency lines (of the form <code class="literal">target:
                   7900:     dependencies</code>) the variables are expanded at load
                   7901:     time.</p>
1.148     asau     7902: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7903: <h3 class="title">Note</h3>
                   7904: <p>Currently there is no exhaustive list of all
1.87      wiz      7905:     variables that tells you whether they can be used at load time
                   7906:     or only at run time, but it is in preparation.</p>
1.78      rillig   7907: </div>
                   7908: </div>
1.148     asau     7909: <div class="sect2">
1.78      rillig   7910: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7911: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7912: <p>Occasionally, packages require interaction from the user,
                   7913:     and this can be in a number of ways:</p>
1.148     asau     7914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7915: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7916:        interaction such as entering username/password or accepting a
                   7917:        license on a web page.</p></li>
1.128     wiz      7918: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7919:        passwords.</p></li>
1.128     wiz      7920: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7921: <li class="listitem"><p>help during the build process</p></li>
                   7922: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7923: </ul></div>
1.88      wiz      7924: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7925:     provided to notify the pkgsrc mechanism of an interactive stage
                   7926:     which will be needed, and this should be set in the package's
                   7927:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7928: <pre class="programlisting">
1.100     rillig   7929: INTERACTIVE_STAGE=      build
1.87      wiz      7930:     </pre>
1.78      rillig   7931: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7932: <pre class="programlisting">
1.100     rillig   7933: INTERACTIVE_STAGE=      configure install
1.87      wiz      7934:     </pre>
1.88      wiz      7935: <p>The user can then decide to skip this package by setting the
                   7936:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7937: </div>
1.148     asau     7938: <div class="sect2">
1.75      rillig   7939: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7940: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7941: <p>Authors of software can choose the licence under which
                   7942:     software can be copied.  This is due to copyright law, and reasons
                   7943:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7944:     system recognizes that there are a number of licenses which some
                   7945:     users may find objectionable or difficult or impossible to comply
                   7946:     with.  The Free Software Foundation has declared some licenses
                   7947:     "Free", and the Open Source Initiative has a definition of "Open
                   7948:     Source".  The pkgsrc system, as a policy choice, does not label
                   7949:     packages which have licenses that are Free or Open Source.
                   7950:     However, packages without a license meeting either of those tests
                   7951:     are labeled with a license tag denoting the license.  Note that a
                   7952:     package with no license to copy trivially does not meet either the
                   7953:     Free or Open Source test.</p>
                   7954: <p>For packages which are not Free or Open Source, pkgsrc will
                   7955:     not build the package unless the user has indicated to pkgsrc that
                   7956:     packages with that particular license may be built.  Note that
                   7957:     this documentation avoids the term "accepted the license".  The
                   7958:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7959:     accidentally building a package with a non-free license;
1.98      wiz      7960:     judgement and responsibility remain with the user.  (Installation
                   7961:     of binary packages are not currently subject to this mechanism;
                   7962:     this is a bug.)</p>
                   7963: <p>One might want to only install packages with a BSD license,
1.121     jnemeth  7964:     or the GPL, and not the other.  The free licenses are added to the 
                   7965:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7966:     user can override the default by setting the
                   7967:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7968:     of "+=".  The licenses accepted by default are:
                   7969:     </p>
                   7970: <pre class="programlisting">
1.154     rodent   7971:        apache-1.1 apache-2.0
                   7972:        arphic-public
                   7973:        artistic artistic-2.0
                   7974:        boost-license
                   7975:        cc-by-sa-v3.0
1.161     ryoon    7976:        cc0-1.0-universal
1.154     rodent   7977:        cddl-1.0
                   7978:        cpl-1.0
                   7979:        epl-v1.0
                   7980:        gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7981:        gnu-gpl-v1
                   7982:        gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7983:        gnu-gpl-v3 gnu-lgpl-v3
                   7984:        ibm-public-license-1.0
                   7985:        ipafont
                   7986:        isc
                   7987:        lppl-1.3c
                   7988:        lucent
                   7989:        miros
                   7990:        mit
                   7991:        mpl-1.0 mpl-1.1 mpl-2.0
                   7992:        mplusfont
                   7993:        ofl-v1.0 ofl-v1.1
                   7994:        original-bsd modified-bsd 2-clause-bsd
                   7995:        php
                   7996:        png-license
                   7997:        postgresql-license
                   7998:        public-domain
                   7999:        python-software-foundation
                   8000:        qpl-v1.0
1.158     rodent   8001:        sgi-free-software-b-v2.0
1.154     rodent   8002:        sleepycat-public
                   8003:        unlicense
                   8004:        x11
                   8005:        zlib
                   8006:        zpl
1.121     jnemeth  8007:     </pre>
                   8008: <p>
                   8009:     </p>
1.78      rillig   8010: <p>The license tag mechanism is intended to address
1.87      wiz      8011:     copyright-related issues surrounding building, installing and
                   8012:     using a package, and not to address redistribution issues (see
                   8013:     <code class="varname">RESTRICTED</code> and
1.121     jnemeth  8014:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   8015:     Packages with redistribution restrictions should set these
                   8016:     tags.</p>
1.98      wiz      8017: <p>Denoting that a package may be copied according to a
                   8018:     particular license is done by placing the license in
1.87      wiz      8019:     <code class="filename">pkgsrc/licenses</code> and setting the
                   8020:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   8021:     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      8022: <pre class="programlisting">
1.100     rillig   8023: LICENSE=        xv-license
1.87      wiz      8024:     </pre>
                   8025: <p>When trying to build, the user will get a notice that the
1.98      wiz      8026:     package is covered by a license which has not been placed in the
                   8027:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      8028: <pre class="programlisting">
1.100     rillig   8029: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8030: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   8031: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   8032: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   8033: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   8034: *** Error code 1
1.87      wiz      8035:     </pre>
1.110     hubertf  8036: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      8037:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  8038:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      8039:     convey to pkgsrc that it should not in the future fail because of
                   8040:     that license:</p>
1.78      rillig   8041: <pre class="programlisting">
1.100     rillig   8042: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      8043:     </pre>
1.154     rodent   8044: <p>When adding a package with a new license, the following steps
                   8045:     are required:</p>
                   8046: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8047: <li class="listitem">
                   8048: <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>.  If this is the case, additionally add the license filename to:</p>
                   8049: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8050: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   8051: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158     rodent   8052: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154     rodent   8053: </ul></div>
                   8054: <p>with the proper syntax as demonstrated in those files, respectively.</p>
                   8055: </li>
                   8056: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known licenses can be seen in this directory.</p></li>
                   8057: </ol></div>
1.98      wiz      8058: <p>When the license changes (in a way other than formatting),
                   8059:     please make sure that the new license has a different name (e.g.,
                   8060:     append the version number if it exists, or the date).  Just
                   8061:     because a user told pkgsrc to build programs under a previous
                   8062:     version of a license does not mean that pkgsrc should build
1.99      rillig   8063:     programs under the new licenses.  The higher-level point is that
1.98      wiz      8064:     pkgsrc does not evaluate licenses for reasonableness; the only
                   8065:     test is a mechanistic test of whether a particular text has been
                   8066:     approved by either of two bodies.</p>
1.78      rillig   8067: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      8068:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   8069:     is deprecated because it does not crisply refer to a particular
                   8070:     license text.  Another problem with such usage is that it does not
                   8071:     enable a user to tell pkgsrc to proceed for a single package
                   8072:     without also telling pkgsrc to proceed for all packages with that
                   8073:     tag.</p>
1.75      rillig   8074: </div>
1.148     asau     8075: <div class="sect2">
1.75      rillig   8076: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8077: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   8078: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      8079:     Because a license tag is required unless the package is Free or
                   8080:     Open Source, all packages with restrictions should have license
                   8081:     tags.  By declaring the restrictions, package tools can
                   8082:     automatically refrain from e.g. placing binary packages on FTP
                   8083:     sites.</p>
                   8084: <p>There are four restrictions that may be encoded, which are
                   8085:     the cross product of sources (distfiles) and binaries not being
                   8086:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   8087:     language in any license, and because non-Free licenses tend to be
                   8088:     different from each other, pkgsrc adopts a definition of FTP and
                   8089:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   8090:     should not be made available over the Internet at no charge.
                   8091:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   8092:     made available on some kind of media, together with other source
                   8093:     and binary packages, and which is sold for a distribution charge.
                   8094:     </p>
                   8095: <p>In order to encode these restrictions, the package system
1.87      wiz      8096:     defines five make variables that can be set to note these
                   8097:     restrictions:</p>
1.148     asau     8098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8099: <li class="listitem">
1.75      rillig   8100: <p><code class="varname">RESTRICTED</code></p>
                   8101: <p>This variable should be set whenever a restriction
1.87      wiz      8102:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      8103:        string containing the reason for the restriction.  It should
                   8104:        be understood that those wanting to understand the restriction
                   8105:        will have to read the license, and perhaps seek advice of
                   8106:        counsel.</p>
1.75      rillig   8107: </li>
1.128     wiz      8108: <li class="listitem">
1.75      rillig   8109: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      8110: <p>Binaries may not be placed on CD-ROM containing other
                   8111:        binary packages, for which a distribution charge may be made.
                   8112:        In this case, set this variable to
                   8113:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   8114: </li>
1.128     wiz      8115: <li class="listitem">
1.75      rillig   8116: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      8117: <p>Binaries may not made available on the Internet without
                   8118:        charge.  In this case, set this variable to
                   8119:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   8120:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   8121: </li>
1.128     wiz      8122: <li class="listitem">
1.75      rillig   8123: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      8124: <p>Distfiles may not be placed on CD-ROM, together with
                   8125:        other distfiles, for which a fee may be charged.  In this
                   8126:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   8127:        </p>
1.75      rillig   8128: </li>
1.128     wiz      8129: <li class="listitem">
1.75      rillig   8130: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      8131: <p>Distfiles may not made available via FTP at no charge.
                   8132:        In this case, set this variable to
                   8133:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   8134:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   8135: </li>
                   8136: </ul></div>
1.139     wiz      8137: <p>Please note that packages will to be removed from pkgsrc
                   8138:     when the distfiles are not distributable and cannot be obtained
                   8139:     for a period of one full quarter branch. Packages with manual /
                   8140:     interactive fetch must have a maintainer and it is his/her
                   8141:     responsibility to ensure this.</p>
1.75      rillig   8142: </div>
1.148     asau     8143: <div class="sect2">
1.75      rillig   8144: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8145: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   8146: <p>Your package may depend on some other package being present
1.88      wiz      8147:     - and there are various ways of expressing this dependency.
                   8148:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   8149:     <code class="varname">DEPENDS</code> definitions, the
                   8150:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   8151:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   8152:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  8153:     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   8154: <p>The basic difference between the two variables is as
1.87      wiz      8155:     follows: The <code class="varname">DEPENDS</code> definition registers
                   8156:     that pre-requisite in the binary package so it will be pulled in
                   8157:     when the binary package is later installed, whilst the
                   8158:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   8159:     dependency that is only needed for building the package.</p>
1.75      rillig   8160: <p>This means that if you only need a package present whilst
1.87      wiz      8161:     you are building, it should be noted as a
                   8162:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   8163: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      8164:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   8165: <pre class="programlisting">
1.100     rillig   8166: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      8167:     </pre>
1.128     wiz      8168: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      8169:     may include any of the wildcard version numbers recognized by
1.136     dholland 8170:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      8171: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8172: <li class="listitem">
1.75      rillig   8173: <p>If your package needs another package's binaries or
1.160     wiz      8174:        libraries to build and run, and if that package has a
1.87      wiz      8175:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   8176: <pre class="programlisting">
1.100     rillig   8177: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      8178:        </pre>
1.75      rillig   8179: </li>
1.128     wiz      8180: <li class="listitem">
1.160     wiz      8181: <p>If your package needs another package's binaries or
                   8182:        libraries only for building, and if that package has a
                   8183:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   8184: <pre class="programlisting">
                   8185: .include "../../graphics/jpeg/buildlink3.mk"
                   8186:        </pre>
                   8187: <p>but set
                   8188:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   8189:        to make it a build dependency only. This case is rather
                   8190:        rare.</p>
                   8191: </li>
                   8192: <li class="listitem">
1.132     spz      8193: <p>If your package needs binaries from another package to build,
                   8194:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   8195: <pre class="programlisting">
1.132     spz      8196: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87      wiz      8197:        </pre>
1.75      rillig   8198: </li>
1.132     spz      8199: <li class="listitem"><p>If your package needs a library with which to link and
                   8200:        there is no <code class="filename">buildlink3.mk</code> file
                   8201:        available, create one. Using
                   8202:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   8203:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      8204: <li class="listitem">
1.132     spz      8205: <p>If your package needs some executable to be able to run
                   8206:        correctly and if there's no
                   8207:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8208:        using the <code class="varname">DEPENDS</code> variable. The
                   8209:        <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
                   8210:        be able to execute the latex binary from the teTeX package
                   8211:        when it runs, and that is specified:</p>
1.75      rillig   8212: <pre class="programlisting">
1.132     spz      8213: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      8214:        </pre>
1.132     spz      8215: </li>
                   8216: <li class="listitem">
                   8217: <p>You can use wildcards in package dependencies. Note that
                   8218:        such wildcard dependencies are retained when creating binary
                   8219:        packages. The dependency is checked when installing the binary
                   8220:        package and any package which matches the pattern will be
                   8221:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      8222: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   8223:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   8224:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   8225:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   8226: <p>Wildcards can also be used to specify that a package
1.87      wiz      8227:        will only build against a certain minimum version of a
                   8228:        pre-requisite:</p>
1.75      rillig   8229: <pre class="programlisting">
1.132     spz      8230: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.87      wiz      8231:        </pre>
1.132     spz      8232: <p>This means that the package will build using version 6.0
                   8233:        of ImageMagick or newer. Such a dependency may be warranted
                   8234:        if, for example, the command line options of an executable
                   8235:        have changed.</p>
                   8236: <p>If you need to depend on minimum versions of libraries,
                   8237:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   8238: <p>For security fixes, please update the package
1.110     hubertf  8239:        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      8240:        information.</p>
1.75      rillig   8241: </li>
1.165     bsiegert 8242: <li class="listitem">
                   8243: <p>If the package depends on either one of two (or more)
                   8244:        packages, specify the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span> as a
                   8245:        comma-separated list between curly braces.</p>
                   8246: <p>As an example, take a package that depends on the Perl
                   8247:        <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> module, which has been part of Perl
                   8248:        itself since version 5.10.0. This either/or dependency is
                   8249:        expressed as:</p>
                   8250: <pre class="programlisting">
                   8251: DEPENDS+=      {perl&gt;=5.10.0,p5-version-[0-9]*}:../../devel/p5-version
                   8252:        </pre>
                   8253: </li>
1.75      rillig   8254: </ol></div>
                   8255: <p>If your package needs files from another package to build,
1.87      wiz      8256:     add the relevant distribution files to
                   8257:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   8258:     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      8259:     (It relies on the jpeg sources being present in source form
                   8260:     during the build.)</p>
1.75      rillig   8261: </div>
1.148     asau     8262: <div class="sect2">
1.75      rillig   8263: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8264: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8265: <p>Your package may conflict with other packages a user might
1.87      wiz      8266:     already have installed on his system, e.g. if your package
1.88      wiz      8267:     installs the same set of files as another package in the pkgsrc
                   8268:     tree.</p>
1.75      rillig   8269: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8270:     space-separated list of packages (including version string) your
                   8271:     package conflicts with.</p>
1.91      rillig   8272: <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>
                   8273:     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      8274:     install the same shared library, thus you set in
                   8275:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8276: <pre class="programlisting">
1.100     rillig   8277: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8278:     </pre>
                   8279: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8280: <pre class="programlisting">
1.100     rillig   8281: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8282:     </pre>
1.75      rillig   8283: <p>Packages will automatically conflict with other packages
1.87      wiz      8284:     with the name prefix and a different version
1.128     wiz      8285:     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
                   8286:     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
1.75      rillig   8287: </div>
1.148     asau     8288: <div class="sect2">
1.75      rillig   8289: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8290: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8291: <p>There are several reasons why a package might be
1.88      wiz      8292:     instructed to not build under certain circumstances.  If the
1.87      wiz      8293:     package builds and runs on most platforms, the exceptions
                   8294:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8295:     the package builds and runs on a small handful of platforms,
                   8296:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8297:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8298:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8299:     (OS-version-platform) that can use glob-style
                   8300:     wildcards.</p>
1.88      wiz      8301: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8302:     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      8303:     backwards compatible with other versions of the OS, and should be
                   8304:     uploaded to a version specific directory on the FTP server.  Mark
                   8305:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      8306:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      8307:     the package system internals, but may be used in the
                   8308:     future.</p>
1.75      rillig   8309: <p>If the package should be skipped (for example, because it
1.87      wiz      8310:     provides functionality already provided by the system), set
1.88      wiz      8311:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8312:     the package should fail because some preconditions are not met,
                   8313:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8314:     message.</p>
1.75      rillig   8315: </div>
1.148     asau     8316: <div class="sect2">
1.75      rillig   8317: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8318: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8319: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8320:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8321:     be set in the package Makefile. This will be carried into any
                   8322:     binary package that is made from this pkgsrc entry. A
1.128     wiz      8323:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.136     dholland 8324:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      8325:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   8326: </div>
1.148     asau     8327: <div class="sect2">
1.75      rillig   8328: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8329: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8330: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8331:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      8332:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   8333:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   8334: <p>After fixing the vulnerability by a patch, its
1.138     wiz      8335:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8336:     course not necessary if the problem is fixed by using a newer
                   8337:     release of the software), and the pattern in the
                   8338:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   8339: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8340:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8341: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8342:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8343: </div>
1.148     asau     8344: <div class="sect2">
1.75      rillig   8345: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8346: <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   8347: <p>When making fixes to an existing package it can be useful
1.87      wiz      8348:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8349:     avoid conflicting with future versions by the original author, a
1.128     wiz      8350:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      8351:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      8352:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8353:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      8354: <pre class="programlisting">
1.100     rillig   8355: DISTNAME=       foo-17.42
                   8356: PKGREVISION=    9
1.87      wiz      8357:     </pre>
1.75      rillig   8358: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      8359:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8360:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      8361:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8362:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8363: <p>When a new release of the package is released, the
1.87      wiz      8364:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8365:     minor release of the above package, things should be like:</p>
1.75      rillig   8366: <pre class="programlisting">
1.100     rillig   8367: DISTNAME=       foo-17.43
1.87      wiz      8368:     </pre>
                   8369: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8370:     non-trivial change in the resulting binary package.  Without a
                   8371:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8372:     version installed has no way of knowing that their package is out
                   8373:     of date.  Thus, changes without increasing
                   8374:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8375:     trivial that no reasonable person would want to upgrade", and this
                   8376:     is the rough test for when increasing
                   8377:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8378:     changes that do not merit increasing
                   8379:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     8380: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8381: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 8382:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8383:       or comments in Makefile.</p></li>
1.128     wiz      8384: <li class="listitem"><p>
1.100     rillig   8385:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      8386: <li class="listitem"><p>
1.100     rillig   8387:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      8388: <li class="listitem"><p>
1.100     rillig   8389:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8390: </ul></div>
1.87      wiz      8391: <p>Examples of changes that do merit an increase to
                   8392:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     8393: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8394: <li class="listitem"><p>
1.100     rillig   8395:       Security fixes</p></li>
1.128     wiz      8396: <li class="listitem"><p>
1.100     rillig   8397:       Changes or additions to a patch file</p></li>
1.128     wiz      8398: <li class="listitem"><p>
1.100     rillig   8399:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      8400: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8401: </ul></div>
1.78      rillig   8402: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8403:     changes.</p>
1.75      rillig   8404: </div>
1.148     asau     8405: <div class="sect2">
1.79      rillig   8406: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8407: <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   8408: <p>When you want to replace the same text in multiple files
1.87      wiz      8409:     or when the replacement text varies, patches alone cannot help.
                   8410:     This is where the SUBST framework comes in. It provides an
                   8411:     easy-to-use interface for replacing text in files.
                   8412:     Example:</p>
                   8413: <pre class="programlisting">
1.100     rillig   8414: SUBST_CLASSES+=                 fix-paths
                   8415: SUBST_STAGE.fix-paths=          pre-configure
                   8416: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8417: SUBST_FILES.fix-paths=          src/*.c
                   8418: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8419: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8420: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8421:     </pre>
1.79      rillig   8422: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8423:     that are used to identify the different SUBST blocks that are
                   8424:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8425:     important to always use the <code class="literal">+=</code> operator with
                   8426:     this variable. Otherwise some substitutions may be
                   8427:     skipped.</p>
1.79      rillig   8428: <p>The remaining variables of each SUBST block are
1.87      wiz      8429:     parameterized with the identifier from the first line
                   8430:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8431:     parameters to a function call.</p>
1.79      rillig   8432: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8433:     which the replacement will take place. All combinations of
                   8434:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8435:     <code class="literal">post-</code> together with a phase name are
                   8436:     possible, though only few are actually used. Most commonly used
                   8437:     are <code class="literal">post-patch</code> and
                   8438:     <code class="literal">pre-configure</code>. Of these two,
                   8439:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8440:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8441:     have the state after applying the patches but before making any
                   8442:     other changes. This is especially useful when you are debugging
                   8443:     a package in order to create new patches for it. Similarly,
                   8444:     <code class="literal">post-build</code> is preferred over
                   8445:     <code class="literal">pre-install</code>, because the install phase should
                   8446:     generally be kept as simple as possible. When you use
                   8447:     <code class="literal">post-build</code>, you have the same files in the
                   8448:     working directory that will be installed later, so you can check
                   8449:     if the substitution has succeeded.</p>
1.79      rillig   8450: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8451:     that is printed just before the substitution is done.</p>
1.79      rillig   8452: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8453:     globbing patterns that specifies the files in which the
                   8454:     substitution will take place. The patterns are interpreted
                   8455:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8456: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.136     dholland 8457:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8458:     command should be prefixed with <code class="literal">-e</code>, so that
                   8459:     all SUBST blocks look uniform.</p>
1.79      rillig   8460: <p>There are some more variables, but they are so seldomly
1.87      wiz      8461:     used that they are only documented in the
                   8462:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8463: </div>
1.75      rillig   8464: </div>
1.148     asau     8465: <div class="sect1">
1.75      rillig   8466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8467: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8468: <div class="sect2">
1.75      rillig   8469: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8470: <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   8471: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8472:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8473:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8474:     with the name of each file to download as an argument, expecting
                   8475:     it to output the URL of the directory from which to download
1.91      rillig   8476:     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      8477:     example of this usage.</p>
1.75      rillig   8478: <p>If the download can't be automated, because the user must
1.87      wiz      8479:     submit personal information to apply for a password, or must pay
                   8480:     for the source, or whatever, you can set
                   8481:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8482:     displayed to the user before aborting the build. Example:</p>
                   8483: <pre class="programlisting">
1.100     rillig   8484: FETCH_MESSAGE=  "Please download the files"
                   8485: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8486: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8487:     </pre>
1.75      rillig   8488: </div>
1.148     asau     8489: <div class="sect2">
1.75      rillig   8490: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8491: <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   8492: <p>Sometimes authors of a software package make some
1.87      wiz      8493:     modifications after the software was released, and they put up a
                   8494:     new distfile without changing the package's version number. If a
                   8495:     package is already in pkgsrc at that time, the checksum will
                   8496:     no longer match. The contents of the new distfile should be
                   8497:     compared against the old one before changing anything, to make
                   8498:     sure the distfile was really updated on purpose, and that
                   8499:     no trojan horse or so crept in.
1.97      rillig   8500:     Please mention that the distfiles were compared and what was found
1.159     rodent   8501:     in your commit message.</p>
                   8502: <p>Then, the correct way to work around this is to
1.87      wiz      8503:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8504:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8505:     <code class="varname">DISTFILES</code> and
1.93      rillig   8506:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8507:     subdirectory of the local distfiles directory.
1.110     hubertf  8508:     (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   8509:     In case this
1.87      wiz      8510:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8511:     including the <code class="filename">nbX</code> suffix) or a date stamp
1.159     rodent   8512:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
                   8513: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
                   8514: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8515:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8516:     path in the filenames.
1.159     rodent   8517:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8518:     Furthermore, a mail to the package's authors seems appropriate
                   8519:     telling them that changing distfiles after releases without
                   8520:     changing the file names is not good practice.</p>
1.75      rillig   8521: </div>
                   8522: </div>
1.148     asau     8523: <div class="sect1">
1.75      rillig   8524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8525: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8526: <div class="sect2">
1.75      rillig   8527: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8528: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8529: <p>pkgsrc supports many different machines, with different
1.87      wiz      8530:     object formats like a.out and ELF, and varying abilities to do
                   8531:     shared library and dynamic loading at all. To accompany this,
                   8532:     varying commands and options have to be passed to the
                   8533:     compiler, linker, etc. to get the Right Thing, which can be
                   8534:     pretty annoying especially if you don't have all the machines
                   8535:     at your hand to test things.  The
1.91      rillig   8536:     <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.128     wiz      8537:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8538:     both static and dynamic libraries from a set of source files,
                   8539:     thus being platform-independent.</p>
                   8540: <p>Here's how to use libtool in a package in seven simple
                   8541:     steps:</p>
1.128     wiz      8542: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8543: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8544:        Makefile.</p></li>
1.128     wiz      8545: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8546:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8547:        add it to the definition of <code class="varname">CC</code>, if only
                   8548:        libraries are being built in a given Makefile. This one command
                   8549:        will build both PIC and non-PIC library objects, so you need not
                   8550:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8551: <li class="listitem">
1.75      rillig   8552: <p>For the linking of the library, remove any
1.128     wiz      8553:        <span class="quote">&#8220;<span class="quote">ar</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">ranlib</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">ld
                   8554:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8555: <pre class="programlisting">
1.100     rillig   8556: ${LIBTOOL} --mode=link \
                   8557:     ${CC} -o ${.TARGET:.a=.la} \
                   8558:         ${OBJS:.o=.lo} \
                   8559:         -rpath ${PREFIX}/lib \
                   8560:         -version-info major:minor
1.87      wiz      8561:        </pre>
1.75      rillig   8562: <p>Note that the library is changed to have a
1.87      wiz      8563:        <code class="filename">.la</code> extension, and the objects are
                   8564:        changed to have a <code class="filename">.lo</code>
                   8565:        extension. Change <code class="varname">OBJS</code> as
                   8566:        necessary. This automatically creates all of the
                   8567:        <code class="filename">.a</code>,
                   8568:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8569:        necessary) in the build directory. Be sure to include
1.128     wiz      8570:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8571:        minor are zero, as libtool will otherwise strip off the
                   8572:        shared library version.</p>
1.75      rillig   8573: <p>From the libtool manual:</p>
                   8574: <pre class="programlisting">
1.100     rillig   8575: So, libtool library versions are described by three integers:
1.69      rillig   8576: 
1.100     rillig   8577: CURRENT
                   8578: The most recent interface number that this library implements.
1.69      rillig   8579: 
1.100     rillig   8580: REVISION
                   8581: The implementation number of the CURRENT interface.
1.69      rillig   8582: 
1.100     rillig   8583: AGE
                   8584: The difference between the newest and oldest interfaces that
                   8585: this library implements.  In other words, the library implements
                   8586: all the interface numbers in the range from number `CURRENT -
                   8587: AGE' to `CURRENT'.
1.1       grant    8588: 
1.100     rillig   8589: If two libraries have identical CURRENT and AGE numbers, then the
                   8590: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8591:        </pre>
1.128     wiz      8592: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8593:        different results for a.out and ELF (excluding symlinks)
                   8594:        in only one case. An ELF library of the form
1.128     wiz      8595:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8596:        will have a symlink of
1.128     wiz      8597:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8598:        on an a.out platform. This is handled
                   8599:        automatically.</p>
1.128     wiz      8600: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8601:        directory of the library being built.</p>
1.76      rillig   8602: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8603:        <code class="filename">.la</code> file, the other files will be
                   8604:        added automatically.</p>
1.75      rillig   8605: </li>
1.128     wiz      8606: <li class="listitem">
1.76      rillig   8607: <p>When linking shared object (<code class="filename">.so</code>)
1.136     dholland 8608:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8609:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8610:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8611:        tacked on.</p>
1.76      rillig   8612: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8613:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8614: </li>
1.128     wiz      8615: <li class="listitem">
1.75      rillig   8616: <p>When linking programs that depend on these libraries
1.87      wiz      8617:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.136     dholland 8618:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8619:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8620:        libraries (static or shared), but please be aware that
                   8621:        libtool will not allow you to specify a relative path in
1.128     wiz      8622:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8623:        expects you to change that argument to be the
                   8624:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8625: <pre class="programlisting">
1.100     rillig   8626: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8627:        </pre>
1.75      rillig   8628: <p>should be changed to:</p>
                   8629: <pre class="programlisting">
1.100     rillig   8630: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8631:        </pre>
1.75      rillig   8632: <p>and it will do the right thing with the libraries.</p>
                   8633: </li>
1.128     wiz      8634: <li class="listitem">
1.136     dholland 8635: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8636:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8637:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8638:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8639: <pre class="programlisting">
1.126     jakllsch 8640: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8641:        </pre>
1.76      rillig   8642: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8643:        shared library, any needed symlinks, and run
1.136     dholland 8644:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8645: </li>
1.128     wiz      8646: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8647:        the <code class="filename">.la</code>
                   8648:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8649: </ol></div>
                   8650: </div>
1.148     asau     8651: <div class="sect2">
1.75      rillig   8652: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8653: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8654: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8655:     package Makefile. This will override the package's own libtool
                   8656:     in most cases.  For older libtool using packages,  libtool is
                   8657:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8658:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8659:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8660: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8661:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8662:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8663:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8664:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8665: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8666:     libraries built and installed, then use
                   8667:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8668: <p>If your package makes use of the platform-independent library
1.87      wiz      8669:     for loading dynamic shared objects, that comes with libtool
                   8670:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8671: <p>Some packages use libtool incorrectly so that the package
                   8672:     may not work or build in some circumstances. Some of the more
                   8673:     common errors are:</p>
1.148     asau     8674: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8675: <li class="listitem">
1.75      rillig   8676: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8677:        executable or library. This in itself isn't a problem if one of two things
                   8678:        has been done:</p>
1.128     wiz      8679: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8680: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8681:            <code class="filename">libfoo.la</code>, not
                   8682:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8683: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8684: </ol></div>
                   8685: </li>
1.128     wiz      8686: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8687:        The function lt_dlinit() should be called and the macro
                   8688:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8689:        executables.</p></li>
1.75      rillig   8690: </ul></div>
                   8691: </div>
1.148     asau     8692: <div class="sect2">
1.75      rillig   8693: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8694: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8695: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8696:     to regenerate the configure script and Makefile.in makefile
                   8697:     templates, then they should be executed in a pre-configure
                   8698:     target.</p>
1.75      rillig   8699: <p>For packages that need only autoconf:</p>
                   8700: <pre class="programlisting">
1.100     rillig   8701: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8702: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8703: ...
1.1       grant    8704: 
1.100     rillig   8705: pre-configure:
                   8706:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8707: 
1.100     rillig   8708: ...
1.87      wiz      8709:     </pre>
1.75      rillig   8710: <p>and for packages that need automake and autoconf:</p>
                   8711: <pre class="programlisting">
1.100     rillig   8712: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8713: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8714: ...
                   8715: 
                   8716: pre-configure:
                   8717:         set -e; cd ${WRKSRC}; \
                   8718:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8719: 
1.100     rillig   8720: ...
1.87      wiz      8721:     </pre>
1.75      rillig   8722: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8723:     require GNU Make.</p>
1.75      rillig   8724: <p>There are times when the configure process makes
1.87      wiz      8725:     additional changes to the generated files, which then causes
                   8726:     the build process to try to re-execute the automake sequence.
                   8727:     This is prevented by touching various files in the configure
                   8728:     stage. If this causes problems with your package you can set
                   8729:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8730:     Makefile.</p>
1.75      rillig   8731: </div>
                   8732: </div>
1.148     asau     8733: <div class="sect1">
1.75      rillig   8734: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8735: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     8736: <div class="sect2">
1.87      wiz      8737: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8738: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8739: <p>Compilers for the C, C++, and Fortran languages comes with
                   8740:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8741:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8742:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8743: <p>To declare which language's compiler a package needs, set
                   8744:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8745:     currently are <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">c++</span>&#8221;</span>, and
                   8746:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8747:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8748:     written in C++, usually need a C compiler for the configure
                   8749:     phase.</p>
                   8750: </div>
1.148     asau     8751: <div class="sect2">
1.87      wiz      8752: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8753: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8754: <p>If a program is written in Java, use the Java framework in
                   8755:     pkgsrc.  The package must include
                   8756:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8757:     provides the following variables:</p>
1.148     asau     8758: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8759: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8760:       dependency on the JDK is added.  If
1.128     wiz      8761:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8762:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8763:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8764:       JDK.</p></li>
1.128     wiz      8765: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8766:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8767:       are <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span>, and
                   8768:       <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span>.  <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> accepts any Java2
                   8769:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8770:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8771:       above. This variable is not set by default.</p></li>
1.130     wiz      8772: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8773:       automatically set to the runtime location of the used Java
                   8774:       implementation dependency. It may be used to set
                   8775:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8776:       needs this variable to be defined.
                   8777:       </p></li>
1.87      wiz      8778: </ul></div>
                   8779: </div>
1.148     asau     8780: <div class="sect2">
1.87      wiz      8781: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8782: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8783: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8784:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8785:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8786:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8787:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8788:     that you want adjusted.  Every occurrence of
                   8789:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8790:     path to the perl executable.</p>
                   8791: <p>If a particular version of perl is needed, set the
                   8792:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8793:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  8794: <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      8795:     about handling perl modules.</p>
                   8796: </div>
1.148     asau     8797: <div class="sect2">
1.87      wiz      8798: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      8799: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   8800: <p><code class="varname">REPLACE_SH</code>,
                   8801:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8802:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   8803:     hash bangs in files. Please use the appropriate one, prefering
                   8804:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
                   8805:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8806:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8807: </div>
1.148     asau     8808: <div class="sect2">
1.147     wiz      8809: <div class="titlepage"><div><div><h3 class="title">
                   8810: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8811: <p>Currently, there is no special handling for other languages
                   8812:     in pkgsrc.  If a compiler package provides a
                   8813:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8814:     just add a (build) dependency on the appropriate compiler
                   8815:     package.</p>
                   8816: </div>
                   8817: </div>
1.148     asau     8818: <div class="sect1">
1.87      wiz      8819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8820: <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   8821: <p>The most common failures when building a package are that
                   8822:        some platforms do not provide certain header files, functions or
                   8823:        libraries, or they provide the functions in a library that the
                   8824:        original package author didn't know. To work around this, you
                   8825:        can rewrite the source code in most cases so that it does not
                   8826:        use the missing functions or provides a replacement function.</p>
1.148     asau     8827: <div class="sect2">
1.77      rillig   8828: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8829: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8830: <p>If a package already comes with a GNU configure script, the
                   8831:        preferred way to fix the build failure is to change the
                   8832:        configure script, not the code. In the other cases, you can
                   8833:        utilize the C preprocessor, which defines certain macros
                   8834:        depending on the operating system and hardware architecture it
                   8835:        compiles for. These macros can be queried using for example
                   8836:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8837:        system, hardware architecture and compiler has its own macro.
                   8838:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8839:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8840:        are all defined, you know that you are using NetBSD on an i386
                   8841:        compatible CPU, and your compiler is GCC.</p>
                   8842: <p>The list of the following macros for hardware and
                   8843:        operating system depends on the compiler that is used. For
                   8844:        example, if you want to conditionally compile code on Solaris,
                   8845:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8846:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8847: <div class="sect3">
1.75      rillig   8848: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8849: <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   8850: <p>To distinguish between 4.4 BSD-derived systems and the
                   8851:         rest of the world, you should use the following code.</p>
                   8852: <pre class="programlisting">
1.100     rillig   8853: #include &lt;sys/param.h&gt;
                   8854: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8855: /* BSD-specific code goes here */
                   8856: #else
                   8857: /* non-BSD-specific code goes here */
                   8858: #endif
1.75      rillig   8859: </pre>
1.77      rillig   8860: <p>If this distinction is not fine enough, you can also test
                   8861:        for the following macros.</p>
1.75      rillig   8862: <pre class="programlisting">
1.151     obache   8863: Cygwin      __CYGWIN__
                   8864: DragonFly   __DragonFly__
1.100     rillig   8865: FreeBSD     __FreeBSD__
1.151     obache   8866: Haiku       __HAIKU__
1.100     rillig   8867: Interix     __INTERIX
                   8868: IRIX        __sgi (TODO: get a definite source for this)
                   8869: Linux       linux, __linux, __linux__
1.151     obache   8870: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8871: Minix3      __minix
1.100     rillig   8872: NetBSD      __NetBSD__
                   8873: OpenBSD     __OpenBSD__
                   8874: Solaris     sun, __sun
1.75      rillig   8875: </pre>
                   8876: </div>
1.148     asau     8877: <div class="sect3">
1.75      rillig   8878: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8879: <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   8880: <pre class="programlisting">
1.100     rillig   8881: i386        i386, __i386, __i386__
                   8882: MIPS        __mips
                   8883: SPARC       sparc, __sparc
1.75      rillig   8884: </pre>
                   8885: </div>
1.148     asau     8886: <div class="sect3">
1.75      rillig   8887: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8888: <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   8889: <pre class="programlisting">
1.100     rillig   8890: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8891: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8892: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8893: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8894: </pre>
                   8895: </div>
                   8896: </div>
1.148     asau     8897: <div class="sect2">
1.78      rillig   8898: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8899: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8900: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8901:         combinations of compiler version and architecture and almost
                   8902:         always relation to optimisation being enabled.  Common symptoms
                   8903:         are gcc internal errors or never finishing compiling a
1.78      rillig   8904:        file.</p>
                   8905: <p>Typically, a workaround involves testing the
                   8906:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8907:         optimisation for that combination of file,
                   8908:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8909:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8910:        number of examples.</p>
                   8911: </div>
1.148     asau     8912: <div class="sect2">
1.78      rillig   8913: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      8914: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8915: </h3></div></div></div>
1.92      rillig   8916: <p>This error message often means that a package did not
1.78      rillig   8917:        link to a shared library it needs. The following functions are
                   8918:        known to cause this error message over and over.</p>
                   8919: <div class="informaltable">
                   8920: <a name="undefined-reference-functions"></a><table border="1">
                   8921: <colgroup>
                   8922: <col>
                   8923: <col>
                   8924: <col>
                   8925: </colgroup>
                   8926: <thead><tr>
                   8927: <th>Function</th>
                   8928: <th>Library</th>
                   8929: <th>Affected platforms</th>
                   8930: </tr></thead>
                   8931: <tbody>
                   8932: <tr>
                   8933: <td>accept, bind, connect</td>
                   8934: <td>-lsocket</td>
                   8935: <td>Solaris</td>
                   8936: </tr>
                   8937: <tr>
                   8938: <td>crypt</td>
                   8939: <td>-lcrypt</td>
                   8940: <td>DragonFly, NetBSD</td>
                   8941: </tr>
                   8942: <tr>
                   8943: <td>dlopen, dlsym</td>
                   8944: <td>-ldl</td>
                   8945: <td>Linux</td>
                   8946: </tr>
                   8947: <tr>
                   8948: <td>gethost*</td>
                   8949: <td>-lnsl</td>
                   8950: <td>Solaris</td>
                   8951: </tr>
                   8952: <tr>
                   8953: <td>inet_aton</td>
                   8954: <td>-lresolv</td>
                   8955: <td>Solaris</td>
                   8956: </tr>
                   8957: <tr>
                   8958: <td>nanosleep, sem_*, timer_*</td>
                   8959: <td>-lrt</td>
                   8960: <td>Solaris</td>
                   8961: </tr>
                   8962: <tr>
                   8963: <td>openpty</td>
                   8964: <td>-lutil</td>
                   8965: <td>Linux</td>
                   8966: </tr>
                   8967: </tbody>
                   8968: </table>
                   8969: </div>
                   8970: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8971:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8972:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8973:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8974:     bmake</strong></span>.</p>
1.148     asau     8975: <div class="sect3">
1.92      rillig   8976: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8977: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8978: <p>When you are using the SunPro compiler, there is another
                   8979: possibility. That compiler cannot handle the following code:</p>
                   8980: <pre class="programlisting">
1.100     rillig   8981: extern int extern_func(int);
1.93      rillig   8982: 
1.100     rillig   8983: static inline int
                   8984: inline_func(int x)
                   8985: {
1.92      rillig   8986:         return extern_func(x);
1.100     rillig   8987: }
1.93      rillig   8988: 
1.100     rillig   8989: int main(void)
                   8990: {
1.92      rillig   8991:         return 0;
1.100     rillig   8992: }
1.92      rillig   8993: </pre>
                   8994: <p>It generates the code for <code class="function">inline_func</code> even if
                   8995: that function is never used. This code then refers to
                   8996: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8997: solve this problem you can try to tell the package to disable inlining
                   8998: of functions.</p>
                   8999: </div>
1.87      wiz      9000: </div>
1.148     asau     9001: <div class="sect2">
1.87      wiz      9002: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9003: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      9004: <p>Sometimes packages fail to build because the compiler runs
                   9005:     into an operating system specific soft limit.  With the
                   9006:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   9007:     to unlimit the resources.  Currently, the allowed values are
1.128     wiz      9008:     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> (or both).
1.87      wiz      9009:     Setting this variable is similar to running the shell builtin
1.110     hubertf  9010:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      9011:     segment size or maximum stack size of a process, respectively, to
                   9012:     their hard limits.</p>
1.78      rillig   9013: </div>
1.75      rillig   9014: </div>
1.148     asau     9015: <div class="sect1">
1.75      rillig   9016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9017: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     9018: <div class="sect2">
1.75      rillig   9019: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9020: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  9021: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      9022:     with some operating systems cannot create more than one
                   9023:     directory at a time. As such, you should call
                   9024:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   9025: <pre class="programlisting">
1.100     rillig   9026: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   9027: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      9028:     </pre>
1.128     wiz      9029: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   9030:     dir2</code></span>&#8221;</span> to the
1.87      wiz      9031:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   9032:     automatically do the right thing.</p>
1.75      rillig   9033: </div>
1.148     asau     9034: <div class="sect2">
1.75      rillig   9035: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9036: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      9037: <p>In general, documentation should be installed into
1.87      wiz      9038:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9039:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   9040:     includes the version number of the package).</p>
1.84      wiz      9041: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      9042:     directory where HTML documentation is installed with the
1.128     wiz      9043:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      9044:     is needed because otherwise the documentation ends up in
                   9045:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   9046:     places.</p>
                   9047: <p>An exception to the above is that library API documentation
1.91      rillig   9048:     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      9049:     browsers (devhelp) should be left at their default location, which
                   9050:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   9051:     documentation can be recognized from files ending in
                   9052:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   9053:     (It is also acceptable to install such files in
                   9054:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   9055:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   9056:     <code class="filename">.devhelp*</code> file must be directly in that
                   9057:     directory then, no additional subdirectory level is allowed in
                   9058:     this case. This is usually achieved by using
1.128     wiz      9059:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      9060:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   9061:     though.)</p>
1.75      rillig   9062: </div>
1.148     asau     9063: <div class="sect2">
1.75      rillig   9064: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9065: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   9066: <p>Certain packages, most of them in the games category, install
1.87      wiz      9067:     a score file that allows all users on the system to record their
                   9068:     highscores.  In order for this to work, the binaries need to be
                   9069:     installed setgid and the score files owned by the appropriate
1.142     wiz      9070:     group and/or owner (traditionally the "games" user/group).  Set
                   9071:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      9072:     following variables, documented in more detail in
                   9073:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      9074:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   9075:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
                   9076:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.114     jmcneill 9077: <p>A package should therefore never hard code file ownership or
1.87      wiz      9078:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   9079:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   9080:     correctly.</p>
1.75      rillig   9081: </div>
1.148     asau     9082: <div class="sect2">
1.75      rillig   9083: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9084: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 9085: <p><code class="varname">DESTDIR</code> support means that a package
                   9086:     installs into a staging directory, not the final location of the
                   9087:     files. Then a binary package is created which can be used for
                   9088:     installation as usual. There are two ways: Either the package must
1.128     wiz      9089:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   9090:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     9091: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9092: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145     wiz      9093:       set to <span class="quote">&#8220;<span class="quote">none</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>, or
                   9094:       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
                   9095:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   9096:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 9097:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   9098:       the inclusion.</p></li>
1.128     wiz      9099: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      9100:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      9101: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      9102:       automatically. Many manual rules and pre/post-install often are
                   9103:       incorrect; fix them.</p></li>
1.128     wiz      9104: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     9105:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      9106: <li class="listitem"><p>In general, packages should support
1.103     wiz      9107:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   9108:       DESTDIR.</p></li>
                   9109: </ul></div>
                   9110: </div>
1.148     asau     9111: <div class="sect2">
1.103     wiz      9112: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9113: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      9114: <p>Your package may also contain scripts with hardcoded paths to
                   9115:       other interpreters besides (or as well as) perl.  To correct the
                   9116:       full pathname to the script interpreter, you need to set the
                   9117:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  9118:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      9119: <pre class="programlisting">
1.100     rillig   9120: REPLACE_INTERPRETER+=   tcl
                   9121: REPLACE.tcl.old=        .*/bin/tclsh
                   9122: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   9123: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   9124: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      9125:     </pre>
1.148     asau     9126: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9127: <h3 class="title">Note</h3>
                   9128: <p>Before March 2006, these variables were called
1.87      wiz      9129:     <code class="varname">_REPLACE.*</code> and
                   9130:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   9131: </div>
                   9132: </div>
1.148     asau     9133: <div class="sect2">
1.75      rillig   9134: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9135: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   9136: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      9137:     the Makefile fragment
                   9138:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  9139:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      9140:     configuration for such modules as well as various hooks to tune
                   9141:     this configuration.  See comments in this file for
                   9142:     details.</p>
1.75      rillig   9143: <p>Perl5 modules will install into different places depending
1.87      wiz      9144:     on the version of perl used during the build process.  To
                   9145:     address this, pkgsrc will append lines to the
                   9146:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9147:     the installed <code class="filename">.packlist</code> file generated by
                   9148:     most perl5 modules.  This is invoked by defining
                   9149:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      9150:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9151:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9152:     e.g.:</p>
1.75      rillig   9153: <pre class="programlisting">
1.153     wiz      9154: PERL5_PACKLIST= auto/Pg/.packlist
1.87      wiz      9155:     </pre>
1.153     wiz      9156: <p>The perl5 config variables
                   9157:     <code class="varname">installarchlib</code>,
                   9158:     <code class="varname">installscript</code>,
                   9159:     <code class="varname">installvendorbin</code>,
                   9160:     <code class="varname">installvendorscript</code>,
                   9161:     <code class="varname">installvendorarch</code>,
                   9162:     <code class="varname">installvendorlib</code>,
                   9163:     <code class="varname">installvendorman1dir</code>, and
                   9164:     <code class="varname">installvendorman3dir</code> represent those
                   9165:     locations in which components of perl5 modules may be installed,
                   9166:     provided as variable with uppercase and prefixed with
                   9167:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9168:     and may be used by perl5 packages that don't have a packlist.
                   9169:     These variables are also substituted for in the
                   9170:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9171:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9172: </div>
1.148     asau     9173: <div class="sect2">
1.75      rillig   9174: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9175: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9176: <p>Some packages install info files or use the
1.128     wiz      9177:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      9178:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9179:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9180:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9181:     handle registration of the info files in the Info directory
1.128     wiz      9182:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9183:     files registration is either provided by the system, or by a
                   9184:     special purpose package automatically added as dependency if
                   9185:     needed.</p>
1.75      rillig   9186: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9187:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9188:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9189:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9190: <p>The info files for the package should be listed in the
1.87      wiz      9191:     package <code class="filename">PLIST</code>; however any split info files
                   9192:     need not be listed.</p>
1.128     wiz      9193: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9194:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9195:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9196:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9197:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9198:     variable in the package <code class="filename">Makefile</code>. By
                   9199:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9200:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9201:     does not match the required minimum, a build dependency on the
1.91      rillig   9202:     <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      9203:     be added automatically.</p>
1.75      rillig   9204: <p>The build and installation process of the software provided
1.87      wiz      9205:     by the package should not use the
1.110     hubertf  9206:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9207:     info files is the task of the package
                   9208:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9209:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9210: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9211:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9212:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9213:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9214: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9215:     no effect except the logging of a message. The script overriding
1.110     hubertf  9216:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9217:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9218:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9219: </div>
1.148     asau     9220: <div class="sect2">
1.75      rillig   9221: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9222: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9223: <p>All packages that install manual pages should install them
1.87      wiz      9224:     into the same directory, so that there is one common place to look
                   9225:     for them. In pkgsrc, this place is
                   9226:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9227:     should be used in packages. The default for
                   9228:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9229:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9230:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9231: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9232: <h3 class="title">Note</h3>
1.87      wiz      9233: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9234:     is far from complete.</p>
1.75      rillig   9235: </div>
1.81      rillig   9236: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9237:     <code class="filename">man/</code> as the top level directory for the man
                   9238:     page file entries, and the pkgsrc framework will convert as
                   9239:     needed. In all other places, the correct
                   9240:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9241: <p>Packages that are
                   9242:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9243:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9244:     <code class="filename">./configure</code>
                   9245:     --mandir switch to set where the man pages should be installed.
                   9246:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9247:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9248: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9249:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9250:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9251:     Or if the <code class="filename">./configure</code> script uses
                   9252:     a non-standard use of --mandir, you can set
                   9253:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  9254: <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      9255:     information on installation of compressed manual pages.</p>
1.75      rillig   9256: </div>
1.148     asau     9257: <div class="sect2">
1.75      rillig   9258: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   9259: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9260: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9261:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9262:     you need to take some extra steps to make sure they get registered
                   9263:     in the database:</p>
1.128     wiz      9264: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9265: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9266:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9267:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9268:        deinstallation time, and tells the package where to install
1.107     rillig   9269:        GConf data files using some standard configure arguments.  It
1.87      wiz      9270:        also disallows any access to the database directly from the
                   9271:        package.</p></li>
1.128     wiz      9272: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      9273:        <code class="filename">.schemas</code> files under
                   9274:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9275:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9276:        need to manually patch the package.</p></li>
1.128     wiz      9277: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9278:        directory, as they will be handled automatically.  See
1.173   ! wiz      9279:        <a class="xref" href="#faq.conf" title="9.14. How do I change the location of configuration files?">Section 9.14, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      9280: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9281:        your <code class="filename">Makefile</code> with a list of all
                   9282:        <code class="filename">.schemas</code> files installed by the package, if
                   9283:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      9284: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9285:        your <code class="filename">Makefile</code> with a
                   9286:        list of all <code class="filename">.entries</code> files installed by the
                   9287:        package, if any. Names must not contain any directories in
                   9288:        them.</p></li>
1.75      rillig   9289: </ol></div>
                   9290: </div>
1.148     asau     9291: <div class="sect2">
1.75      rillig   9292: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   9293: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9294: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9295:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9296:     get registered in the database:</p>
1.128     wiz      9297: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9298: <li class="listitem"><p>Include
1.119     mishka   9299:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9300:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9301:        takes care of rebuilding the scrollkeeper database at
                   9302:        installation and deinstallation time, and disallows any access
                   9303:        to it directly from the package.</p></li>
1.128     wiz      9304: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9305:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9306:        will be handled automatically.</p></li>
1.128     wiz      9307: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9308:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9309:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9310: </ol></div>
                   9311: </div>
1.148     asau     9312: <div class="sect2">
1.75      rillig   9313: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9314: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9315: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9316:     the fonts database in the directory where they get installed at
                   9317:     installation and deinstallation time.  This can be automatically
                   9318:     done by using the pkginstall framework.</p>
1.75      rillig   9319: <p>You can list the directories where fonts are installed in the
1.87      wiz      9320:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9321:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9322:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      9323:     Also make sure that the database file
                   9324:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9325: <p>Note that you should not create new directories for fonts;
1.87      wiz      9326:     instead use the standard ones to avoid that the user needs to
                   9327:     manually configure his X server to find them.</p>
1.75      rillig   9328: </div>
1.148     asau     9329: <div class="sect2">
1.75      rillig   9330: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9331: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9332: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9333:     take some extra steps to get them registered in the GTK2 database
                   9334:     properly:</p>
1.128     wiz      9335: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9336: <li class="listitem"><p>Include
1.87      wiz      9337:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9338:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9339:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      9340: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      9341:       your package installs GTK2 immodules.</p></li>
1.128     wiz      9342: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      9343:       GTK2 loaders.</p></li>
1.128     wiz      9344: <li class="listitem">
1.87      wiz      9345: <p>Patch the package to not touch any of the GTK2
                   9346:       databases directly.  These are:</p>
1.148     asau     9347: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9348: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9349: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9350: </ul></div>
                   9351: </li>
1.128     wiz      9352: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      9353:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9354:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9355: </ol></div>
                   9356: </div>
1.148     asau     9357: <div class="sect2">
1.75      rillig   9358: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9359: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9360: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9361:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9362:     etc.), you need to take some extra steps:</p>
1.128     wiz      9363: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9364: <li class="listitem"><p>Include
1.87      wiz      9365:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9366:        your <code class="filename">Makefile</code>, which takes care of
                   9367:        registering those files in system-wide catalogs at
                   9368:        installation and deinstallation time.</p></li>
1.128     wiz      9369: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9370:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9371: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9372:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9373: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9374:        to be added to the SGML catalog.  These come in groups of
                   9375:        three strings; see xmlcatmgr(1) for more information
                   9376:        (specifically, arguments recognized by the 'add' action).
                   9377:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9378: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9379:        to be added to the XML catalog.  These come in groups of three
                   9380:        strings; see xmlcatmgr(1) for more information (specifically,
                   9381:        arguments recognized by the 'add' action).  Note that you will
                   9382:        normally not use this variable.</p></li>
1.75      rillig   9383: </ol></div>
                   9384: </div>
1.148     asau     9385: <div class="sect2">
1.75      rillig   9386: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9387: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9388: <p>If a package provides extensions to the MIME database by
1.87      wiz      9389:     installing <code class="filename">.xml</code> files inside
                   9390:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9391:     need to take some extra steps to ensure that the database is kept
                   9392:     consistent with respect to these new files:</p>
1.128     wiz      9393: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9394: <li class="listitem"><p>Include
1.87      wiz      9395:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9396:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9397:        this same directory, which is reserved for inclusion from
                   9398:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9399:        care of rebuilding the MIME database at installation and
                   9400:        deinstallation time, and disallows any access to it directly
                   9401:        from the package.</p></li>
1.128     wiz      9402: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9403:        <code class="filename">share/mime</code> directory,
                   9404:        <span class="emphasis"><em>except</em></span> for files saved under
                   9405:        <code class="filename">share/mime/packages</code>.  The former are
                   9406:        handled automatically by
                   9407:        the update-mime-database program, but the latter are
                   9408:        package-dependent and must be removed by the package that
                   9409:        installed them in the first place.</p></li>
1.128     wiz      9410: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9411:        from the PLIST.  They will be handled by the shared-mime-info
                   9412:        package.</p></li>
1.75      rillig   9413: </ol></div>
                   9414: </div>
1.148     asau     9415: <div class="sect2">
1.75      rillig   9416: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9417: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9418: <p>If a package uses intltool during its build, add
                   9419:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9420:     which forces it to use the intltool package provided by pkgsrc,
                   9421:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9422: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9423:     latest available version; this way, the package benefits of any
                   9424:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9425: </div>
1.148     asau     9426: <div class="sect2">
1.75      rillig   9427: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9428: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9429: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9430:     the startup directory by default, but you can enable it, by adding
                   9431:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9432:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9433:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9434:     it will automatically remove the scripts when the package is
                   9435:     deinstalled.</p>
1.75      rillig   9436: </div>
1.148     asau     9437: <div class="sect2">
1.75      rillig   9438: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9439: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9440: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9441:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9442:     updated.</p>
1.148     asau     9443: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9444: <h3 class="title">Note</h3>
1.125     wiz      9445: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9446:     packages should install files
1.125     wiz      9447:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9448:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9449: </div>
1.128     wiz      9450: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9451: <li class="listitem"><p>Include
1.125     wiz      9452:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9453:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9454:       database at installation and deinstallation time.</p></li>
1.128     wiz      9455: <li class="listitem">
1.75      rillig   9456: <p>If your package installs files into a texmf
1.87      wiz      9457:       tree other than the one
1.125     wiz      9458:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9459:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9460:       trees that need database update.</p>
1.75      rillig   9461: <p>If your package also installs font map files that need
1.110     hubertf  9462:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9463:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9464:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9465:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9466:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9467:       be run automatically at installation/deinstallation to
                   9468:       enable/disable font map files for TeX output
                   9469:       drivers.</p>
1.75      rillig   9470: </li>
1.128     wiz      9471: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9472:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9473:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9474: </ol></div>
                   9475: </div>
1.148     asau     9476: <div class="sect2">
1.85      jmmv     9477: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9478: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9479:     emulation</h3></div></div></div>
                   9480: <p>There are some packages that provide libraries and
                   9481:     executables for running binaries from a one operating system
                   9482:     on a different one (if the latter supports it).  One example
                   9483:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9484: <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      9485:     helps in extracting and packaging Linux rpm packages.</p>
                   9486: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9487:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9488:     if all libraries for each installed executable can be found by
                   9489:     the dynamic linker.  Since the standard dynamic linker is run,
                   9490:     this fails for emulation packages, because the libraries used
                   9491:     by the emulation are not in the standard directories.</p>
                   9492: </div>
1.148     asau     9493: <div class="sect2">
1.87      wiz      9494: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9495: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9496: <p>If a package installs images under the
1.87      wiz      9497:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9498:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9499:     database, you need to take some extra steps to make sure that the
                   9500:     shared theme directory is handled appropriately and that the cache
                   9501:     database is rebuilt:</p>
1.128     wiz      9502: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9503: <li class="listitem"><p>Include
1.87      wiz      9504:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      9505: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      9506:        entry that refers to the theme cache.</p></li>
1.128     wiz      9507: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     9508:          directories from the <code class="filename">share/icons/hicolor</code>
                   9509:          hierarchy because they will be handled automatically.</p></li>
                   9510: </ol></div>
                   9511: <p>The best way to verify that the PLIST is correct with
                   9512:       respect to the last two points is to regenerate it using
1.110     hubertf  9513:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9514: </div>
1.148     asau     9515: <div class="sect2">
1.85      jmmv     9516: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9517: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9518: <p>If a package installs <code class="filename">.desktop</code> files
                   9519:       under <code class="filename">share/applications</code> and these include
1.159     rodent   9520:       MIME information (MimeType key), you need to take extra steps to
                   9521:       ensure that they are registered into the MIME database:</p>
1.128     wiz      9522: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9523: <li class="listitem"><p>Include
1.85      jmmv     9524:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      9525: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     9526:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9527:          It will be handled automatically.</p></li>
                   9528: </ol></div>
                   9529: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9530:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9531:       print-PLIST</strong></span>.</p>
1.75      rillig   9532: </div>
                   9533: </div>
1.148     asau     9534: <div class="sect1">
1.87      wiz      9535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9536: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9537: <p>In some cases one does not have the time to solve a problem
1.125     wiz      9538:   immediately. In this case, one can plainly mark a package as broken.  For
                   9539:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9540:   reason why the package is broken (similar to the
                   9541:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9542:   the package will immediately be shown this message, and the build
                   9543:   will not be even tried.</p>
                   9544: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      9545:   intervals.</p>
                   9546: </div>
1.75      rillig   9547: </div>
1.148     asau     9548: <div class="chapter">
1.75      rillig   9549: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9550: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9551: <p>To check out all the gotchas when building a package, here are
                   9552:   the steps that I do in order to get a package working.  Please note
                   9553:   this is basically the same as what was explained in the previous
                   9554:   sections, only with some debugging aids.</p>
1.148     asau     9555: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9556: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
                   9557: <li class="listitem">
1.91      rillig   9558: <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      9559:       create a directory for a new package, change into it, then run
1.110     hubertf  9560:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9561: <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>
                   9562: <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>
                   9563: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9564: </li>
1.128     wiz      9565: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9566: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9567: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9568: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9569:       configure step to the package's
                   9570:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      9571: <li class="listitem">
1.75      rillig   9572: <p>Make the package compile, doing multiple rounds of</p>
                   9573: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9574: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9575: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9576: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9577: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9578: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9579: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9580: <p>Doing this step as non-root user will ensure that no files
                   9581:       are modified that shouldn't be, especially during the build
1.110     hubertf  9582:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9583:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9584:       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      9585:       package.</p>
1.75      rillig   9586: </li>
1.128     wiz      9587: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9588:       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>
                   9589: <li class="listitem">
1.76      rillig   9590: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9591: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9592: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9593: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9594: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9595: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9596: <p>You usually need to be <code class="username">root</code> to do
                   9597:       this.  Look if there are any files left:</p>
1.75      rillig   9598: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9599: <p>If this reveals any files that are missing in
1.88      wiz      9600:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9601: </li>
1.128     wiz      9602: <li class="listitem">
1.88      wiz      9603: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9604:       package again and make a binary package:</p>
1.75      rillig   9605: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9606: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9607: </li>
1.128     wiz      9608: <li class="listitem">
1.75      rillig   9609: <p>Delete the installed package:</p>
1.88      wiz      9610: <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   9611: </li>
1.128     wiz      9612: <li class="listitem">
1.110     hubertf  9613: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9614:       command, which shouldn't find anything now:</p>
1.75      rillig   9615: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9616: </li>
1.128     wiz      9617: <li class="listitem">
1.75      rillig   9618: <p>Reinstall the binary package:</p>
1.93      rillig   9619: <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   9620: </li>
1.128     wiz      9621: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9622: <li class="listitem">
1.110     hubertf  9623: <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      9624:       reports:</p>
1.75      rillig   9625: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9626: </li>
1.128     wiz      9627: <li class="listitem"><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   9628: </ul></div>
                   9629: </div>
1.148     asau     9630: <div class="chapter">
1.75      rillig   9631: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9632: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9633: <div class="toc">
                   9634: <p><b>Table of Contents</b></p>
                   9635: <dl>
1.106     rillig   9636: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9637: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9638: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      9639: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   9640: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     9641: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9642: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9643: </dl>
                   9644: </div>
1.148     asau     9645: <div class="sect1">
1.75      rillig   9646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9647: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9648: <p>Our policy is that we accept binaries only from pkgsrc
                   9649:        developers to guarantee that the packages don't contain any
                   9650:        trojan horses etc. This is not to annoy anyone but rather to
                   9651:        protect our users! You're still free to put up your home-made
                   9652:        binary packages and tell the world where to get them. NetBSD
                   9653:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9654:        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   9655: </div>
1.148     asau     9656: <div class="sect1">
1.75      rillig   9657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9658: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9659: <p>First, check that your package is complete, compiles and
1.110     hubertf  9660:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.136     dholland 9661:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9662:        archive that contains all files that make up the package.
1.87      wiz      9663:        Finally, send this package to the pkgsrc bug tracking system,
1.136     dholland 9664:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9665:        that, go to the web page
1.110     hubertf  9666:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      9667:        which contains some instructions and a link to a form where you
                   9668:        can submit packages.  The
                   9669:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
                   9670:        also available as a substitute for either of the above two tools.
                   9671:        </p>
1.87      wiz      9672: <p>In the form of the problem report, the category should be
1.128     wiz      9673:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9674:        and version number, and the description field should contain a
                   9675:        short description of your package (contents of the COMMENT
                   9676:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9677:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9678: <p>If you want to submit several packages, please send a
                   9679:        separate PR for each one, it's easier for us to track things
                   9680:        that way.</p>
                   9681: <p>Alternatively, you can also import new packages into
1.128     wiz      9682:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.110     hubertf  9683:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9684:        for details.</p>
                   9685: </div>
1.148     asau     9686: <div class="sect1">
1.75      rillig   9687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9688: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9689: <p>Please note all package additions, updates, moves, and
1.93      rillig   9690:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9691:        important to keep this file up to date and conforming to the
                   9692:        existing format, because it will be used by scripts to
1.110     hubertf  9693:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9694:        sites. Additionally, check the
1.76      rillig   9695:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9696:        for the package you updated or removed, in case it was mentioned
                   9697:        there.</p>
                   9698: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9699:        bumped, the change should appear in
1.93      rillig   9700:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9701:        related or otherwise relevant. Mass bumps that result from a
                   9702:        dependency being updated should not be mentioned. In all other
                   9703:        cases it's the developer's decision.</p>
                   9704: <p>There is a make target that helps in creating proper
1.110     hubertf  9705:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9706:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9707:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9708:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9709:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9710:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9711:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9712:   For new packages, or package moves or removals, set the
                   9713:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9714:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9715:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9716:   not the same as your NetBSD login name. The target also automatically
                   9717:   removes possibly existing entries for the package in the
                   9718:   <code class="filename">TODO</code> file. Don't forget to commit
                   9719:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
1.126     jakllsch 9720:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9721:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9722:   makes the cvs commands use the main repository.
                   9723:   </p>
1.75      rillig   9724: </div>
1.148     asau     9725: <div class="sect1">
1.75      rillig   9726: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140     wiz      9727: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9728: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9729:   access to the pkgsrc repository.</p>
                   9730: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9731: Start by adding the directory and then files in the directory. Don't
                   9732: forget to add the new package to the category's
                   9733: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9734: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9735: <pre class="programlisting">
                   9736: <code class="prompt">$</code> cd .../pkgsrc/category
                   9737: <code class="prompt">$</code> cvs add pkgname
                   9738: <code class="prompt">$</code> cd pkgname
                   9739: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9740: <code class="prompt">$</code> cvs add patches/p*
                   9741: <code class="prompt">$</code> cvs status | less
1.141     wiz      9742: <code class="prompt">$</code> cvs commit
1.140     wiz      9743: <code class="prompt">$</code> cd ..
                   9744: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9745: <code class="prompt">$</code> cvs commit Makefile
1.140     wiz      9746: </pre>
1.87      wiz      9747: <p>The commit message of the initial import should include part of the
1.76      rillig   9748:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9749:   what the package is/does.</p>
1.140     wiz      9750: <p>Also mention the new package in
                   9751: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9752: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9753: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9754: </div>
1.148     asau     9755: <div class="sect1">
1.75      rillig   9756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9757: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9758: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9759:   changes between old and new versions into the commit log when updating
1.87      wiz      9760:   a package. There are various reasons for this:</p>
1.148     asau     9761: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9762: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9763:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9764: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9765:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9766: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9767:   repository is very useful for people who read the pkgsrc-changes mailing
                   9768:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9769:   the package.</p></li>
1.75      rillig   9770: </ul></div>
1.87      wiz      9771: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9772:   has been released, it should not automatically be upgraded in the CVS
                   9773:   repository.  We prefer to be conservative in the packages that are
                   9774:   included in pkgsrc - development or beta packages are not really the
                   9775:   best thing for most places in which pkgsrc is used. Please use your
                   9776:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9777:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9778: </div>
1.148     asau     9779: <div class="sect1">
1.75      rillig   9780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     9781: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9782: <p>Renaming packages is not recommended.</p>
                   9783: <p>When renaming packages, be sure to fix any references to old name
                   9784:   in other Makefiles, options, buildlink files, etc.</p>
                   9785: <p>Also When renaming a package, please define
                   9786:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9787:   pattern(s) of the previous package name.
                   9788:   This may be repeated for multiple renames.
                   9789:   The new package would be an exact replacement.
                   9790: </p>
1.128     wiz      9791: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9792:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9793:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9794:   not be an exact replacement but is a suggestion for the replaced
                   9795:   functionality.</p>
                   9796: </div>
1.148     asau     9797: <div class="sect1">
1.122     reed     9798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9799: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9800: <p>It is preferred that packages are not renamed or moved, but if needed
                   9801:   please follow these steps.
                   9802: </p>
1.128     wiz      9803: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9804: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9805: <li class="listitem">
1.75      rillig   9806: <p>Remove all CVS dirs.</p>
1.87      wiz      9807: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9808: <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      9809: <p>and use that for further work.</p>
1.75      rillig   9810: </li>
1.128     wiz      9811: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9812: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9813: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9814: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9815: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9816: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9817: for doing an update using pkgsrc building; for example, it can
1.136     dholland 9818: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9819: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9820: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9821: it may have multiple matches, so the tool should also check on the
                   9822: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9823: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9824: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9825: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9826: place.</p></li>
1.128     wiz      9827: <li class="listitem">
1.75      rillig   9828: <p>Check if any package depends on it:
                   9829: </p>
                   9830: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9831: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9832: </li>
1.128     wiz      9833: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9834: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9835: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9836: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9837: <li class="listitem">
1.75      rillig   9838: <p>Commit the changed and removed files:</p>
                   9839: <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      9840: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9841: </li>
                   9842: </ol></div>
                   9843: </div>
                   9844: </div>
1.148     asau     9845: <div class="chapter">
1.75      rillig   9846: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9847: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9848: <p>This section contains the answers to questions that may
                   9849:        arise when you are writing a package. If you don't find your
                   9850:        question answered here, first have a look in the other chapters,
                   9851:        and if you still don't have the answer, ask on the
                   9852:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9853: <div class="qandaset">
1.173   ! wiz      9854: <a name="idm74589232"></a><dl>
1.106     rillig   9855: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9856:        MAKEFLAGS, .MAKEFLAGS and
                   9857:        MAKE_FLAGS?</a>
                   9858: </dt>
1.106     rillig   9859: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9860:        MAKE, GMAKE and
                   9861:        MAKE_PROGRAM?</a>
                   9862: </dt>
1.106     rillig   9863: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9864:        CC, PKG_CC and
                   9865:        PKGSRC_COMPILER?</a>
                   9866: </dt>
1.106     rillig   9867: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9868:        BUILDLINK_LDFLAGS,
                   9869:        BUILDLINK_LDADD and
                   9870:        BUILDLINK_LIBS?</a>
                   9871: </dt>
1.106     rillig   9872: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9873:        VARNAME=BUILDLINK_PREFIX.foo
                   9874:        say it's empty?</a>
                   9875: </dt>
1.106     rillig   9876: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9877:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9878:        don't understand the := inside
                   9879:        it.</a>
                   9880: </dt>
1.106     rillig   9881: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9882:        developers?</a>
                   9883: </dt>
1.106     rillig   9884: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9885:        documentation?</a>
                   9886: </dt>
1.106     rillig   9887: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9888: do?</a>
                   9889: </dt>
1.75      rillig   9890: </dl>
1.148     asau     9891: <table border="0" style="width: 100%;">
                   9892: <colgroup>
1.75      rillig   9893: <col align="left" width="1%">
1.128     wiz      9894: <col>
1.148     asau     9895: </colgroup>
1.75      rillig   9896: <tbody>
1.148     asau     9897: <tr class="question">
1.75      rillig   9898: <td align="left" valign="top">
1.173   ! wiz      9899: <a name="devfaq.makeflags"></a><a name="idm74588848"></a><p><b>22.1.</b></p>
1.75      rillig   9900: </td>
                   9901: <td align="left" valign="top"><p>What is the difference between
                   9902:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9903:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9904: </tr>
                   9905: <tr class="answer">
1.91      rillig   9906: <td align="left" valign="top"></td>
1.75      rillig   9907: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.136     dholland 9908:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9909:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9910:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9911:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9912: </tr>
1.148     asau     9913: <tr class="question">
1.75      rillig   9914: <td align="left" valign="top">
1.173   ! wiz      9915: <a name="devfaq.make"></a><a name="idm74584880"></a><p><b>22.2.</b></p>
1.75      rillig   9916: </td>
                   9917: <td align="left" valign="top"><p>What is the difference between
                   9918:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9919:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9920: </tr>
                   9921: <tr class="answer">
1.91      rillig   9922: <td align="left" valign="top"></td>
1.75      rillig   9923: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.136     dholland 9924:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9925:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9926:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9927:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9928:        Make program that is used for building the
                   9929:        package.</p></td>
                   9930: </tr>
1.148     asau     9931: <tr class="question">
1.75      rillig   9932: <td align="left" valign="top">
1.173   ! wiz      9933: <a name="devfaq.cc"></a><a name="idm74580400"></a><p><b>22.3.</b></p>
1.75      rillig   9934: </td>
                   9935: <td align="left" valign="top"><p>What is the difference between
                   9936:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9937:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9938: </tr>
                   9939: <tr class="answer">
1.91      rillig   9940: <td align="left" valign="top"></td>
1.75      rillig   9941: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9942:        compiler, which can be configured by the pkgsrc user.
                   9943:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9944:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9945:        path to a compiler, but the type of compiler that should be
1.76      rillig   9946:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9947:        information about the latter variable.</p></td>
                   9948: </tr>
1.148     asau     9949: <tr class="question">
1.75      rillig   9950: <td align="left" valign="top">
1.173   ! wiz      9951: <a name="devfaq.bl3flags"></a><a name="idm74576304"></a><p><b>22.4.</b></p>
1.75      rillig   9952: </td>
                   9953: <td align="left" valign="top"><p>What is the difference between
                   9954:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9955:        <code class="varname">BUILDLINK_LDADD</code> and
                   9956:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9957: </tr>
                   9958: <tr class="answer">
1.91      rillig   9959: <td align="left" valign="top"></td>
1.75      rillig   9960: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9961: </tr>
1.148     asau     9962: <tr class="question">
1.75      rillig   9963: <td align="left" valign="top">
1.173   ! wiz      9964: <a name="devfaq.bl3prefix"></a><a name="idm74574128"></a><p><b>22.5.</b></p>
1.75      rillig   9965: </td>
1.110     hubertf  9966: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9967:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9968:        say it's empty?</p></td>
                   9969: </tr>
                   9970: <tr class="answer">
1.91      rillig   9971: <td align="left" valign="top"></td>
1.75      rillig   9972: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      9973:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9974:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  9975:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9976:        command.</p></td>
                   9977: </tr>
1.148     asau     9978: <tr class="question">
1.78      rillig   9979: <td align="left" valign="top">
1.173   ! wiz      9980: <a name="devfaq.master_sites"></a><a name="idm74570928"></a><p><b>22.6.</b></p>
1.78      rillig   9981: </td>
                   9982: <td align="left" valign="top"><p>What does
                   9983:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9984:        don't understand the <code class="literal">:=</code> inside
                   9985:        it.</p></td>
                   9986: </tr>
                   9987: <tr class="answer">
1.91      rillig   9988: <td align="left" valign="top"></td>
1.78      rillig   9989: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9990:        assignment operator, like you might expect at first sight.
                   9991:        Instead, it is a degenerate form of
                   9992:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.136     dholland 9993:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9994:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9995:        case of <code class="varname">MASTER_SITE_*</code>,
                   9996:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9997:        <em class="replaceable"><code>new_string</code></em> is
                   9998:        <code class="literal">package/</code>. That's where the
                   9999:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   10000:        together.</p></td>
                   10001: </tr>
1.148     asau     10002: <tr class="question">
1.78      rillig   10003: <td align="left" valign="top">
1.173   ! wiz      10004: <a name="devfaq.mailinglists"></a><a name="idm74554672"></a><p><b>22.7.</b></p>
1.78      rillig   10005: </td>
                   10006: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10007:        developers?</p></td>
                   10008: </tr>
                   10009: <tr class="answer">
1.91      rillig   10010: <td align="left" valign="top"></td>
1.148     asau     10011: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  10012: <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   10013: <dd><p>This is a list for technical discussions related
                   10014:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10015:        pkgsrc infrastructure, proposed new features, questions related
                   10016:        to porting pkgsrc to a new platform, advice for maintaining a
                   10017:        package, patches that affect many packages, help requests moved
                   10018:        from pkgsrc-users when an infrastructure bug is found,
                   10019:        etc.</p></dd>
1.110     hubertf  10020: <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   10021: <dd><p>All bug reports in category "pkg" sent with
1.136     dholland 10022:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10023:        directly; use one of the other mailing
                   10024:        lists.</p></dd>
                   10025: </dl></div></td>
                   10026: </tr>
1.148     asau     10027: <tr class="question">
1.80      rillig   10028: <td align="left" valign="top">
1.173   ! wiz      10029: <a name="devfaq.documentation"></a><a name="idm74550960"></a><p><b>22.8.</b></p>
1.80      rillig   10030: </td>
                   10031: <td align="left" valign="top"><p>Where is the pkgsrc
                   10032:        documentation?</p></td>
                   10033: </tr>
                   10034: <tr class="answer">
1.91      rillig   10035: <td align="left" valign="top"></td>
1.80      rillig   10036: <td align="left" valign="top">
                   10037: <p>There are many places where you can find
                   10038:        documentation about pkgsrc:</p>
1.148     asau     10039: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10040: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10041:        of chapters that explain large parts of pkgsrc, but some
                   10042:        chapters tend to be outdated. Which ones they are is hard to
                   10043:        say.</p></li>
1.128     wiz      10044: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   10045:        about certain features, announcements of new parts of the pkgsrc
                   10046:        infrastructure and sometimes even announcements that a certain
                   10047:        feature has been marked as obsolete. The benefit here is that
                   10048:        each message has a date appended to it.</p></li>
1.128     wiz      10049: <li class="listitem"><p>Many of the files in the
1.80      rillig   10050:        <code class="filename">mk/</code> directory start with a comment that
                   10051:        describes the purpose of the file and how it can be used by the
1.92      rillig   10052:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10053:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10054:        help</strong></span>.</p></li>
1.128     wiz      10055: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10056:        information, but they tend to be highly abbreviated, especially
                   10057:        for actions that occur often. Some contain a detailed
                   10058:        description of what has changed, but they are geared towards the
                   10059:        other pkgsrc developers, not towards an average pkgsrc user.
                   10060:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10061:        don't know what has been before, these messages may not be worth
                   10062:        too much to you.</p></li>
1.128     wiz      10063: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10064:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10065:        mind of the developer who wrote the code. To get this
1.110     hubertf  10066:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10067:        to see who has written it and ask on the
                   10068:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10069:        find your questions later (see above). To be sure that the
                   10070:        developer in charge reads the mail, you may CC him or
                   10071:        her.</p></li>
                   10072: </ul></div>
                   10073: </td>
                   10074: </tr>
1.148     asau     10075: <tr class="question">
1.92      rillig   10076: <td align="left" valign="top">
1.173   ! wiz      10077: <a name="devfaq.too-much-time"></a><a name="idm74544432"></a><p><b>22.9.</b></p>
1.92      rillig   10078: </td>
                   10079: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   10080: do?</p></td>
                   10081: </tr>
                   10082: <tr class="answer">
                   10083: <td align="left" valign="top"></td>
                   10084: <td align="left" valign="top">
1.93      rillig   10085: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   10086: anyway.</p>
1.148     asau     10087: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10088: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   10089:     <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
                   10090:     will tell you about newer versions of installed packages that are
                   10091:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      10092: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 10093:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   10094:     cleanups and enhancements for pkgsrc that would be nice to
                   10095:     have.</p></li>
1.128     wiz      10096: <li class="listitem"><p>Review packages for which review was requested on
1.110     hubertf  10097:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   10098:     mailing list.</p></li>
                   10099: </ul></div>
                   10100: </td>
                   10101: </tr>
1.75      rillig   10102: </tbody>
                   10103: </table>
                   10104: </div>
                   10105: </div>
1.148     asau     10106: <div class="chapter">
1.85      jmmv     10107: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10108: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     10109: <div class="toc">
                   10110: <p><b>Table of Contents</b></p>
                   10111: <dl>
1.106     rillig   10112: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   10113: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   10114: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   10115: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     10116: </dl>
                   10117: </div>
1.110     hubertf  10118: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     10119: site</a>:</p>
                   10120: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   10121:   environment, an intuitive and attractive desktop for users, and the
                   10122:   GNOME development platform, an extensive framework for building
                   10123:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   10124: <p>pkgsrc provides a seamless way to automatically build and install
                   10125: a complete GNOME environment <span class="emphasis"><em>under many different
                   10126: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   10127: the most advanced build and packaging systems for GNOME due to its
                   10128: included technologies buildlink3, the wrappers and tools framework and
                   10129: automatic configuration file management.  Lots of efforts are put into
                   10130: achieving a completely clean deinstallation of installed software
                   10131: components.</p>
1.110     hubertf  10132: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     10133: the above also means that great efforts are put into making GNOME work
1.110     hubertf  10134: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     10135: pkgsrc as its preferred packaging system, contributing lots of
                   10136: portability fixes to make GNOME build and install under it.</p>
                   10137: <p>This chapter is aimed at pkgsrc developers and other people
                   10138: interested in helping our GNOME porting and packaging efforts.  It
                   10139: provides instructions on how to manage the existing packages and some
                   10140: important information regarding their internals.</p>
1.148     asau     10141: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     10142: <h3 class="title">We need your help!</h3>
                   10143: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   10144:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  10145:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     10146:   work</a> list!  There is still a long way to go to get a
                   10147:   fully-functional GNOME desktop under NetBSD and we need your help to
                   10148:   achieve it!</p>
                   10149: </div>
1.148     asau     10150: <div class="sect1">
1.85      jmmv     10151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10152: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     10153: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     10154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10155: <li class="listitem"><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     10156:     the core GNOME desktop environment.  It only includes the necessary
                   10157:     bits to get it to boot correctly, although it may lack important
                   10158:     functionality for daily operation.  The idea behind this package is
                   10159:     to let end users build their own configurations on top of this one,
                   10160:     first installing this meta package to achieve a functional setup and
                   10161:     then adding individual applications.</p></li>
1.128     wiz      10162: <li class="listitem"><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     10163:     complete installation of the GNOME platform and desktop as defined
                   10164:     by the GNOME project; this is based on the components distributed in
                   10165:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   10166:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   10167:     official FTP server.  Developer-only tools found in those
                   10168:     directories are not installed unless required by some other
                   10169:     component to work properly.  Similarly, packages from the bindings
                   10170:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   10171:     in unless required as a dependency for an end-user component.  This
1.91      rillig   10172:     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>
1.128     wiz      10173: <li class="listitem"><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     10174:     Installs all the tools required to build a GNOME component when
                   10175:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  10176:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     10177: </ul></div>
                   10178: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   10179: sorted in a way that eases updates: a package may depend on other
                   10180: packages listed before it but not on any listed after it.  It is very
                   10181: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   10182: change it to alphabetical sorting!</em></span></p>
                   10183: </div>
1.148     asau     10184: <div class="sect1">
1.85      jmmv     10185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10186: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     10187: <p>Almost all GNOME applications are written in C and use a common
                   10188: set of tools as their build system.  Things get different with the new
                   10189: bindings to other languages (such as Python), but the following will
                   10190: give you a general idea on the minimum required tools:</p>
1.148     asau     10191: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10192: <li class="listitem">
1.85      jmmv     10193: <p>Almost all GNOME applications use the GNU Autotools as their
                   10194:     build system.  As a general rule you will need to tell this to your
                   10195:     package:</p>
1.100     rillig   10196: <pre class="programlisting">
                   10197: GNU_CONFIGURE=yes
1.85      jmmv     10198: USE_LIBTOOL=yes
1.100     rillig   10199: USE_TOOLS+=gmake
                   10200: </pre>
1.85      jmmv     10201: </li>
1.128     wiz      10202: <li class="listitem">
1.85      jmmv     10203: <p>If the package uses pkg-config to detect dependencies, add this
                   10204:     tool to the list of required utilities:</p>
                   10205: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   10206: <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     10207:     the end of the build process to ensure that you did not miss to
                   10208:     specify any dependency in your package and that the version
                   10209:     requirements are all correct.</p>
                   10210: </li>
1.128     wiz      10211: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   10212:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     10213:     to handle dependencies and to force the package to use the latest
                   10214:     available version.</p></li>
1.128     wiz      10215: <li class="listitem">
1.85      jmmv     10216: <p>If the package uses gtk-doc (a documentation generation
                   10217:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   10218:     tool is rather big and the distfile should come with pregenerated
                   10219:     documentation anyway; if it does not, it is a bug that you ought to
                   10220:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   10221:     the default):</p>
                   10222: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   10223: <p>The default location of installed HTML files
                   10224:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   10225:     and should not be changed unless the package insists on installing
                   10226:     them somewhere else.  Otherwise programs as
1.110     hubertf  10227:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   10228:     do that with an entry similar to:</p>
                   10229: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     10230: </li>
                   10231: </ul></div>
                   10232: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10233: files under the installation prefix to maintain databases.  In this
                   10234: context, shared means that those exact same directories and files are
                   10235: used among several different packages, leading to conflicts in the
                   10236: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10237: handle the most common cases, so you have to forget about using
                   10238: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10239: omitting shared files from them.  If you find yourself doing those,
                   10240: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10241: <p>The following table lists the common situations that result in
                   10242: using shared directories or files.  For each of them, the appropriate
                   10243: solution is given.  After applying the solution be sure to
                   10244: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  10245: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     10246: <div class="table">
1.106     rillig   10247: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   10248: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     10249: <colgroup>
                   10250: <col>
                   10251: <col>
                   10252: </colgroup>
                   10253: <thead><tr>
                   10254: <th>If the package...</th>
                   10255: <th>Then...</th>
                   10256: </tr></thead>
                   10257: <tbody>
                   10258: <tr>
                   10259: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   10260: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     10261: </tr>
                   10262: <tr>
                   10263: <td>Installs icons under the
                   10264:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10265:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  10266: <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     10267: </tr>
                   10268: <tr>
                   10269: <td>Installs files under
                   10270:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  10271: <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     10272: </tr>
                   10273: <tr>
                   10274: <td>Installs <code class="filename">.desktop</code> files under
                   10275:         <code class="filename">share/applications</code> and these include MIME
                   10276:         information.</td>
1.110     hubertf  10277: <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     10278: </tr>
                   10279: </tbody>
1.91      rillig   10280: </table></div>
1.85      jmmv     10281: </div>
1.91      rillig   10282: <br class="table-break">
1.85      jmmv     10283: </div>
1.148     asau     10284: <div class="sect1">
1.85      jmmv     10285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10286: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     10287: <p>When seeing GNOME as a whole, there are two kinds of
                   10288: updates:</p>
1.148     asau     10289: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     10290: <dt><span class="term">Major update</span></dt>
                   10291: <dd>
                   10292: <p>Given that there is still a very long way for GNOME 3 (if it
                   10293:       ever appears), we consider a major update one that goes from a
                   10294:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10295:       where <code class="literal">Y</code> is even and greater than
                   10296:       <code class="literal">X</code>.  These are hard to achieve because they
                   10297:       introduce lots of changes in the components' code and almost all
                   10298:       GNOME distfiles are updated to newer versions.  Some of them can
                   10299:       even break API and ABI compatibility with the previous major
                   10300:       version series.  As a result, the update needs to be done all at
                   10301:       once to minimize breakage.</p>
                   10302: <p>A major update typically consists of around 80 package
                   10303:       updates and the addition of some new ones.</p>
                   10304: </dd>
                   10305: <dt><span class="term">Minor update</span></dt>
                   10306: <dd>
                   10307: <p>We consider a minor update one that goes from a
                   10308:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10309:       one where <code class="literal">Y</code> is greater than
                   10310:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10311:       not update all GNOME components, can be done in an incremental way
                   10312:       and do not break API nor ABI compatibility.</p>
                   10313: <p>A minor update typically consists of around 50 package
                   10314:       updates, although the numbers here may vary a lot.</p>
                   10315: </dd>
                   10316: </dl></div>
                   10317: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10318: release (either major or minor), the following steps should be
                   10319: followed:</p>
1.128     wiz      10320: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10321: <li class="listitem">
1.85      jmmv     10322: <p>Get a list of all the tarballs that form the new release by
                   10323:     using the following commands.  These will leave the full list of the
1.120     snj      10324:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     10325:     file:</p>
1.88      wiz      10326: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10327:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10328:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10329: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10330:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10331:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10332: </li>
1.128     wiz      10333: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     10334:     bump their version to the release you are updating them to.  The
                   10335:     three meta packages should be always consistent with versioning.
                   10336:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10337:     in them.</p></li>
1.128     wiz      10338: <li class="listitem">
1.85      jmmv     10339: <p>For each meta package, update all its
                   10340:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10341:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10342:     newer version (even if found in the FTP) because the meta packages
                   10343:     are supposed to list the exact versions that form a specific GNOME
                   10344:     release.  Exceptions are permitted here if a newer version solves a
                   10345:     serious issue in the overall desktop experience; these typically
                   10346:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10347:     from the developers.</p>
                   10348: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10349:     should be updated to the latest version available (if found in
                   10350:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10351:     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     10352: </li>
1.128     wiz      10353: <li class="listitem">
1.85      jmmv     10354: <p>Generate a patch from the modified meta packages and extract the
                   10355:     list of "new" lines.  This will provide you an outline on what
                   10356:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10357: <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     10358: </li>
1.128     wiz      10359: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     10360:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      10361: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     10362:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10363:     it in order.  For major desktop updates none of these should be
1.93      rillig   10364:     committed until the entire set is completed because there are chances
1.85      jmmv     10365:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      10366: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     10367:     the tree one by one with appropriate log messages.  At the end,
                   10368:     commit the three meta package updates and all the corresponding
                   10369:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10370:     <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>
                   10371: </ol></div>
                   10372: </div>
1.148     asau     10373: <div class="sect1">
1.85      jmmv     10374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10375: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10376: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10377: packages.  Please, it is very important that you always, always,
                   10378: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10379: 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     10380: their attention on portability issues and to ensure that future versions
                   10381: can be built out-of-the box on NetBSD.  The less custom patches in
                   10382: pkgsrc, the easier further updates are.  Those developers in charge of
                   10383: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10384: <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     10385: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10386: of them do.  Do not be short on your reports: always provide detailed
                   10387: explanations of the current failure, how it can be improved to achieve
                   10388: maximum portability and, if at all possible, provide a patch against CVS
                   10389: head.  The more verbose you are, the higher chances of your patch being
                   10390: accepted.</p>
                   10391: <p>Also, please avoid using preprocessor magic to fix portability
                   10392: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10393: GNOME to their operating system, the official GNOME sources are now
                   10394: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10395: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10396: 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     10397: details.</p>
                   10398: </div>
                   10399: </div>
1.75      rillig   10400: </div>
1.148     asau     10401: <div class="part">
1.75      rillig   10402: <div class="titlepage"><div><div><h1 class="title">
                   10403: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10404: <div class="partintro">
1.75      rillig   10405: <div></div>
                   10406: <p>This part of the guide deals with everything
                   10407:        from the infrastructure that is behind the interfaces described
                   10408:        in the developer's guide. A casual package maintainer should not
                   10409:        need anything from this part.</p>
                   10410: <div class="toc">
                   10411: <p><b>Table of Contents</b></p>
                   10412: <dl>
1.106     rillig   10413: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10414: <dd><dl>
1.106     rillig   10415: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10416: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10417: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10418: <dd><dl>
1.106     rillig   10419: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10420: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10421: </dl></dd>
1.106     rillig   10422: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10423: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10424: <dd><dl>
1.106     rillig   10425: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10426: <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   10427: </dl></dd>
1.106     rillig   10428: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10429: <dd><dl>
1.128     wiz      10430: <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>
                   10431: <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   10432: </dl></dd>
                   10433: </dl></dd>
1.106     rillig   10434: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10435: <dd><dl>
1.106     rillig   10436: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10437: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10438: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10439: <dd><dl>
1.106     rillig   10440: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10441: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10442: </dl></dd>
                   10443: </dl></dd>
1.106     rillig   10444: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10445: <dd><dl>
1.106     rillig   10446: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10447: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10448: </dl></dd>
                   10449: </dl>
                   10450: </div>
                   10451: </div>
1.148     asau     10452: <div class="chapter">
1.75      rillig   10453: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10454: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10455: <div class="toc">
                   10456: <p><b>Table of Contents</b></p>
                   10457: <dl>
1.106     rillig   10458: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10459: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10460: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10461: <dd><dl>
1.106     rillig   10462: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10463: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10464: </dl></dd>
1.106     rillig   10465: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10466: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10467: <dd><dl>
1.106     rillig   10468: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10469: <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   10470: </dl></dd>
1.106     rillig   10471: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10472: <dd><dl>
1.128     wiz      10473: <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>
                   10474: <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   10475: </dl></dd>
                   10476: </dl>
                   10477: </div>
                   10478: <p>The pkgsrc infrastructure consists of many small Makefile
                   10479:        fragments. Each such fragment needs a properly specified
                   10480:        interface. This chapter explains how such an interface looks
                   10481:        like.</p>
1.148     asau     10482: <div class="sect1">
1.75      rillig   10483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10484: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10485: <p>Whenever a variable is defined in the pkgsrc
                   10486:        infrastructure, the location and the way of definition provide
                   10487:        much information about the intended use of that variable.
                   10488:        Additionally, more documentation may be found in a header
                   10489:        comment or in this pkgsrc guide.</p>
                   10490: <p>A special file is
                   10491:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10492:        variables that are intended to be user-defined. They are either
                   10493:        defined using the <code class="literal">?=</code> operator or they are
                   10494:        left undefined because defining them to anything would
1.128     wiz      10495:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10496:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10497:        file.</p>
                   10498: <p>Outside this file, the following conventions apply:
                   10499:        Variables that are defined using the <code class="literal">?=</code>
                   10500:        operator may be overridden by a package.</p>
                   10501: <p>Variables that are defined using the <code class="literal">=</code>
                   10502:        operator may be used read-only at run-time.</p>
                   10503: <p>Variables whose name starts with an underscore must not be
                   10504:        accessed outside the pkgsrc infrastructure at all. They may
                   10505:        change without further notice.</p>
1.148     asau     10506: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10507: <h3 class="title">Note</h3>
                   10508: <p>These conventions are currently not applied
                   10509:        consistently to the complete pkgsrc
                   10510:        infrastructure.</p>
                   10511: </div>
                   10512: </div>
1.148     asau     10513: <div class="sect1">
1.81      rillig   10514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10515: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10516: <p>All variables that contain lists of things should default
                   10517:        to being empty. Two examples that do not follow this rule are
                   10518:        <code class="varname">USE_LANGUAGES</code> and
                   10519:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10520:        modified using the <code class="literal">+=</code> operator in package
                   10521:        <code class="filename">Makefile</code>s (or other files included by
                   10522:        them), since there is no guarantee whether the variable is
                   10523:        already set or not, and what its value is. In the case of
1.128     wiz      10524:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10525:        the default value and just define it as in the following
                   10526:        example.</p>
                   10527: <pre class="programlisting">
1.100     rillig   10528: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10529: </pre>
                   10530: <p>Because of the selection of this default value, the same
                   10531:        value appears in many package Makefiles. Similarly for
                   10532:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10533:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10534:        doesn't stand out. Nevertheless it is mentioned in many
                   10535:        files.</p>
                   10536: </div>
1.148     asau     10537: <div class="sect1">
1.81      rillig   10538: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10539: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     10540: <div class="sect2">
1.75      rillig   10541: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10542: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10543: <p>Variable evaluation takes place either at load time or at
                   10544:        runtime, depending on the context in which they occur. The
                   10545:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10546: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10547: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10548:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10549: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10550:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10551: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10552: </ul></div>
                   10553: <p>A special exception are references to the iteration
                   10554:        variables of <code class="literal">.for</code> loops, which are expanded
                   10555:        inline, no matter in which context they appear.</p>
                   10556: <p>As the values of variables may change during load time,
                   10557:        care must be taken not to evaluate them by accident. Typical
                   10558:        examples for variables that should not be evaluated at load time
                   10559:        are <code class="varname">DEPENDS</code> and
                   10560:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10561:        clear, here is an example:</p>
                   10562: <pre class="programlisting">
1.100     rillig   10563: CONFIGURE_ARGS=         # none
                   10564: CFLAGS=                 -O
                   10565: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10566: 
1.100     rillig   10567: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10568: 
1.100     rillig   10569: CFLAGS+=                -Wall
1.75      rillig   10570:        </pre>
                   10571: <p>This code shows how the use of the <code class="literal">:=</code>
                   10572:        operator can quickly lead to unexpected results. The first
                   10573:        paragraph is fairly common code. The second paragraph evaluates
                   10574:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10575:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10576:        <code class="literal">-Wall</code> is appended to the
                   10577:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10578:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10579:        paragraphs from above typically occur in completely unrelated
                   10580:        files.</p>
                   10581: </div>
1.148     asau     10582: <div class="sect2">
1.75      rillig   10583: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10584: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10585: <p>After all the files have been loaded, the values of the
                   10586:        variables cannot be changed anymore. Variables that are used in
                   10587:        the shell commands are expanded at this point.</p>
                   10588: </div>
                   10589: </div>
1.148     asau     10590: <div class="sect1">
1.75      rillig   10591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10592: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10593: <p>There are many ways in which the definition and use of a
                   10594:        variable can be restricted in order to detect bugs and
                   10595:        violations of the (mostly unwritten) policies. See the
                   10596:        <code class="literal">pkglint</code> developer's documentation for further
                   10597:        details.</p>
                   10598: </div>
1.148     asau     10599: <div class="sect1">
1.78      rillig   10600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10601: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10602: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10603:        of the following classes. Cases where a file falls into more
                   10604:        than one class should be avoided as it often leads to subtle
                   10605:        bugs.</p>
1.148     asau     10606: <div class="sect2">
1.75      rillig   10607: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10608: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10609: <p>In a traditional imperative programming language some of
1.76      rillig   10610:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10611:        procedures. They take some input parameters and&mdash;after
                   10612:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10613:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10614:        care must be taken not to use parameter names that have already
                   10615:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10616:        bad choice for a parameter name.</p>
                   10617: <p>Procedures are completely evaluated at preprocessing time.
                   10618:        That is, when calling a procedure all input parameters must be
                   10619:        completely resolvable. For example,
                   10620:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10621:        parameter since it is very likely that further text will be
                   10622:        added after calling the procedure, which would effectively apply
                   10623:        the procedure to only a part of the variable. Also, references
                   10624:        to other variables wit will be modified after calling the
                   10625:        procedure.</p>
                   10626: <p>A procedure can declare its output parameters either as
                   10627:        suitable for use in preprocessing directives or as only
                   10628:        available at runtime. The latter alternative is for variables
                   10629:        that contain references to other runtime variables.</p>
                   10630: <p>Procedures shall be written such that it is possible to
                   10631:        call the procedure more than once. That is, the file must not
                   10632:        contain multiple-inclusion guards.</p>
                   10633: <p>Examples for procedures are
1.76      rillig   10634:        <code class="filename">mk/bsd.options.mk</code> and
                   10635:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10636:        that the parameters are evaluated at load time, they should be
                   10637:        assigned using the <code class="literal">:=</code> operator, which should
                   10638:        be used only for this purpose.</p>
                   10639: </div>
1.148     asau     10640: <div class="sect2">
1.75      rillig   10641: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10642: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10643: <p>Action files take some input parameters and may define
                   10644:        runtime variables. They shall not define loadtime variables.
                   10645:        There are action files that are included implicitly by the
                   10646:        pkgsrc infrastructure, while other must be included
                   10647:        explicitly.</p>
                   10648: <p>An example for action files is
1.76      rillig   10649:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10650: </div>
                   10651: </div>
1.148     asau     10652: <div class="sect1">
1.81      rillig   10653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10654: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10655: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10656:        a set of variable definitions, and include the file
                   10657:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10658:        Before that, they may also include various other
                   10659:        <code class="filename">*.mk</code> files if they need to query the
                   10660:        availability of certain features like the type of compiler or
                   10661:        the X11 implementation. Due to the heavy use of preprocessor
                   10662:        directives like <code class="literal">.if</code> and
                   10663:        <code class="literal">.for</code>, the order in which the files are loaded
                   10664:        matters.</p>
                   10665: <p>This section describes at which point the various files
                   10666:        are loaded and gives reasons for that order.</p>
1.148     asau     10667: <div class="sect2">
1.81      rillig   10668: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10669: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10670: </h3></div></div></div>
                   10671: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10672:        is to define some essential variables like
                   10673:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10674:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10675: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10676:        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   10677:        After that, those variables
1.81      rillig   10678:        that have not been overridden by the user are loaded from
                   10679:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10680: <p>After the user settings, the system settings and platform
                   10681:        settings are loaded, which may override the user
                   10682:        settings.</p>
                   10683: <p>Then, the tool definitions are loaded. The tool wrappers
                   10684:        are not yet in effect. This only happens when building a
                   10685:        package, so the proper variables must be used instead of the
                   10686:        direct tool names.</p>
                   10687: <p>As the last steps, some essential variables from the
                   10688:        wrapper and the package system flavor are loaded, as well as the
                   10689:        variables that have been cached in earlier phases of a package
                   10690:        build.</p>
                   10691: </div>
1.148     asau     10692: <div class="sect2">
1.81      rillig   10693: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10694: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10695: </h3></div></div></div>
1.81      rillig   10696: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10697: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10698:        loaded, which fill default values for those variables that have
1.93      rillig   10699:        not been defined by the package. These variables may later
1.81      rillig   10700:        be used even in unrelated files.</p>
                   10701: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10702:        provides the target <code class="literal">error-check</code> that is added
                   10703:        as a special dependency to all other targets that use
                   10704:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10705:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10706: <p>Then, the package-specific hacks from
                   10707:        <code class="filename">hacks.mk</code> are included.</p>
                   10708: <p>Then, various other files follow. Most of them don't have
                   10709:        any dependencies on what they need to have included before or
                   10710:        after them, though some do.</p>
                   10711: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10712:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10713:        restricts the use of these variables to all the files that have
                   10714:        been included before. Appearances in later files will be
                   10715:        silently ignored.</p>
                   10716: <p>Then, the files for the main targets are included, in the
                   10717:        order of later execution, though the actual order should not
                   10718:        matter.</p>
                   10719: <p>At last, some more files are included that don't set any
                   10720:        interesting variables but rather just define make targets to be
                   10721:        executed.</p>
                   10722: </div>
                   10723: </div>
1.75      rillig   10724: </div>
1.148     asau     10725: <div class="chapter">
1.75      rillig   10726: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10727: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10728: <div class="toc">
                   10729: <p><b>Table of Contents</b></p>
                   10730: <dl>
1.106     rillig   10731: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10732: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10733: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10734: <dd><dl>
1.106     rillig   10735: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10736: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10737: </dl></dd>
                   10738: </dl>
                   10739: </div>
                   10740: <p>The pkgsrc infrastructure consists of a large codebase,
                   10741:        and there are many corners where every little bit of a file is
                   10742:        well thought out, making pkgsrc likely to fail as soon as
                   10743:        anything is changed near those parts. To prevent most changes
                   10744:        from breaking anything, a suite of regression tests should go
                   10745:        along with every important part of the pkgsrc infrastructure.
                   10746:        This chapter describes how regression tests work in pkgsrc and
                   10747:        how you can add new tests.</p>
1.148     asau     10748: <div class="sect1">
1.75      rillig   10749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10750: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10751: <p></p>
                   10752: </div>
1.148     asau     10753: <div class="sect1">
1.75      rillig   10754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10755: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10756: <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  10757:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10758:        can simply run that command, which will run all tests in the
1.76      rillig   10759:        <code class="filename">regress</code> category.</p>
1.75      rillig   10760: </div>
1.148     asau     10761: <div class="sect1">
1.75      rillig   10762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10763: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10764: <p>Every directory in the <code class="filename">regress</code>
                   10765:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10766:        is considered a regression test. This file is a shell program
1.110     hubertf  10767:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10768:        The following functions can be overridden to suit your
                   10769:        needs.</p>
1.148     asau     10770: <div class="sect2">
1.75      rillig   10771: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10772: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10773: <p>These functions do not take any parameters. They are all
1.128     wiz      10774:        called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
1.75      rillig   10775:        to check the exitcodes of any commands you run in the
                   10776:        test.</p>
1.148     asau     10777: <div class="variablelist"><dl class="variablelist">
1.75      rillig   10778: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10779: <dd><p>This function prepares the environment for the
                   10780:        test. By default it does nothing.</p></dd>
                   10781: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10782: <dd><p>This function runs the actual test. By default,
                   10783:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10784:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10785:        error messages into the file
                   10786:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10787: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10788: <dd><p>This function is run after the test and is
                   10789:        typically used to compare the actual output from the one that is
                   10790:        expected. It can make use of the various helper functions from
                   10791:        the next section.</p></dd>
                   10792: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10793: <dd><p>This function cleans everything up after the
                   10794:        test has been run. By default it does nothing.</p></dd>
                   10795: </dl></div>
                   10796: </div>
1.148     asau     10797: <div class="sect2">
1.75      rillig   10798: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10799: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.148     asau     10800: <div class="variablelist"><dl class="variablelist">
1.75      rillig   10801: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10802: <dd><p>This function compares the exitcode of the
1.110     hubertf  10803:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10804:        If they differ, the test will fail.</p></dd>
                   10805: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10806: <dd><p>This function checks for each of its parameters
1.110     hubertf  10807:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10808:        extended regular expression. If it does not, the test will
                   10809:        fail.</p></dd>
                   10810: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10811: <dd><p>This function checks for each of its parameters
1.110     hubertf  10812:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10813:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10814:        If any of the regular expressions matches, the test will
                   10815:        fail.</p></dd>
                   10816: </dl></div>
                   10817: </div>
                   10818: </div>
                   10819: </div>
1.148     asau     10820: <div class="chapter">
1.75      rillig   10821: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10822: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10823: <div class="toc">
                   10824: <p><b>Table of Contents</b></p>
                   10825: <dl>
1.106     rillig   10826: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10827: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10828: </dl>
                   10829: </div>
                   10830: <p>The pkgsrc system has already been ported to many
                   10831:        operating systems, hardware architectures and compilers. This
                   10832:        chapter explains the necessary steps to make pkgsrc even more
                   10833:        portable.</p>
1.148     asau     10834: <div class="sect1">
1.75      rillig   10835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10836: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10837: <p>To port pkgsrc to a new operating system (called
                   10838:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10839:        following files:</p>
1.148     asau     10840: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10841: <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   10842: <dd><p>This file contains some basic definitions, for
                   10843:        example the name of the C
                   10844:        compiler.</p></dd>
1.76      rillig   10845: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10846: <dd><p>Insert code that defines the variables
                   10847:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10848:        <code class="varname">LOWER_OS_VERSION</code>,
                   10849:        <code class="varname">LOWER_VENDOR</code>,
                   10850:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10851:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10852:        appear in this file.</p></dd>
1.93      rillig   10853: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10854: <dd><p>This file contains the platform-specific
                   10855:        definitions that are used by pkgsrc. Start by copying one of the
                   10856:        other files and edit it to your
                   10857:        needs.</p></dd>
1.93      rillig   10858: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10859: <dd><p>This file contains a list of directories,
                   10860:        together with their permission bits and ownership. These
                   10861:        directories will be created automatically with every package
1.98      wiz      10862:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10863:        be removed.</p></dd>
1.93      rillig   10864: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10865: <dd><p>Just copy one of the pre-existing x11.dist files
                   10866:        to your
1.76      rillig   10867:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10868: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10869: <dd><p>On some operating systems, the tools that are
                   10870:        provided with the base system are not good enough for pkgsrc.
1.136     dholland 10871:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75      rillig   10872:        narrow limit on the line length they can process. Therefore
                   10873:        pkgsrc brings its own tools, which can be enabled
                   10874:        here.</p></dd>
1.93      rillig   10875: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10876: <dd><p>This file defines the paths to all the tools
                   10877:        that are needed by one or the other package in pkgsrc, as well
                   10878:        as by pkgsrc itself. Find out where these tools are on your
                   10879:        platform and add them.</p></dd>
                   10880: </dl></div>
                   10881: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10882:        <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   10883: </div>
1.148     asau     10884: <div class="sect1">
1.75      rillig   10885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10886: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10887: <p>TODO</p>
                   10888: </div>
                   10889: </div>
                   10890: </div>
1.148     asau     10891: <div class="appendix">
                   10892: <div class="titlepage"><div><div><h1 class="title">
                   10893: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10894: <div class="toc">
                   10895: <p><b>Table of Contents</b></p>
                   10896: <dl>
                   10897: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10898: <dd><dl>
                   10899: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10900: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10901: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      10902: <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   10903: </dl></dd>
                   10904: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10905: </dl>
                   10906: </div>
                   10907: <p>We checked to find a piece of software that wasn't in the packages
                   10908:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10909:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10910:     present in the tree is beyond us, but it's useful for the purposes of
                   10911:     this exercise.</p>
1.148     asau     10912: <div class="sect1">
1.75      rillig   10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10914: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10915: <div class="sect2">
1.75      rillig   10916: <div class="titlepage"><div><div><h3 class="title">
                   10917: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10918: <pre class="programlisting">
1.100     rillig   10919: # $NetBSD$
                   10920: #
1.1       grant    10921: 
1.100     rillig   10922: DISTNAME=       bison-1.25
                   10923: CATEGORIES=     devel
                   10924: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10925: 
1.136     dholland 10926: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   10927: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10928: COMMENT=        GNU yacc clone
1.1       grant    10929: 
1.100     rillig   10930: GNU_CONFIGURE=  yes
1.152     wiz      10931: INFO_FILES=     yes
1.1       grant    10932: 
1.100     rillig   10933: .include "../../mk/bsd.pkg.mk"
1.1       grant    10934: </pre>
1.75      rillig   10935: </div>
1.148     asau     10936: <div class="sect2">
1.75      rillig   10937: <div class="titlepage"><div><div><h3 class="title">
                   10938: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10939: <pre class="programlisting">
1.100     rillig   10940: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.136     dholland 10941: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10942: of the NetBSD source tree is beyond me.
1.1       grant    10943: </pre>
1.75      rillig   10944: </div>
1.148     asau     10945: <div class="sect2">
1.75      rillig   10946: <div class="titlepage"><div><div><h3 class="title">
                   10947: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10948: <pre class="programlisting">
1.100     rillig   10949: @comment $NetBSD$
                   10950: bin/bison
                   10951: man/man1/bison.1.gz
                   10952: share/bison.simple
                   10953: share/bison.hairy
1.1       grant    10954: </pre>
1.75      rillig   10955: </div>
1.148     asau     10956: <div class="sect2">
1.75      rillig   10957: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10958: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10959: </h3></div></div></div>
1.75      rillig   10960: <p>The NetBSD package system comes with
1.91      rillig   10961:         <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   10962:        which helps to check the contents of these
                   10963:        files. After installation it is quite easy to use, just change to the
                   10964:        directory of the package you wish to examine and execute
1.110     hubertf  10965:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10966: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10967: looks fine.</pre>
                   10968: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10969:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10970:        -Wall</strong></span> for a very thorough check.</p>
                   10971: </div>
                   10972: </div>
1.148     asau     10973: <div class="sect1">
1.75      rillig   10974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10975: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10976: <p>Create the directory where the package lives,
                   10977:       plus any auxiliary directories:</p>
                   10978: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10979: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10980: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10981: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10982: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10983:       <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   10984:       then continue with fetching the distfile:</p>
                   10985: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10986: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10987: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10988: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10989: ftp: Error retrieving file: 500 Internal error
                   10990: 
                   10991: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10992: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10993: ftp: Error retrieving file: 500 Internal error
                   10994: 
                   10995: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10996: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10997: Successfully retrieved file.</pre>
                   10998: <p>Generate the checksum of the distfile into
1.76      rillig   10999:       <code class="filename">distinfo</code>:</p>
1.88      wiz      11000: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   11001: <p>Now compile:</p>
                   11002: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    11003: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11004: ===&gt;  Extracting for bison-1.25
                   11005: ===&gt;  Patching for bison-1.25
                   11006: ===&gt;   Ignoring empty patch directory
                   11007: ===&gt;  Configuring for bison-1.25
                   11008: creating cache ./config.cache
                   11009: checking for gcc... cc
                   11010: checking whether we are using GNU C... yes
                   11011: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   11012: checking how to run the C preprocessor... cc -E
                   11013: checking for minix/config.h... no
                   11014: checking for POSIXized ISC... no
                   11015: checking whether cross-compiling... no
                   11016: checking for ANSI C header files... yes
                   11017: checking for string.h... yes
                   11018: checking for stdlib.h... yes
                   11019: checking for memory.h... yes
                   11020: checking for working const... yes
                   11021: checking for working alloca.h... no
                   11022: checking for alloca... yes
                   11023: checking for strerror... yes
                   11024: updating cache ./config.cache
                   11025: creating ./config.status
                   11026: creating Makefile
                   11027: ===&gt;  Building for bison-1.25
                   11028: 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
                   11029: 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
                   11030: 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
                   11031: 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
                   11032: 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   11033: 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    11034: 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
                   11035: 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
                   11036: 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
                   11037: 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
                   11038: 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
                   11039: 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
                   11040: 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
                   11041: 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
                   11042: 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
                   11043: 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
                   11044: 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
                   11045: 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
                   11046: 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
                   11047: 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
                   11048: 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
                   11049: 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
                   11050: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   11051: rm -f bison.s1
1.75      rillig   11052: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   11053: <p>Everything seems OK, so install the files:</p>
                   11054: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    11055: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11056: ===&gt;  Installing for bison-1.25
                   11057: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   11058: rm -f /usr/pkg/bin/bison
                   11059: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   11060: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   11061: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   11062: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   11063: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   11064: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   11065: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   11066: ===&gt;  Registering installation for bison-1.25</pre>
                   11067: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  11068:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   11069:       binary package, do this now:</p>
                   11070: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11071: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   11072: ===&gt;  Building package for bison-1.25
                   11073: Creating package bison-1.25.tgz
                   11074: Registering depends:.
1.75      rillig   11075: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   11076: <p>Now that you don't need the source and object files
                   11077:       any more, clean up:</p>
                   11078: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   11079: ===&gt;  Cleaning for bison-1.25</pre>
                   11080: </div>
                   11081: </div>
1.148     asau     11082: <div class="appendix">
                   11083: <div class="titlepage"><div><div><h1 class="title">
                   11084: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   11085: <div class="toc">
                   11086: <p><b>Table of Contents</b></p>
                   11087: <dl>
                   11088: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   11089: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   11090: </dl>
                   11091: </div>
1.148     asau     11092: <div class="sect1">
1.75      rillig   11093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11094: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   11095: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    11096: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11097: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   11098: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   11099: =&gt; [172219 bytes]
                   11100: Connected to ftp.plig.net.
                   11101: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   11102: 331 Guest login ok, send your complete e-mail address as password.
                   11103: 230-You are user #5 of 500 simultaneous users allowed.
                   11104: 230-
1.68      rillig   11105: 230-  ___ _             _ _
                   11106: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    11107: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   11108: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   11109: 230-         |_|   |_|     |___|         |___|
                   11110: 230-
                   11111: 230-** Welcome to ftp.plig.org **
                   11112: 230-
                   11113: 230-Please note that all transfers from this FTP site are logged. If you
                   11114: 230-do not like this, please disconnect now.
                   11115: 230-
1.120     snj      11116: 230-This archive is available via
1.1       grant    11117: 230-
                   11118: 230-HTTP:  http://ftp.plig.org/
                   11119: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   11120: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   11121: 230-
                   11122: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   11123: 230-mirrored to ftp-admin@plig.org.
1.1       grant    11124: 230-
                   11125: 230-
                   11126: 230 Logged in anonymously.
                   11127: Remote system type is UNIX.
                   11128: Using binary mode to transfer files.
                   11129: 200 Type okay.
                   11130: 250 "/pub" is new cwd.
                   11131: 250-"/pub/figlet" is new cwd.
                   11132: 250-
                   11133: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   11134: 250-
1.75      rillig   11135: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    11136: 250-
                   11137: 250-The official FIGlet web page is:
1.75      rillig   11138: 250-   http://www.figlet.org/
1.1       grant    11139: 250-
                   11140: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11141: 250-contribute a font or something else, you can email us.
1.68      rillig   11142: 250
1.1       grant    11143: 250 "/pub/figlet/program" is new cwd.
                   11144: 250 "/pub/figlet/program/unix" is new cwd.
                   11145: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11146: 502 Unimplemented command.
                   11147: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11148: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11149: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11150: 226 Transfer completed.
                   11151: 172219 bytes received in 00:02 (75.99 KB/s)
                   11152: 221 Goodbye.
                   11153: =&gt; Checksum OK for figlet221.tar.gz.
                   11154: ===&gt; Extracting for figlet-2.2.1nb2
                   11155: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11156: ===&gt; Patching for figlet-2.2.1nb2
                   11157: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11158: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11159: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11160: ===&gt; Configuring for figlet-2.2.1nb2
                   11161: ===&gt; Building for figlet-2.2.1nb2
                   11162: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11163: chmod a+x figlet
                   11164: gcc -O2 -o chkfont chkfont.c
                   11165: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  11166: <code class="prompt">#</code>
1.75      rillig   11167: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    11168: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11169: ===&gt; Installing for figlet-2.2.1nb2
                   11170: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11171: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11172: mkdir -p /usr/pkg/share/figlet
                   11173: cp figlet /usr/pkg/bin
                   11174: cp chkfont /usr/pkg/bin
                   11175: chmod 555 figlist showfigfonts
                   11176: cp figlist /usr/pkg/bin
                   11177: cp showfigfonts /usr/pkg/bin
                   11178: cp fonts/*.flf /usr/pkg/share/figlet
                   11179: cp fonts/*.flc /usr/pkg/share/figlet
                   11180: cp figlet.6 /usr/pkg/man/man6
                   11181: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   11182: <code class="prompt">#</code></pre>
                   11183: </div>
1.148     asau     11184: <div class="sect1">
1.75      rillig   11185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11186: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   11187: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11188: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11189: ===&gt; Packaging figlet-2.2.1nb2
                   11190: ===&gt; Building binary package for figlet-2.2.1nb2
                   11191: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11192: Using SrcDir value of /usr/pkg
1.68      rillig   11193: Registering depends:.
1.75      rillig   11194: <code class="prompt">#</code></pre>
                   11195: </div>
                   11196: </div>
1.148     asau     11197: <div class="appendix">
                   11198: <div class="titlepage"><div><div><h1 class="title">
                   11199: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   11200: <div class="toc">
                   11201: <p><b>Table of Contents</b></p>
                   11202: <dl>
1.128     wiz      11203: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11204: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11205: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11206: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11207: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   11208: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11209: source packages</a></span></dt>
                   11210: </dl>
                   11211: </div>
                   11212: <p>As in other big projects, the directory layout of pkgsrc
                   11213:        is quite complex for newbies. This chapter explains where you
                   11214:        find things on the FTP server. The base directory on
1.110     hubertf  11215:        <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   11216:        On other servers it may be different, but inside this directory,
                   11217:        everything should look the same, no matter on which server you
                   11218:        are. This directory contains some subdirectories, which are
                   11219:        explained below.</p>
1.148     asau     11220: <div class="sect1">
1.76      rillig   11221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11222: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   11223: <p>The directory <code class="filename">distfiles</code> contains lots
                   11224:        of archive files from all pkgsrc packages, which are mirrored
                   11225:        here. The subdirectories are called after their package names
                   11226:        and are used when the distributed files have names that don't
                   11227:        explicitly contain a version number or are otherwise too generic
                   11228:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11229: </div>
1.148     asau     11230: <div class="sect1">
1.76      rillig   11231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11232: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   11233: <p>This directory contains things that individual pkgsrc
                   11234:        developers find worth publishing.</p>
                   11235: </div>
1.148     asau     11236: <div class="sect1">
1.76      rillig   11237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11238: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   11239: <p>This directory contains binary packages for the various
                   11240:        platforms that are supported by pkgsrc.
                   11241:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148     asau     11242: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      11243: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11244:        operating system for which the packages have been built. The
1.110     hubertf  11245:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11246:        command, so it may differ from the one you are used to
                   11247:        hear.</p></li>
1.128     wiz      11248: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   11249:        architecture of the platform for which the packages have been
1.110     hubertf  11250:        built. It also includes the <code class="varname">ABI</code> (Application
                   11251:        Binary Interface) for platforms that have several of
                   11252:        them.</p></li>
1.128     wiz      11253: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   11254:        the operating system. For version numbers that change often (for
                   11255:        example NetBSD-current), the often-changing part should be
                   11256:        replaced with an <code class="literal">x</code>, for example
                   11257:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      11258: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 11259:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   11260:        for a stable branch, or <code class="literal">head</code> for packages
                   11261:        built from the HEAD branch. The latter should only be used when
                   11262:        the packages are updated on a regular basis. Otherwise the date
                   11263:        from checking out pkgsrc should be appended, for example
                   11264:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11265: </ul></div>
                   11266: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11267:        can quickly click through the directories on the
                   11268:        server and find the best binary packages for their machines. Since they
                   11269:        usually know the operating system and the hardware architecture, OPSYS
                   11270:        and ARCH are placed first. After these choices, they can select the
                   11271:        best combination of OSVERSION and TAG together, since it is usually the
                   11272:        case that packages stay compatible between different version of the
                   11273:        operating system.</p>
                   11274: <p>In each of these directories, there is a
                   11275:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11276:        <code class="filename">All</code> which contains all binary packages.
                   11277:        Besides that, there are various category directories that
                   11278:        contain symbolic links to the real binary packages.</p>
                   11279: </div>
1.148     asau     11280: <div class="sect1">
1.76      rillig   11281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11282: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11283: <p>Here are the reports from bulk builds, for those who want
                   11284:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      11285:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   11286: </div>
1.148     asau     11287: <div class="sect1">
1.108     rillig   11288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11289: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11290: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11291: source packages</h2></div></div></div>
1.128     wiz      11292: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11293:        that is the files that define how to create binary packages from
                   11294:        source archives.</p>
                   11295: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11296:        snapshot of the CVS repository, which is updated regularly. The
                   11297:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11298:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   11299: <p>In the directories for the quarterly branches, there is an
                   11300:        additional file called
1.126     jakllsch 11301:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76      rillig   11302:        which contains the state of pkgsrc when it was branched.</p>
                   11303: </div>
1.75      rillig   11304: </div>
1.148     asau     11305: <div class="appendix">
                   11306: <div class="titlepage"><div><div><h1 class="title">
                   11307: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   11308: <div class="toc">
                   11309: <p><b>Table of Contents</b></p>
                   11310: <dl>
1.79      rillig   11311: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   11312: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11313: </dl>
                   11314: </div>
1.79      rillig   11315: <p>This section contains information on editing the pkgsrc
                   11316:        guide itself.</p>
1.148     asau     11317: <div class="sect1">
1.75      rillig   11318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11319: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11320: <p>The pkgsrc guide's source code is stored in
                   11321:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11322:        are created from it:</p>
1.148     asau     11323: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      11324: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11325: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11326: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11327: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   11328:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      11329: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   11330:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11331: </ul></div>
                   11332: </div>
1.148     asau     11333: <div class="sect1">
1.75      rillig   11334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11335: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11336: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      11337: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     11338: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      11339:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   11340:        documentation) installed. These are automatically installed when
                   11341:        you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     11342: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11343:        right directory. All further steps will take place
                   11344:        here.</p></li>
1.148     asau     11345: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   11346:        <code class="filename">files/</code>.</p></li>
1.148     asau     11347: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11348:        guide for valid XML and to build the final output files. If you
                   11349:        get any errors at this stage, you can just edit the files, as
                   11350:        there are only symbolic links in the working directory, pointing
                   11351:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     11352: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11353:        commit)</strong></span></p></li>
1.148     asau     11354: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11355:        regenerate the output files with the proper RCS
                   11356:        Ids.</p></li>
1.148     asau     11357: <li class="step">
1.110     hubertf  11358: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11359:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11360:        <code class="filename">htdocs</code>.</p>
1.148     asau     11361: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   11362: <h3 class="title">Note</h3>
                   11363: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11364:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11365:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11366:        directory.</p>
                   11367: </div>
                   11368: </li>
1.79      rillig   11369: </ol></div>
1.75      rillig   11370: </div>
                   11371: </div>
                   11372: </div></body>
1.1       grant    11373: </html>

CVSweb <webmaster@jp.NetBSD.org>