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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.101     rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
                     21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
                     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
                     27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
                     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
                     33: <div><p class="copyright">Copyright © 1994-2006 The NetBSD Foundation, Inc</p></div>
1.92      rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103   ! wiz       116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
        !           117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       118: <dd><dl>
1.103   ! wiz       119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
        !           120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !           121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       122: </dl></dd>
1.103   ! wiz       123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
        !           124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    130: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    131: <dd><dl>
                    132: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    133: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    134: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    135: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    136: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    137: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    138: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    140: </dl></dd>
                    141: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    143: </dl></dd>
1.90      rillig    144: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75      rillig    145: <dd><dl>
1.91      rillig    146: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig    147: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
                    150: <dd><dl>
                    151: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    154: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    155: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103   ! wiz       156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
        !           157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
        !           158: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
        !           159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
        !           160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig    161: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.103   ! wiz       162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
        !           163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
        !           164: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
        !           165: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
        !           166: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !           167: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build.  What shall I do?</a></span></dt>
        !           168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.90      rillig    173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    174: <dd><dl>
                    175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                    176: <dd><dl>
                    177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                    178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                    179: </dl></dd>
                    180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                    181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    182: </dl></dd>
1.90      rillig    183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig    184: <dd><dl>
1.90      rillig    185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                    186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                    188: <dd><dl>
1.93      rillig    189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                    193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig    194: </dl></dd>
                    195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                    196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                    200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                    201: </dl></dd>
                    202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                    203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                    204: </dl></dd>
                    205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                    206: <dd><dl>
1.97      rillig    207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                    208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                    210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                    211: <dd><dl>
                    212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                    213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                    214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                    215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                    216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig    217: </dl></dd>
                    218: </dl></dd>
                    219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                    220: <dd><dl>
                    221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                    222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                    224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                    225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                    226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                    228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                    233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    234: <dd><dl>
                    235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                    237: </dl></dd>
                    238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    239: <dd><dl>
                    240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    242: </dl></dd>
                    243: </dl></dd>
                    244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                    245: <dd><dl>
                    246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                    247: <dd><dl>
                    248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                    249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                    250: </dl></dd>
                    251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                    252: <dd><dl>
                    253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                    255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                    256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                    257: </dl></dd>
                    258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                    259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                    261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                    262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                    264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    265: </dl></dd>
                    266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                    267: <dd><dl>
                    268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                    269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                    271: </dl></dd>
                    272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                    273: <dd><dl>
                    274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                    281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                    282: </dl></dd>
                    283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                    295: </dl></dd>
                    296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                    297: <dd><dl>
                    298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig    301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig    302: </dl></dd>
                    303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                    304: <dd><dl>
                    305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                    306: <dd><dl>
                    307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                    308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                    310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                    311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                    312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                    313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                    314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                    315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                    317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    319: </dl></dd>
                    320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    321: <dd><dl>
                    322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                    328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                    334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                    335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                    336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                    342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                    343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                    344: </dl></dd>
                    345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                    348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100     rillig    349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103   ! wiz       350: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
        !           351: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
        !           352: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
        !           353: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
        !           354: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
        !           355: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
        !           356: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
        !           357: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
        !           358: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
        !           359: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
        !           360: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
        !           361: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
        !           362: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
        !           363: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
        !           364: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87      wiz       365:     emulation</a></span></dt>
1.103   ! wiz       366: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
        !           367: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    368: </dl></dd>
1.90      rillig    369: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig    370: </dl></dd>
1.90      rillig    371: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                    372: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig    373: <dd><dl>
1.90      rillig    374: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                    375: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    376: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                    377: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                    378: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                    379: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                    380: </dl></dd>
                    381: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                    382: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    383: <dd><dl>
                    384: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    385: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    386: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    387: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv      388: </dl></dd>
1.75      rillig    389: </dl></dd>
                    390: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    391: <dd><dl>
1.90      rillig    392: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    393: <dd><dl>
1.90      rillig    394: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                    395: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                    396: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig    397: <dd><dl>
1.90      rillig    398: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                    399: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig    400: </dl></dd>
1.90      rillig    401: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                    402: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    403: <dd><dl>
1.90      rillig    404: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                    405: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    406: </dl></dd>
1.90      rillig    407: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig    408: <dd><dl>
1.90      rillig    409: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    410: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    411: </dl></dd>
                    412: </dl></dd>
1.90      rillig    413: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig    414: <dd><dl>
1.90      rillig    415: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                    416: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                    417: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig    418: <dd><dl>
1.90      rillig    419: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                    420: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig    421: </dl></dd>
                    422: </dl></dd>
1.90      rillig    423: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig    424: <dd><dl>
1.90      rillig    425: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                    426: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    427: </dl></dd>
                    428: </dl></dd>
                    429: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    430: <dd><dl>
                    431: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    432: <dd><dl>
                    433: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    434: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    435: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                    436: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                    437: </dl></dd>
                    438: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    439: </dl></dd>
                    440: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    441: <dd><dl>
                    442: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    443: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    444: </dl></dd>
1.76      rillig    445: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                    448: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    449: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                    450: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102     rillig    451: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.76      rillig    452: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig    453: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    454: source packages</a></span></dt>
                    455: </dl></dd>
1.75      rillig    456: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    457: <dd><dl>
1.79      rillig    458: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    459: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    460: </dl></dd>
                    461: </dl>
                    462: </div>
1.82      rillig    463: <div class="list-of-tables">
                    464: <p><b>List of Tables</b></p>
                    465: <dl>
                    466: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    467: </dt>
                    468: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
                    469: </dt>
1.90      rillig    470: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      471: </dt>
1.90      rillig    472: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      473: </dt>
1.82      rillig    474: </dl>
                    475: </div>
1.75      rillig    476: <div class="chapter" lang="en">
                    477: <div class="titlepage"><div><div><h2 class="title">
                    478: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    479: <div class="toc">
                    480: <p><b>Table of Contents</b></p>
                    481: <dl>
                    482: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    483: <dd><dl>
                    484: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    485: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    486: </dl></dd>
1.75      rillig    487: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    488: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       489: <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    490: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    491: </dl>
                    492: </div>
                    493: <div class="sect1" lang="en">
                    494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    495: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    496: <p>There is a lot of software freely available for Unix-based
                    497: systems, which is usually available in form of the source code. Before
                    498: such software can be used, it needs to be configured to the local
                    499: system, compiled and installed, and this is exactly what The NetBSD
                    500: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    501: to handle binary packages, so that not every user has to build the
                    502: packages for himself, which is a time-costly task.</p>
1.75      rillig    503: <p>pkgsrc currently contains several thousand packages,
                    504:       including:</p>
                    505: <div class="itemizedlist"><ul type="disc">
1.91      rillig    506: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75      rillig    507:          web server</p></li>
1.91      rillig    508: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    509:          web browser</p></li>
1.91      rillig    510: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    511:          Desktop Environment</p></li>
1.91      rillig    512: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75      rillig    513:          Desktop Environment</p></li>
                    514: </ul></div>
                    515: <p>...just to name a few.</p>
                    516: <p>pkgsrc has built-in support for handling varying dependencies,
                    517:       such as pthreads and X11, and extended features such as IPv6 support on
                    518:       a range of platforms.</p>
1.82      rillig    519: <div class="sect2" lang="en">
                    520: <div class="titlepage"><div><div><h3 class="title">
                    521: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    522: <p>
                    523: pkgsrc provides the following key features:
                    524: </p>
                    525: <div class="itemizedlist"><ul type="disc">
                    526: <li><p>Easy building of software from source as well as the creation
                    527:   and installation of binary packages. The source and latest
                    528:   patches are retrieved from a master or mirror download site, checksum
                    529:   verified, then built on your system. Support for binary-only
                    530:   distributions is available for both native platforms and NetBSD
                    531:   emulated platforms.</p></li>
                    532: <li><p>All packages are installed in a consistent directory tree,
                    533:   including binaries, libraries, man pages and other
                    534:   documentation.</p></li>
                    535: <li><p>Package dependencies, including when performing package updates,
                    536:   are handled automatically. The configuration files of various
                    537:   packages are handled automatically during updates, so local changes
                    538:   are preserved.</p></li>
                    539: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    540:   consists of highly portable code. This allows the greatest speed of
                    541:   development when porting to new a platform. This portability also
                    542:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    543:   platforms</em></span>.</p></li>
                    544: <li><p>The installation prefix, acceptable software licenses,
                    545:   international encryption requirements and build-time options for a
                    546:   large number of packages are all set in a simple, central
                    547:   configuration file.</p></li>
                    548: <li><p>The entire source (not including the distribution files) is
                    549:   freely available under a BSD license, so you may extend and adapt
                    550:   pkgsrc to your needs. Support for local packages and patches is
                    551:   available right out of the box, so you can configure it specifically
                    552:   for your environment.</p></li>
                    553: </ul></div>
1.91      rillig    554: <p>The following principles are basic to pkgsrc:</p>
                    555: <div class="itemizedlist"><ul type="disc">
                    556: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.103   ! wiz       557: &#8212; That means, if a package contains bugs, it's better to find
1.91      rillig    558: them and to complain about them rather than to just install the package
                    559: and hope that it works. There are numerous checks in pkgsrc that try to
                    560: 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
                    561: of shell scripts), and post-installation checks (installed files,
                    562: references to shared libraries, script interpreters).</p></li>
                    563: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.103   ! wiz       564: &#8212; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    565: pkgsrc has been ported to many operating systems. Care is taken that
                    566: packages behave the same on all platforms.</p></li>
                    567: </ul></div>
1.82      rillig    568: </div>
                    569: <div class="sect2" lang="en">
                    570: <div class="titlepage"><div><div><h3 class="title">
                    571: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    572: <p>pkgsrc consists of both a source distribution and a binary
                    573: distribution for these operating systems. After retrieving the required
                    574: source or binaries, you can be up and running with pkgsrc in just
                    575: minutes!</p>
1.75      rillig    576: <p>pkgsrc was derived from FreeBSD's ports system, and
                    577:       initially developed for NetBSD only. Since then, pkgsrc has
                    578:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    579: <div class="table">
                    580: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    581: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    582: <colgroup>
                    583: <col>
                    584: <col>
                    585: </colgroup>
                    586: <thead><tr>
                    587: <th>Platform</th>
                    588: <th>Date Support Added</th>
                    589: </tr></thead>
                    590: <tbody>
                    591: <tr>
                    592: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
                    593: <td align="center">Aug 1997</td>
                    594: </tr>
                    595: <tr>
                    596: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
                    597: <td align="center">Mar 1999</td>
                    598: </tr>
                    599: <tr>
                    600: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
                    601: <td align="center">Jun 1999</td>
                    602: </tr>
                    603: <tr>
                    604: <td>
                    605:           <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    606:           (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
                    607:         </td>
                    608: <td align="center">Oct 2001</td>
                    609: </tr>
                    610: <tr>
                    611: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
                    612: <td align="center">Nov 2002</td>
                    613: </tr>
                    614: <tr>
                    615: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
                    616: <td align="center">Nov 2002</td>
                    617: </tr>
                    618: <tr>
                    619: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
                    620: <td align="center">Dec 2002</td>
                    621: </tr>
                    622: <tr>
                    623: <td>BSD/OS</td>
                    624: <td align="center">Dec 2003</td>
                    625: </tr>
                    626: <tr>
                    627: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
                    628: <td align="center">Dec 2003</td>
                    629: </tr>
                    630: <tr>
                    631: <td>
                    632:           <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
                    633:           (Microsoft Windows Services for Unix)
                    634:         </td>
                    635: <td align="center">Mar 2004</td>
                    636: </tr>
                    637: <tr>
                    638: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
                    639: <td align="center">Oct 2004</td>
                    640: </tr>
                    641: <tr>
                    642: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
                    643: <td align="center">Nov 2004</td>
                    644: </tr>
1.98      wiz       645: <tr>
                    646: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
                    647: <td align="center">Apr 2007</td>
                    648: </tr>
1.82      rillig    649: </tbody>
1.91      rillig    650: </table></div>
1.82      rillig    651: </div>
1.91      rillig    652: <br class="table-break">
1.82      rillig    653: </div>
1.75      rillig    654: </div>
                    655: <div class="sect1" lang="en">
                    656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    657: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    658: <p>This document is divided into three parts. The first,
                    659:        <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
                    660:        describes how one can use one of the packages in the Package
                    661:        Collection, either by installing a precompiled binary package,
1.93      rillig    662:        or by building one's own copy using the NetBSD package system.
1.75      rillig    663:        The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
                    664:        package so it can be easily built by other NetBSD users without
                    665:        knowing about the package's building details. The third part,
                    666:        <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
                    667:        is intended for those who want to understand how pkgsrc is
                    668:        implemented.</p>
                    669: <p>This document is available in various formats:
                    670:        <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
                    671: </div>
                    672: <div class="sect1" lang="en">
                    673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    674: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    675: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    676:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    677:       terminology used within this document.</p>
                    678: <div class="variablelist"><dl>
                    679: <dt><span class="term">Package</span></dt>
                    680: <dd><p>A set of files and building instructions
                    681:            that describe what's necessary
                    682:            to build a certain piece of software using
                    683:             pkgsrc. Packages are traditionally stored under
1.76      rillig    684:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    685: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       686: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    687:          is part of the NetBSD operating system and can be bootstrapped
                    688:          to run on non-NetBSD operating systems as well.  It handles
                    689:          building (compiling), installing, and removing of
                    690:          packages.</p></dd>
1.75      rillig    691: <dt><span class="term">Distfile</span></dt>
                    692: <dd><p>This term describes the file or files that are
                    693:            provided by the author of the piece of software to
                    694:            distribute his work. All the changes necessary to build on
                    695:            NetBSD are reflected in the corresponding package. Usually
                    696:            the distfile is in the form of a compressed tar-archive,
                    697:            but other types are possible, too. Distfiles are usually
                    698:            stored below
1.76      rillig    699:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    700: <dt><span class="term">Port</span></dt>
                    701: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    702:            for what we call a package.
                    703:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    704:            architecture.</p></dd>
                    705: <dt><span class="term">Precompiled/binary package</span></dt>
                    706: <dd>
                    707: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    708:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    709:            file so it can be installed on machines of the same
                    710:            machine architecture without the need to
                    711:            recompile. Packages are usually generated in
1.76      rillig    712:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75      rillig    713:            an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
                    714: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    715:            especially in the context of precompiled packages.</p>
                    716: </dd>
                    717: <dt><span class="term">Program</span></dt>
1.88      wiz       718: <dd><p>The piece of software to be installed which will be
                    719:          constructed from all the files in the distfile by the
                    720:          actions defined in the corresponding package.</p></dd>
1.75      rillig    721: </dl></div>
                    722: <div class="sect2" lang="en">
                    723: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       724: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    725: <div class="variablelist"><dl>
                    726: <dt><span class="term">pkgsrc users</span></dt>
                    727: <dd>
                    728: <p>The
                    729:        pkgsrc users are people who use the packages provided by pkgsrc.
                    730:        Typically they are system administrators. The people using the
                    731:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    732:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    733: <p>There are two kinds of pkgsrc users: Some only want to
                    734:        install pre-built binary packages. Others build the pkgsrc
                    735:        packages from source, either for installing them directly or for
                    736:        building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
                    737:        documentation.</p>
                    738: </dd>
                    739: <dt><span class="term">package maintainers</span></dt>
                    740: <dd><p>A
                    741:        package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
                    742: <dt><span class="term">infrastructure developers</span></dt>
                    743: <dd><p>These people are involved in all those files
1.76      rillig    744:        that live in the <code class="filename">mk/</code> directory and below.
1.75      rillig    745:        Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
                    746:        too.</p></dd>
                    747: </dl></div>
                    748: </div>
                    749: </div>
                    750: <div class="sect1" lang="en">
                    751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    752: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    753: <p>When giving examples for commands, shell prompts are used to
                    754:       show if the command should/can be issued as root, or if
                    755:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    756:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    757:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    758: </div>
                    759: </div>
                    760: <div class="part" lang="en">
                    761: <div class="titlepage"><div><div><h1 class="title">
                    762: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    763: <div class="toc">
                    764: <p><b>Table of Contents</b></p>
                    765: <dl>
                    766: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    767: <dd><dl>
                    768: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    769: <dd><dl>
                    770: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    771: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    772: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    773: </dl></dd>
                    774: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    775: <dd><dl>
                    776: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    777: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    778: </dl></dd>
                    779: </dl></dd>
                    780: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    781: <dd><dl>
1.82      rillig    782: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    783: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    784: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    785: <dd><dl>
                    786: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    787: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    788: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    789: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    790: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    791: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    792: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    793: </dl></dd>
                    794: </dl></dd>
                    795: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    796: <dd><dl>
                    797: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    798: <dd><dl>
                    799: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    800: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    801: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    802: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    803: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    804: <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>
                    805: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    806: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    807: </dl></dd>
                    808: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    811: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    812: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    813: </dl></dd>
                    814: </dl></dd>
                    815: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    816: <dd><dl>
                    817: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    818: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103   ! wiz       819: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
        !           820: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       821: <dd><dl>
1.103   ! wiz       822: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
        !           823: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !           824: <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       825: </dl></dd>
1.103   ! wiz       826: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
        !           827: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    828: </dl></dd>
                    829: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    830: <dd><dl>
                    831: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    832: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                    833: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                    834: <dd><dl>
                    835: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                    836: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                    837: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                    838: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                    839: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                    840: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    841: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                    842: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                    843: </dl></dd>
                    844: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    845: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                    846: </dl></dd>
1.90      rillig    847: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
                    848: <dd><dl>
1.91      rillig    849: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig    850: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    851: </dl></dd>
                    852: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75      rillig    853: <dd><dl>
1.90      rillig    854: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    855: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                    856: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                    857: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                    858: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103   ! wiz       859: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
        !           860: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
        !           861: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
        !           862: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
        !           863: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig    864: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.103   ! wiz       865: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
        !           866: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
        !           867: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
        !           868: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
        !           869: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !           870: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build.  What shall I do?</a></span></dt>
        !           871: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig    872: </dl></dd>
                    873: </dl>
                    874: </div>
                    875: <div class="chapter" lang="en">
                    876: <div class="titlepage"><div><div><h2 class="title">
                    877: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    878: <div class="toc">
                    879: <p><b>Table of Contents</b></p>
                    880: <dl>
                    881: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    882: <dd><dl>
                    883: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    884: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    885: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    886: </dl></dd>
                    887: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    888: <dd><dl>
                    889: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    890: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    891: </dl></dd>
                    892: </dl>
                    893: </div>
1.91      rillig    894: <p>Before you download and extract the files, you need to decide
                    895: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    896: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    897: free to install the sources and binary packages wherever you want in
                    898: your filesystem, provided that the pathname does not contain white-space
                    899: or other characters that are interpreted specially by the shell and some
                    900: other programs. A safe bet is to use only letters, digits, underscores
                    901: and dashes.</p>
1.75      rillig    902: <div class="sect1" lang="en">
                    903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    904: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    905: <p>Before you download any pkgsrc files, you should decide
                    906:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    907:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    908:        quarterly basis from the current branch and only gets modified
                    909:        for security updates. The names of the stable branches are built
                    910:        from the year and the quarter, for example
1.98      wiz       911:        <code class="literal">2007Q1</code>.</p>
1.75      rillig    912: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    913:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    914:        or via CVS. All three ways are described here.</p>
                    915: <div class="sect2" lang="en">
                    916: <div class="titlepage"><div><div><h3 class="title">
                    917: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    918: <p>The primary download location for all pkgsrc files is
                    919:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
                    920:        number of subdirectories for different purposes, which are
1.76      rillig    921:        described in detail in <a href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75      rillig    922: <p>The tar file for the current branch is in the directory
1.76      rillig    923:        <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    924:        It is autogenerated daily.</p>
1.98      wiz       925: <p>The tar file for the stable branch 2007Q1 is in the
                    926:        directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
1.75      rillig    927: <p>After downloading the tar file, change to the directory
                    928:        where you want to have pkgsrc. This is usually
1.91      rillig    929:        <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
                    930:        pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75      rillig    931: </div>
                    932: <div class="sect2" lang="en">
                    933: <div class="titlepage"><div><div><h3 class="title">
                    934: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    935: <p>As an alternative to the tar file, you can get pkgsrc via
                    936:        the Software Update Protocol, SUP. To do so, make sure your
                    937:        supfile has a line
1.1       grant     938: 
1.75      rillig    939: </p>
                    940: <pre class="programlisting">
1.100     rillig    941: release=pkgsrc
1.1       grant     942: </pre>
1.75      rillig    943: <p>
1.1       grant     944: 
1.75      rillig    945:        in it, see the examples in
1.76      rillig    946:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    947:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75      rillig    948:        run <span><strong class="command">sup -v
                    949:        <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
                    950: </div>
                    951: <div class="sect2" lang="en">
                    952: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    953: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75      rillig    954: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
                    955:        installed. To do an initial (full) checkout of pkgsrc, you first
                    956:        have to set some environment variables. For the C-Shell,
                    957:        type:</p>
                    958: <pre class="screen">
                    959:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    960:     <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
                    961: </pre>
                    962: <p>Or, the same for the bourne shell:</p>
                    963: <pre class="screen">
                    964:     <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    965:     <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
                    966:     <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
                    967: </pre>
1.101     rillig    968: <p>By default, cvs doesn't do things like most people would
                    969:        expect it to do, and this is unlikely to change. But there is a
                    970:        way to convince cvs, by creating a file called
                    971:        <code class="filename">.cvsrc</code> in your home directory and saving
                    972:        the following lines to it. This file will save you lots of
                    973:        headache and some bug reports, so we strongly recommend it. You
                    974:        can find an explanation of this file in the CVS
                    975:        documentation.</p>
                    976: <pre class="programlisting">
                    977: # recommended CVS configuration file from the pkgsrc guide
                    978: checkout -P
1.103   ! wiz       979: update -dP
1.101     rillig    980: release -d
1.103   ! wiz       981: diff -upN
1.101     rillig    982: cvs -q -z3
                    983: rdiff -u
                    984: </pre>
1.75      rillig    985: <p>Then, you change to the directory where you want to have
                    986:        your copy of pkgsrc. In most cases this is
1.76      rillig    987:        <code class="filename">/usr</code>. In that directory you run the
1.75      rillig    988:        checkout command, which is <span><strong class="command">cvs -q checkout -P
                    989:        pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.98      wiz       990:        checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1.75      rillig    991:        branch. This command will create a directory called
1.76      rillig    992:        <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75      rillig    993:        it.</p>
                    994: </div>
                    995: </div>
                    996: <div class="sect1" lang="en">
                    997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    998: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                    999: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1000:        (which also works if you have first installed it via a tar
                   1001:        file). It saves bandwidth and hard disk activity, compared to
                   1002:        downloading the tar file again.</p>
                   1003: <div class="sect2" lang="en">
                   1004: <div class="titlepage"><div><div><h3 class="title">
                   1005: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1006: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1007: <h3 class="title">Warning</h3>
1.77      rillig   1008: <p>When updating from a tar file, you first need to
                   1009:        completely remove the old pkgsrc directory. Otherwise those
                   1010:        files that have been removed from pkgsrc in the mean time will
                   1011:        not be removed on your local disk, resulting in inconsistencies.
                   1012:        When removing the old files, any changes that you have done to
                   1013:        the pkgsrc files will be lost after updating. Therefore updating
                   1014:        via CVS is strongly recommended.</p>
1.75      rillig   1015: </div>
1.82      rillig   1016: <p>Note that by default the distfiles and the binary packages
                   1017:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1018:        before updating. You can also configure pkgsrc to use other than
                   1019:        the default directories by setting the
                   1020:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
                   1021:        variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1022: <p>To update pkgsrc from a tar file, download the tar file as
                   1023:        explained above. Then, make sure that you have not made any
                   1024:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1025:        directory and extract the new tar file. Done.</p>
                   1026: </div>
                   1027: <div class="sect2" lang="en">
                   1028: <div class="titlepage"><div><div><h3 class="title">
                   1029: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1030: <p>To update pkgsrc via CVS, make sure the environment
                   1031:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
                   1032:        change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77      rillig   1033:        -dP</strong></span>.</p>
1.75      rillig   1034: <div class="sect3" lang="en">
                   1035: <div class="titlepage"><div><div><h4 class="title">
                   1036: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1037: <p>When updating pkgsrc, the CVS program keeps track of the
                   1038:        branch you selected. But if you, for whatever reason, want to
                   1039:        switch from the stable branch to the current one, you can do it
                   1040:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1041:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1042:        back to the stable branch, add the
1.98      wiz      1043:        &#8220;<span class="quote">-rpkgsrc-2007Q1</span>&#8221; option.</p>
1.75      rillig   1044: </div>
                   1045: <div class="sect3" lang="en">
                   1046: <div class="titlepage"><div><div><h4 class="title">
                   1047: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1048: <p>When you update pkgsrc, the CVS program will only touch
                   1049:        those files that are registered in the CVS repository. That
                   1050:        means that any packages that you created on your own will stay
                   1051:        unmodified. If you change files that are managed by CVS, later
                   1052:        updates will try to merge your changes with those that have been
                   1053:        done by others. See the CVS manual, chapter
                   1054:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1055: </div>
                   1056: </div>
                   1057: </div>
                   1058: </div>
                   1059: <div class="chapter" lang="en">
                   1060: <div class="titlepage"><div><div><h2 class="title">
                   1061: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1062: <div class="toc">
                   1063: <p><b>Table of Contents</b></p>
                   1064: <dl>
1.82      rillig   1065: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1066: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1067: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1068: <dd><dl>
                   1069: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1070: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1071: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1072: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1073: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1074: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1075: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1076: </dl></dd>
                   1077: </dl>
                   1078: </div>
                   1079: <div class="sect1" lang="en">
                   1080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1081: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
                   1082: <p>
                   1083: We provide a bootstrap kit in both source and binary form for other
                   1084: platforms than NetBSD, consisting of the pkg administration tools and other
                   1085: tools required to use pkgsrc and build packages.
                   1086: </p>
                   1087: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1088: <h3 class="title">Note</h3>
                   1089: <p>
                   1090: Older binary snapshots are available in the
                   1091: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
                   1092: directory on ftp.NetBSD.org.</p>
                   1093: </div>
                   1094: <div class="table">
                   1095: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91      rillig   1096: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82      rillig   1097: <colgroup>
                   1098: <col>
                   1099: <col>
                   1100: <col>
                   1101: <col>
                   1102: </colgroup>
                   1103: <thead><tr>
                   1104: <th>Platform</th>
                   1105: <th>Latest snapshot</th>
                   1106: <th>Binary kit</th>
                   1107: <th>Binary packages</th>
                   1108: </tr></thead>
                   1109: <tbody>
                   1110: <tr>
                   1111: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
                   1112: <td class="date">20021209</td>
                   1113: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
                   1114: <td class="binary-pkgs-url"> </td>
                   1115: </tr>
                   1116: <tr>
                   1117: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
                   1118: <td class="date">20030623</td>
                   1119: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
                   1120: <td class="binary-pkgs-url"> </td>
                   1121: </tr>
                   1122: <tr>
                   1123: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
                   1124: <td class="date">20041219</td>
                   1125: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
                   1126: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
                   1127: </tr>
                   1128: <tr>
                   1129: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
                   1130: <td class="date">20050320</td>
                   1131: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
                   1132: <td class="binary-pkgs-url"> </td>
                   1133: </tr>
                   1134: <tr>
                   1135: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
                   1136: <td class="date">20050625</td>
                   1137: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
                   1138: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
                   1139: </tr>
                   1140: <tr>
                   1141: <td class="osname">Debian GNU Linux/i386</td>
                   1142: <td class="date">20031023</td>
                   1143: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
                   1144: <td class="binary-pkgs-url"> </td>
                   1145: </tr>
                   1146: <tr>
                   1147: <td class="osname">Fedora Core 2 Linux/i386</td>
                   1148: <td class="date">20050618</td>
                   1149: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
                   1150: <td class="binary-pkgs-url"> </td>
                   1151: </tr>
                   1152: <tr>
                   1153: <td class="osname">Fedora Core 4 Linux/i386</td>
                   1154: <td class="date">20060105</td>
                   1155: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
                   1156: <td class="binary-pkgs-url"> </td>
                   1157: </tr>
                   1158: <tr>
                   1159: <td class="osname">FreeBSD 3.5/i386</td>
                   1160: <td class="date">20030411</td>
                   1161: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1162: <td class="binary-pkgs-url"> </td>
                   1163: </tr>
                   1164: <tr>
                   1165: <td class="osname">FreeBSD 4.7/i386</td>
                   1166: <td class="date">20021211</td>
                   1167: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
                   1168: <td class="binary-pkgs-url"> </td>
                   1169: </tr>
                   1170: <tr>
                   1171: <td class="osname">FreeBSD 5.0/i386</td>
                   1172: <td class="date">20030411</td>
                   1173: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1174: <td class="binary-pkgs-url"> </td>
                   1175: </tr>
                   1176: <tr>
                   1177: <td class="osname">FreeBSD 5.1/i386</td>
                   1178: <td class="date">20030630</td>
                   1179: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
                   1180: <td class="binary-pkgs-url"> </td>
                   1181: </tr>
                   1182: <tr>
                   1183: <td class="osname">FreeBSD 5.2.1/i386</td>
                   1184: <td class="date">20040227</td>
                   1185: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
                   1186: <td class="binary-pkgs-url"> </td>
                   1187: </tr>
                   1188: <tr>
                   1189: <td class="osname">FreeBSD 5.3/i386</td>
                   1190: <td class="date">20050119</td>
                   1191: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
                   1192: <td class="binary-pkgs-url"> </td>
                   1193: </tr>
                   1194: <tr>
1.98      wiz      1195: <td class="osname">HP-UX 11.11/hppa</td>
                   1196: <td class="date">20070421</td>
                   1197: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
                   1198: <td class="binary-pkgs-url"> </td>
                   1199: </tr>
                   1200: <tr>
1.82      rillig   1201: <td class="osname">Interix 3.5</td>
1.93      rillig   1202: <td class="date">20061106</td>
                   1203: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
                   1204: <td class="binary-pkgs-url"> </td>
1.82      rillig   1205: </tr>
                   1206: <tr>
                   1207: <td class="osname">IRIX 6.5 n32-bit ABI</td>
                   1208: <td class="date">20040911</td>
                   1209: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
                   1210: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
                   1211: </tr>
                   1212: <tr>
                   1213: <td class="osname">IRIX 6.5 64-bit ABI</td>
                   1214: <td class="date">20040912</td>
                   1215: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
                   1216: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
                   1217: </tr>
                   1218: <tr>
                   1219: <td class="osname">OpenBSD 3.2/i386</td>
                   1220: <td class="date">20030420</td>
                   1221: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
                   1222: <td class="binary-pkgs-url"> </td>
                   1223: </tr>
                   1224: <tr>
                   1225: <td class="osname">OpenBSD 3.3/i386</td>
                   1226: <td class="date">20030503</td>
                   1227: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
                   1228: <td class="binary-pkgs-url"> </td>
                   1229: </tr>
                   1230: <tr>
                   1231: <td class="osname">OpenBSD 3.5/i386</td>
1.93      rillig   1232: <td class="date">20040703</td>
1.82      rillig   1233: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
                   1234: <td class="binary-pkgs-url"> </td>
                   1235: </tr>
                   1236: <tr>
1.98      wiz      1237: <td class="osname">OSF1 5.1/alpha</td>
                   1238: <td class="date">20070420</td>
                   1239: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
                   1240: <td class="binary-pkgs-url"> </td>
                   1241: </tr>
                   1242: <tr>
1.82      rillig   1243: <td class="osname">Slackware Linux 8.1/i386</td>
                   1244: <td class="date">20030417</td>
                   1245: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
                   1246: <td class="binary-pkgs-url"> </td>
                   1247: </tr>
                   1248: <tr>
                   1249: <td class="osname">Slackware Linux 9/i386</td>
1.93      rillig   1250: <td class="date">20040703</td>
1.82      rillig   1251: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
                   1252: <td class="binary-pkgs-url"> </td>
                   1253: </tr>
                   1254: <tr>
                   1255: <td class="osname">Solaris 8/sparc</td>
                   1256: <td class="date">20050220</td>
                   1257: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
                   1258: <td class="binary-pkgs-url"> </td>
                   1259: </tr>
                   1260: <tr>
                   1261: <td class="osname">Solaris 8/i386</td>
                   1262: <td class="date">20050220</td>
                   1263: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
                   1264: <td class="binary-pkgs-url"> </td>
                   1265: </tr>
                   1266: <tr>
                   1267: <td class="osname">Solaris 9/sparc</td>
1.93      rillig   1268: <td class="date">20060713</td>
                   1269: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
                   1270: <td class="binary-pkgs-url"> </td>
1.82      rillig   1271: </tr>
                   1272: <tr>
                   1273: <td class="osname">Solaris 9/i386</td>
                   1274: <td class="date">20030411</td>
                   1275: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
                   1276: <td class="binary-pkgs-url"> </td>
                   1277: </tr>
                   1278: </tbody>
1.91      rillig   1279: </table></div>
1.82      rillig   1280: </div>
1.91      rillig   1281: <br class="table-break"><p>
1.82      rillig   1282: Simply download the binary kit for your platform, and extract it into
                   1283: <code class="filename">/</code> e.g.
                   1284: </p>
                   1285: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   1286: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
                   1287:   | tar -xpf -</code></strong></pre>
                   1288: <p>
                   1289: Of course, as with any binary distributions, you should verify the
                   1290: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
                   1291: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
                   1292: file and inspect the contents before extracting it.
                   1293: </p>
                   1294: </div>
                   1295: <div class="sect1" lang="en">
                   1296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1297: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1298: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1299: <pre class="screen">
                   1300: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1301: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1302: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1303:     </pre>
1.75      rillig   1304: <p>See <a href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87      wiz      1305:     pkgsrc before bootstrapping. The given
                   1306:     <span><strong class="command">bootstrap</strong></span> command will use the defaults of
                   1307:     <code class="filename">/usr/pkg</code> for the
                   1308:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1309:     and <code class="filename">/var/db/pkg</code> for the package database
                   1310:     directory where pkgsrc will do its internal bookkeeping.
                   1311:     However, these can also be set using command-line
                   1312:     arguments.</p>
1.75      rillig   1313: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87      wiz      1314:     available for supported platforms. An up-to-date list of these can be
                   1315:     found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
                   1316:     Note that this only works for privileged builds that install
                   1317:     into <code class="filename">/usr/pkg</code>.</p>
1.75      rillig   1318: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1319: <h3 class="title">Note</h3>
                   1320: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87      wiz      1321:       Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
                   1322:       For examples in this guide, use <span><strong class="command">bmake</strong></span>
                   1323:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1324: </div>
                   1325: </div>
                   1326: <div class="sect1" lang="en">
                   1327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1328: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1329: <p>Here are some platform-specific notes you should be aware of.</p>
                   1330: <div class="sect2" lang="en">
                   1331: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1332: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1333: <p>Darwin 5.x and up are supported. There are two methods of using
1.82      rillig   1334:        pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1.89      rillig   1335:          image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1336:          partition</a>.</p>
                   1337: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87      wiz      1338:       Tools from Apple's Developer Connection.  See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1339:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
                   1340:       from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
                   1341:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1342: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1343:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1344:       the disk image. It'll be somewhat faster and will mount automatically
                   1345:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1346: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1347: <h3 class="title">Note</h3>
1.85      jmmv     1348: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1349:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75      rillig   1350: </div>
                   1351: <div class="sect3" lang="en">
                   1352: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1353: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1354: <p>Create the disk image:</p>
                   1355: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1356: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1357: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1358: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1359: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1360: <h3 class="title">Note</h3>
1.89      rillig   1361: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journalling.</p>
1.85      jmmv     1362: </div>
1.89      rillig   1363: <p>Allow suid:</p>
                   1364: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.75      rillig   1365: </div>
                   1366: <div class="sect3" lang="en">
                   1367: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1368: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1369: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1370:        system, normally HFS+. It is possible to use the default
                   1371:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1372:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1373:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1374:        place the package database directory outside the
                   1375:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1376: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1377: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1378:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1379:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1380:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1381:        to ensure that the partition map correctly reflects
1.89      rillig   1382:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
1.75      rillig   1383: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1384:        disk that is booted from. You can unmount the partition, but even if
                   1385:        you newfs it, the partition type will be incorrect and the
                   1386:        automounter won't mount it. It can be mounted manually, but it won't
                   1387:        appear in Finder.</p>
1.75      rillig   1388: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1389:        the Installation program starts, go up to the menu and select Disk
                   1390:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1391:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1392:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1393:        will appear in Finder.</p>
1.75      rillig   1394: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1395:        by root only.</p>
1.75      rillig   1396: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1397:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1398: </div>
                   1399: </div>
                   1400: <div class="sect2" lang="en">
                   1401: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1402: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1403: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1404:       other versions may work.</p>
1.75      rillig   1405: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1406:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1407: <div class="orderedlist"><ol type="1">
                   1408: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1409:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1410:          recommended that you choose a different location (e.g.
                   1411:          <code class="filename">/usr/pkgdb</code>) by
                   1412:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1413: <li>
                   1414: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1415:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1416: <pre class="screen">
                   1417: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1418: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1419: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1420: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1421: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1422:          </pre>
1.75      rillig   1423: </li>
1.76      rillig   1424: <li><p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1425:          <code class="filename">/etc/mk.conf.example</code> file
                   1426:          when you use the bootstrap script.</p></li>
1.75      rillig   1427: </ol></div>
                   1428: </div>
                   1429: <div class="sect2" lang="en">
                   1430: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1431: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1432: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1433:       providing a Unix-like environment with a tighter kernel integration than
                   1434:       available with Cygwin.  It is part of the Windows Services for Unix
                   1435:       package, available for free for any licensed copy of Windows 2000, XP
                   1436:       (not including XP Home), or 2003.  SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1437: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1438:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1439:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1440: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1441:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1442:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1443: <div class="sect3" lang="en">
                   1444: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1445: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1446: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1447:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1448: <div class="itemizedlist"><ul type="disc">
                   1449: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1450: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1451: <li><p>Remote Connectivity</p></li>
                   1452: <li><p>Interix SDK</p></li>
                   1453: </ul></div>
                   1454: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1455:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1456:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1457:        pkgsrc (or from a binary package).</p>
1.75      rillig   1458: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1459:        not need to be installed, but Remote Connectivity itself should be
                   1460:        installed in order to have a working inetd.</p>
1.75      rillig   1461: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1462:        behavior for Interix programs, and whether to make pathnames default to
                   1463:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1464:        enabled.  (Without case-sensitivity, a large number of packages including
                   1465:        perl will not build.)</p>
1.75      rillig   1466: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1467:        works (via the Data Execution Prevention feature).  In order to use
                   1468:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1469:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1470:        must be installed.  Hotfixes are available from Microsoft through a
                   1471:        support contract; however, a NetBSD developer has made most Interix
                   1472:        hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93      rillig   1473: <p>In addition to the hotfix noted above, it may be necessary to
                   1474:        disable Data Execution Prevention entirely to make Interix functional.
                   1475:        This may happen only with certain types of CPUs; the cause is not fully
                   1476:        understood at this time.  If gcc or other applications still segfault
                   1477:        repeatedly after installing one of the hotfixes note above, the
                   1478:        following option can be added to the appropriate "boot.ini" line on the
                   1479:        Windows boot drive:  /NoExecute=AlwaysOff
                   1480:        (WARNING, this will disable DEP completely, which may be a security
                   1481:        risk if applications are often run as a user in the Administrators
                   1482:        group!)</p>
1.75      rillig   1483: </div>
                   1484: <div class="sect3" lang="en">
                   1485: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1486: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1487: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1488:        with pkgsrc, note the following things.</p>
1.75      rillig   1489: <div class="itemizedlist"><ul type="disc">
                   1490: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1491:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1492:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1493: <li>
                   1494: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1495:            change the following registry key:</p>
1.75      rillig   1496: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1497: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1498: </li>
                   1499: <li>
                   1500: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1501:            following registry key:</p>
1.75      rillig   1502: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1503: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1504: </li>
                   1505: </ul></div>
                   1506: </div>
                   1507: <div class="sect3" lang="en">
                   1508: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1509: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1510: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1511:        running "pkg_add") must be a member of the local Administrators
                   1512:        group.  Such a user must also be used to run the bootstrap.  This is
                   1513:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1514: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1515:        automatically complain if this is not the case.  This ensures that
                   1516:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1517: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1518:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1519:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1520:        the same time as the pkgsrc packages, ensure that you use the proper
                   1521:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1522: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1523:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1524:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1525:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1526: <pre class="programlisting">
1.100     rillig   1527: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1528:        </pre>
1.75      rillig   1529: </div>
                   1530: <div class="sect3" lang="en">
                   1531: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1532: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1533: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1534:        for a full Unix-like platform, it has some drawbacks that should
                   1535:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1536: <div class="itemizedlist"><ul type="disc">
                   1537: <li>
                   1538: <p><span class="strong"><strong>X11:</strong></span></p>
                   1539: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1540:          and can run X11 based applications, but it does
                   1541:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
                   1542:          <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1543:          <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
                   1544:          (available in a trimmed version for Interix from Interop Systems as the
                   1545:          <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
                   1546:          and the free X11 server included with
                   1547:          <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1548: </li>
                   1549: <li>
                   1550: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1551: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1552:          Win32 applications, it does not currently support various X11
                   1553:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1554:          Most interactive applications to a local X server will run
                   1555:          reasonably fast, but full motion video and other graphics
                   1556:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1557: </li>
                   1558: <li>
                   1559: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1560: <p>Interix has no native support for audio output.  For audio
1.87      wiz      1561:          support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
                   1562:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1563:          <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.87      wiz      1564:          <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
                   1565:          server component.  To output audio via an Interix host, the
1.91      rillig   1566:          <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      1567:          must also be installed.</p>
1.75      rillig   1568: </li>
                   1569: <li>
                   1570: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1571: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1572:          is not currently possible to access CD/DVD drives, USB devices,
                   1573:          or SCSI devices through non-filesystem means.  Among other things,
                   1574:          this makes it impossible to use Interix directly for CD/DVD
                   1575:          burning.</p>
1.75      rillig   1576: </li>
                   1577: <li>
                   1578: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1579: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1580:          drives are also not directly accessible in Interix.  However,
                   1581:          support is in work to make tape drive access possible by using
                   1582:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1583:          esound server).</p>
1.75      rillig   1584: </li>
                   1585: </ul></div>
                   1586: </div>
                   1587: <div class="sect3" lang="en">
                   1588: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1589: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1590: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1591:        Windows system; any member of the local Administrators group will
                   1592:        suffice.  However, some packages currently assume that the user
                   1593:        named "root" is the privileged user.  To accommodate these, you
                   1594:        may create such a user; make sure it is in the local group
                   1595:        Administrators (or your language equivalent).</p>
                   1596: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
                   1597:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1598:        time being, install packages as the local Administrator (or
                   1599:        your language equivalent), or run the following command after
                   1600:        installing a package to work around the issue:</p>
1.75      rillig   1601: <pre class="screen">
1.87      wiz      1602: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1603:        </pre>
1.75      rillig   1604: </div>
                   1605: </div>
                   1606: <div class="sect2" lang="en">
                   1607: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1608: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1609: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1610:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1611:       according to your preference.  If you do not have a license for the MIPSpro
                   1612:       compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1613: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87      wiz      1614:       version of IRIX providing support for <a href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
                   1615:       etc.</p>
1.86      schwarz  1616: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1617:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1618:        you start out using "abi=n32", that's what all your packages will be built
                   1619:        with.</p>
                   1620: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1621:       <code class="varname">CFLAGS</code> in your environment or the
                   1622:       <code class="filename">/etc/mk.conf</code>.  Particularly, make sure that you do not
                   1623:       try to link n32 object files with lib64 or vice versa.  Check your
                   1624:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1625: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1626:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1627:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1628:       link over a network-mounted file system.</p>
1.75      rillig   1629: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1630:       as imake(1), but you may want to set some options depending on your local
                   1631:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1632:       course, your compiler's man pages for details.</p>
1.75      rillig   1633: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1634: 
1.87      wiz      1635:       </p>
1.75      rillig   1636: <pre class="programlisting">
1.100     rillig   1637: PKGSRC_COMPILER=        mipspro
1.87      wiz      1638:       </pre>
1.75      rillig   1639: <p>
1.1       grant    1640: 
1.87      wiz      1641:       in <code class="filename">/etc/mk.conf</code>.  Otherwise, pkgsrc will assume you
                   1642:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1643:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1644:       default.</p>
1.75      rillig   1645: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1646:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1647:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1648:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1649:       '--preserve-path' flag.</p>
1.75      rillig   1650: </div>
                   1651: <div class="sect2" lang="en">
                   1652: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1653: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1654: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1655:       either libtermcap or libcurses (libncurses).  Installing the
                   1656:       distributions libncurses-dev package (or equivalent) should fix
                   1657:       the problem.</p>
                   1658: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1659:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1660:       i386 have been tested.</p>
1.75      rillig   1661: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1662:       directory:</p>
1.75      rillig   1663: <pre class="programlisting">
1.100     rillig   1664: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1665: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1666:       </pre>
1.75      rillig   1667: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1668: <h3 class="title">Note</h3>
                   1669: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1670: </div>
                   1671: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1672:       function, which icc does not support. #undef'ing __attribute__ has the
                   1673:       unfortunate side-effect of breaking many of the Linux header files, which
                   1674:       cannot be compiled properly without __attribute__. The test must be
                   1675:       overridden so that __attribute__ is assumed supported by the
                   1676:       compiler.</p>
1.75      rillig   1677: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.87      wiz      1678:       in <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1679: <pre class="programlisting">
1.100     rillig   1680: PKGSRC_COMPILER=        icc
1.87      wiz      1681:       </pre>
1.75      rillig   1682: <p>The default installation directory for icc is
1.87      wiz      1683:       <code class="filename">/opt/intel_cc_80</code>, which
                   1684:       is also the pkgsrc default. If you have installed it into a different
                   1685:       directory, set <code class="varname">ICCBASE</code> in
                   1686:       <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   1687: <pre class="programlisting">
1.100     rillig   1688: ICCBASE=                /opt/icc
1.87      wiz      1689:       </pre>
1.75      rillig   1690: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1691:       provided by icc, so binaries can be run on other systems which do not
                   1692:       have the shared libraries installed.</p>
                   1693: <p>Libtool, however, extracts a list of libraries from the
                   1694:       <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
                   1695:       records it, throwing away the -Bstatic and -Bdynamic options
                   1696:       interspersed between the libraries.  This means that
                   1697:       libtool-linked C++ shared libraries will have a runtime
                   1698:       dependency on the icc libraries until this is fixed in
                   1699:       libtool.</p>
1.75      rillig   1700: </div>
                   1701: <div class="sect2" lang="en">
                   1702: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1703: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1704: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1705: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1706:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1707: <div class="orderedlist"><ol type="1">
                   1708: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1709:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1710:          recommended that you choose a different location (e.g.
                   1711:          <code class="filename">/usr/pkgdb</code>) by
                   1712:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1713: <li>
                   1714: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1715:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1716: <pre class="screen">
                   1717: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1718: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1719: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1720: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1721: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1722:          </pre>
1.75      rillig   1723: </li>
                   1724: <li>
1.76      rillig   1725: <p>An example <code class="filename">/etc/mk.conf</code> file will be placed in
1.87      wiz      1726:          <code class="filename">/etc/mk.conf.example</code> file
                   1727:          when you use the bootstrap script. OpenBSD's make program uses
                   1728:          <code class="filename">/etc/mk.conf</code>
                   1729:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1730:          of the file with:</p>
                   1731: <pre class="programlisting">
1.100     rillig   1732: .ifdef BSD_PKG_MK
                   1733: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1734: .else
                   1735: # OpenBSD stuff
                   1736: .endif
1.87      wiz      1737:          </pre>
1.75      rillig   1738: </li>
                   1739: </ol></div>
                   1740: </div>
                   1741: <div class="sect2" lang="en">
                   1742: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1743: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1744: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1745:       You will need a working C compiler. Both gcc 2.95.3 and
                   1746:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1747: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1748:       process and to build packages.</p>
1.75      rillig   1749: <div class="itemizedlist"><ul type="disc">
                   1750: <li><p>SUNWsprot</p></li>
                   1751: <li><p>SUNWarc</p></li>
                   1752: <li><p>SUNWbtool</p></li>
                   1753: <li><p>SUNWtoo</p></li>
                   1754: <li><p>SUNWlibm</p></li>
                   1755: </ul></div>
1.78      rillig   1756: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1757:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1758: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1759:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1760:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1761:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1762: <div class="sect3" lang="en">
                   1763: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1764: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1765: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1766:        for building all packages.</p>
1.75      rillig   1767: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1768:        then either build gcc from
1.91      rillig   1769:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87      wiz      1770:        package, then remove gcc used during bootstrapping.</p>
1.93      rillig   1771: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1772: </div>
                   1773: <div class="sect3" lang="en">
                   1774: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1775: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1776: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1777:        5.0)</p>
1.75      rillig   1778: <div class="itemizedlist"><ul type="disc">
                   1779: <li><p>SPROcc
1.87      wiz      1780:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1781: <li><p>SPROcpl
1.87      wiz      1782:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1783: <li><p>SPROild
1.87      wiz      1784:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1785: <li><p>SPROlang
1.87      wiz      1786:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1787: </ul></div>
1.96      rillig   1788: <p>You should set the following variables in your
                   1789:        <code class="filename">mk.conf</code> file:</p>
                   1790: <pre class="programlisting">
1.100     rillig   1791: CC=     cc
                   1792: CXX=    CC
                   1793: CPP=    cc -E
                   1794: CXXCPP= CC -E
1.96      rillig   1795: </pre>
                   1796: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1797: <h3 class="title">Note</h3>
                   1798: <p>The <code class="varname">CPP</code> setting might break some
                   1799:        packages that use the C preprocessor for processing things other
                   1800:        than C source code.</p>
                   1801: </div>
1.75      rillig   1802: </div>
                   1803: <div class="sect3" lang="en">
                   1804: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1805: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1806: <p>To build 64-bit packages, you just need to have the
                   1807:        following lines in your <code class="filename">mk.conf</code>
1.75      rillig   1808:        file:</p>
                   1809: <pre class="programlisting">
1.100     rillig   1810: PKGSRC_COMPILER=        sunpro
                   1811: ABI=                    64
1.96      rillig   1812: </pre>
                   1813: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1814: <h3 class="title">Note</h3>
                   1815: <p>This setting has been tested for the SPARC
                   1816:        architecture. Intel and AMD machines need some more
                   1817:        work.</p>
                   1818: </div>
1.75      rillig   1819: </div>
                   1820: <div class="sect3" lang="en">
                   1821: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1822: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75      rillig   1823: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87      wiz      1824:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1825:       The workaround is to use another shell for the configure
1.91      rillig   1826:       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.87      wiz      1827:       to your <code class="filename">mk.conf</code>:</p>
                   1828: <pre class="programlisting">
1.100     rillig   1829: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1830: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1831:       </pre>
1.91      rillig   1832: <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   1833: </div>
                   1834: </div>
                   1835: </div>
                   1836: </div>
                   1837: <div class="chapter" lang="en">
                   1838: <div class="titlepage"><div><div><h2 class="title">
                   1839: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1840: <div class="toc">
                   1841: <p><b>Table of Contents</b></p>
                   1842: <dl>
                   1843: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1844: <dd><dl>
                   1845: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1846: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1847: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1848: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1849: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1850: <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>
                   1851: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1852: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1853: </dl></dd>
                   1854: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1855: <dd><dl>
                   1856: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1857: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1858: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1859: </dl></dd>
                   1860: </dl>
                   1861: </div>
                   1862: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1863: is to only install the package tools and to use binary packages
                   1864: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1865: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1866: of pkgsrc, too. Then you are able to build your own packages,
                   1867: and you can still use binary packages from someone else.</p>
1.75      rillig   1868: <div class="sect1" lang="en">
                   1869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1870: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
                   1871: <p>To use binary packages, you need some tools to manage
1.88      wiz      1872:   them. On NetBSD, these tools are already installed. On all other
                   1873:   operating systems, you need to install them first. For the
                   1874:   following platforms, prebuilt versions of the package tools
                   1875:   are available and can simply be downloaded and unpacked in the
                   1876:   <code class="filename">/</code> directory:</p>
1.75      rillig   1877: <div class="informaltable">
                   1878: <a name="binary-bootstrap-kits"></a><table border="1">
                   1879: <colgroup>
                   1880: <col>
                   1881: <col>
                   1882: </colgroup>
                   1883: <thead><tr>
                   1884: <th>Platform</th>
                   1885: <th>URL</th>
                   1886: </tr></thead>
                   1887: <tbody>
                   1888: <tr>
                   1889: <td>Solaris 9</td>
1.76      rillig   1890: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1891: </tr>
                   1892: <tr>
                   1893: <td>Solaris 10</td>
1.76      rillig   1894: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75      rillig   1895: </tr>
                   1896: </tbody>
                   1897: </table>
                   1898: </div>
1.82      rillig   1899: <p>These pre-built package tools use
1.88      wiz      1900:   <code class="filename">/usr/pkg</code> for the base directory, and
                   1901:   <code class="filename">/var/db/pkg</code> for the database of installed
                   1902:   packages. If you cannot use these directories for whatever
                   1903:   reasons (maybe because you're not root), you have to build the
                   1904:   package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.75      rillig   1905: <div class="sect2" lang="en">
                   1906: <div class="titlepage"><div><div><h3 class="title">
                   1907: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
                   1908: <p>To install binary packages, you first need to know from
1.88      wiz      1909:     where to get them. You can get them on CD-ROMs, DVDs, or via FTP
                   1910:     or HTTP.</p>
1.81      rillig   1911: <p>The binary packages can be found at the following
1.88      wiz      1912:     locations.</p>
1.75      rillig   1913: <div class="informaltable">
                   1914: <a name="binary-packages"></a><table border="1">
                   1915: <colgroup>
                   1916: <col>
                   1917: <col>
                   1918: </colgroup>
                   1919: <thead><tr>
                   1920: <th>Platform</th>
                   1921: <th>URL</th>
                   1922: </tr></thead>
                   1923: <tbody>
                   1924: <tr>
1.81      rillig   1925: <td>NetBSD</td>
                   1926: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
                   1927: </tr>
                   1928: <tr>
1.75      rillig   1929: <td>Solaris 9</td>
1.76      rillig   1930: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75      rillig   1931: </tr>
                   1932: <tr>
                   1933: <td>Solaris 10</td>
1.76      rillig   1934: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75      rillig   1935: </tr>
                   1936: </tbody>
                   1937: </table>
                   1938: </div>
1.81      rillig   1939: <p>Most of these directories contain binary packages for
1.88      wiz      1940:     multiple platforms. Select the appropriate subdirectories,
                   1941:     according to your machine architecture and operating system,
                   1942:     until you find a directory called <code class="filename">All</code>. This
                   1943:     directory contains all the binary packages. Further, there are
                   1944:     subdirectories for categories that contain symbolic links that
                   1945:     point to the actual binary package in
                   1946:     <code class="filename">../All</code>. This directory layout is used for
                   1947:     all package repositories, no matter if they are accessed via
                   1948:     HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75      rillig   1949: </div>
                   1950: <div class="sect2" lang="en">
                   1951: <div class="titlepage"><div><div><h3 class="title">
                   1952: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87      wiz      1953: <p>If you have the files on a CD-ROM or downloaded them to
1.88      wiz      1954:     your hard disk, you can install them with the following command
                   1955:     (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75      rillig   1956: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87      wiz      1957: <p>If you have FTP access and you don't want to download the
1.88      wiz      1958:     packages via FTP prior to installation, you can do this
                   1959:     automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82      rillig   1960: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All/package</code></strong></pre>
1.75      rillig   1961: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1962:     package in question will be installed, too, assuming they are
                   1963:     present where you install from.</p>
1.75      rillig   1964: <p>To save some typing, you can set the
1.88      wiz      1965:     <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
                   1966:     list of paths (including remote URLs); trailing slashes are not allowed.
                   1967:     </p>
1.76      rillig   1968: <p>Additionally to the <code class="filename">All</code> directory
1.88      wiz      1969:     there exists a <code class="filename">vulnerable</code> directory to
                   1970:     which binary packages with known vulnerabilities are
                   1971:     moved, since removing them could cause missing dependencies. To
                   1972:     use these packages, add the <code class="filename">vulnerable</code>
                   1973:     directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91      rillig   1974:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly,
1.88      wiz      1975:     especially after installing new packages, and verify that the
                   1976:     vulnerabilities are acceptable for your configuration. An example
                   1977:     <code class="varname">PKG_PATH</code> would be:
                   1978:     <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/&lt;OSVERSION&gt;/&lt;ARCH&gt;/vulnerable</code>
                   1979:     Please note that semicolon (';') is a shell meta-character, so
                   1980:     you'll probably have to quote it.</p>
1.75      rillig   1981: <p>After you've installed packages, be sure to have
1.88      wiz      1982:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1983:     <code class="varname">PATH</code> so you can actually start the just
                   1984:     installed program.</p>
1.75      rillig   1985: </div>
                   1986: <div class="sect2" lang="en">
                   1987: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1988: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1989: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1990:     installed from source code or from a binary package. The
                   1991:     <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
                   1992:     To delete a package, you can just run <span><strong class="command">pkg_delete
                   1993:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1994:     name can be given with or without version number. Wildcards can
                   1995:     also be used to deinstall a set of packages, for example
                   1996:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1997:     so that the shell does not expand them before
                   1998:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1999: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      2000:     removes all the packages that require the package in question
                   2001:     and then removes the package itself. For example:
1.82      rillig   2002: 
1.88      wiz      2003:     </p>
1.82      rillig   2004: <pre class="screen">
1.88      wiz      2005: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   2006:     </pre>
1.82      rillig   2007: <p>
                   2008: 
1.88      wiz      2009:     will remove jpeg and all the packages that used it; this allows
                   2010:     upgrading the jpeg package.</p>
1.82      rillig   2011: </div>
                   2012: <div class="sect2" lang="en">
                   2013: <div class="titlepage"><div><div><h3 class="title">
                   2014: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
                   2015: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88      wiz      2016:     installed packages or binary package files.</p>
1.82      rillig   2017: </div>
                   2018: <div class="sect2" lang="en">
                   2019: <div class="titlepage"><div><div><h3 class="title">
                   2020: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   2021: <p>
1.88      wiz      2022:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   2023:       known security vulnerabilities to packages which are (or have been)
                   2024:       included in pkgsrc.  The list is available from the NetBSD
                   2025:       FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
                   2026:     </p>
1.82      rillig   2027: <p>
1.93      rillig   2028:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88      wiz      2029:       this list can be downloaded
                   2030:       automatically, and a security audit of all packages installed on a system
                   2031:       can take place.
                   2032:     </p>
1.82      rillig   2033: <p>
1.93      rillig   2034:       There are two components to
1.91      rillig   2035:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
1.88      wiz      2036:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   2037:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   2038:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   2039:       installed packages are vulnerable.  If a package is vulnerable, you
                   2040:       will see output similar to the following:
                   2041:     </p>
1.82      rillig   2042: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      2043:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   2044: <p>
1.91      rillig   2045:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.88      wiz      2046:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
                   2047:       file daily, and include a package audit in the daily security script.
                   2048:       Details on this are located in the <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91      rillig   2049:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88      wiz      2050:     </p>
1.82      rillig   2051: </div>
                   2052: <div class="sect2" lang="en">
                   2053: <div class="titlepage"><div><div><h3 class="title">
                   2054: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   2055: <p>
1.93      rillig   2056:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
1.88      wiz      2057:       <span><strong class="command">lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
                   2058:       argument to check if your packages are up-to-date, e.g.
                   2059:     </p>
                   2060: <pre class="screen">
                   2061: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   2062: ...
1.88      wiz      2063: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   2064:     </pre>
1.82      rillig   2065: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88      wiz      2066:     package on your system and rebuild any dependencies.
                   2067:     </p>
1.82      rillig   2068: </div>
                   2069: <div class="sect2" lang="en">
                   2070: <div class="titlepage"><div><div><h3 class="title">
                   2071: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
                   2072: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88      wiz      2073:     administrative functions on the package system.</p>
1.82      rillig   2074: </div>
                   2075: <div class="sect2" lang="en">
                   2076: <div class="titlepage"><div><div><h3 class="title">
                   2077: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   2078: <p>Please pay very careful attention to the warnings
1.88      wiz      2079:     expressed in the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
                   2080:     inherent dangers of installing binary packages which you did
                   2081:     not create yourself, and the security holes that can be
                   2082:     introduced onto your system by indiscriminate adding of such
                   2083:     files.</p>
1.75      rillig   2084: <p>The same warning of course applies to every package you
1.88      wiz      2085:     install from source when you haven't completely read and
                   2086:     understood the source code of the package, the compiler that
                   2087:     is used to build the package and all the other tools that are
                   2088:     involved.</p>
1.75      rillig   2089: </div>
                   2090: </div>
                   2091: <div class="sect1" lang="en">
                   2092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2093: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      2094: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   2095:   directory now contains a set of packages, organized into
                   2096:   categories. You can browse the online index of packages, or run
                   2097:   <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
                   2098:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   2099:   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      2100: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   2101:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   2102:   should do so by setting <code class="varname">LOCALBASE</code> in
                   2103:   <code class="filename">mk.conf</code>. You should not try to use multiple
                   2104:   different <code class="varname">LOCALBASE</code> definitions on the same
                   2105:   system (inside a chroot is an exception). </p>
                   2106: <p>The rest of this chapter assumes that the package is already
                   2107:   in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
                   2108:   instructions how to create your own packages.</p>
1.75      rillig   2109: <div class="sect2" lang="en">
                   2110: <div class="titlepage"><div><div><h3 class="title">
                   2111: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   2112: <p>To build packages from source, you need a working C
1.88      wiz      2113:     compiler. On NetBSD, you need to install the
                   2114:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   2115:     sets. If you want to build X11-related packages, the
                   2116:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   2117:     sets are required, too.</p>
1.75      rillig   2118: </div>
                   2119: <div class="sect2" lang="en">
                   2120: <div class="titlepage"><div><div><h3 class="title">
                   2121: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   2122: <p>The first step for building a package is downloading the
1.88      wiz      2123:     distfiles (i.e. the unmodified source). If they have not yet been
                   2124:     downloaded, pkgsrc will fetch them automatically.</p>
                   2125: <p>If you have all files that you need in the
                   2126:     <code class="filename">distfiles</code> directory,
                   2127:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   2128:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   2129:     </p>
1.82      rillig   2130: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   2131: <p>
1.88      wiz      2132:     to your <code class="filename">mk.conf</code>.</p>
1.91      rillig   2133: <p>By default a list of distribution sites will be randomly
                   2134:     intermixed to prevent huge load on servers which holding popular
                   2135:     packages (for example, SourceForge.net mirrors). Thus, every
                   2136:     time when you need to fetch yet another distfile all the mirrors
                   2137:     will be tried in new (random) order. You can turn this feature
                   2138:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   2139:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      2140: <p>You can overwrite some of the major distribution sites to
                   2141:     fit to sites that are close to your own.  By setting one or two
                   2142:     variables you can modify the order in which the master sites are
                   2143:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   2144:     delimited list of domain suffixes.
                   2145:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   2146:     contains a whitespace delimited list of regular expressions.  It
                   2147:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   2148:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   2149:     some examples.  This may save some of your bandwidth and
                   2150:     time.</p>
1.75      rillig   2151: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      2152:     if you want to keep the settings, by editing the
                   2153:     <code class="filename">/etc/mk.conf</code> file,
                   2154:     and adding the definitions there.</p>
1.82      rillig   2155: <p>
1.88      wiz      2156:       If a package depends on many other packages (such as
1.93      rillig   2157:       <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      2158:       alternate between periods of
                   2159:       downloading source, and compiling. To ensure you have all the source
                   2160:       downloaded initially you can run the command:
                   2161:       </p>
1.82      rillig   2162: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   2163: <p>
1.88      wiz      2164:       which will output and run a set of shell commands to fetch the
                   2165:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   2166:       also choose to download the files manually.
                   2167:     </p>
1.75      rillig   2168: </div>
                   2169: <div class="sect2" lang="en">
                   2170: <div class="titlepage"><div><div><h3 class="title">
                   2171: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   2172: <p>
1.88      wiz      2173:       Once the software has downloaded, any patches will be applied, then it
                   2174:       will be compiled for you. This may take some time depending on your
                   2175:       computer, and how many other packages the software depends on and their
                   2176:       compile time.
                   2177:     </p>
1.75      rillig   2178: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2179: <h3 class="title">Note</h3>
                   2180: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88      wiz      2181:     use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
                   2182:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   2183: </div>
1.87      wiz      2184: <p>For example, type</p>
1.88      wiz      2185: <pre class="screen">
                   2186: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2187: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   2188:     </pre>
1.75      rillig   2189: <p>at the shell prompt to build the various components of the
1.88      wiz      2190:     package.</p>
1.82      rillig   2191: <p>The next stage is to actually install the newly compiled
1.88      wiz      2192:     program onto your system. Do this by entering:
1.82      rillig   2193: 
1.88      wiz      2194:     </p>
1.82      rillig   2195: <pre class="screen">
1.88      wiz      2196: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   2197:     </pre>
1.82      rillig   2198: <p>
                   2199: 
1.88      wiz      2200:     while you are still in the directory for whatever package you
                   2201:     are installing.</p>
1.82      rillig   2202: <p>Installing the package on your system may require you to
1.88      wiz      2203:     be root.  However, pkgsrc has a
                   2204:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2205:     to only become root for the actual installation step.</p>
1.82      rillig   2206: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2207:     You can now enter:
1.82      rillig   2208: 
1.88      wiz      2209:     </p>
1.82      rillig   2210: <pre class="screen">
1.88      wiz      2211: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2212:     </pre>
1.82      rillig   2213: <p>
                   2214: 
1.88      wiz      2215:     to remove the compiled files in the work directory, as you shouldn't need
                   2216:     them any more. If other packages were also added to your system
                   2217:     (dependencies) to allow your program to compile, you can tidy these up
                   2218:     also with the command:</p>
1.82      rillig   2219: <pre class="screen">
1.88      wiz      2220: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2221:     </pre>
1.75      rillig   2222: <p>Taking the figlet utility as an example, we can install it on our
1.88      wiz      2223:     system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
                   2224: <p>The program is installed under the default root of the
                   2225:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2226:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2227:     variable in your environment, and it will use that value as the
                   2228:     root of your packages tree. So, to use
                   2229:     <code class="filename">/usr/local</code>, set
                   2230:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2231:     Please note that you should use a directory which is dedicated to
                   2232:     packages and not shared with other programs (i.e., do not try and
                   2233:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2234:     to add any of your own files or directories (such as
                   2235:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2236:     <code class="filename">pkgsrc/</code>) below the
                   2237:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2238:     conflicts between programs and other files installed by the
                   2239:     package system and whatever else may have been installed
                   2240:     there.</p>
                   2241: <p>Some packages look in <code class="filename">/etc/mk.conf</code> to
                   2242:     alter some configuration options at build time.  Have a look at
                   2243:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2244:     of what will be set there by default.  Environment variables such
                   2245:     as <code class="varname">LOCALBASE</code> can be set in
                   2246:     <code class="filename">/etc/mk.conf</code> to save having to remember to
                   2247:     set them each time you want to use pkgsrc.</p>
                   2248: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2249:     covers</span>&#8221; to see what is going on when a package is building
                   2250:     or being installed. This may be for debugging purposes, or out of
                   2251:     simple curiosity. A number of utility values have been added to
                   2252:     help with this.</p>
1.75      rillig   2253: <div class="orderedlist"><ol type="1">
                   2254: <li>
1.88      wiz      2255: <p>If you invoke the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
                   2256:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2257:        information will be displayed. For example,</p>
1.75      rillig   2258: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2259: <p>will show all the commands that are invoked, up to and
                   2260:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2261: </li>
                   2262: <li>
1.88      wiz      2263: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2264:        definition, then the <code class="varname">VARNAME</code> definition
                   2265:        should be used, in conjunction with the show-var
                   2266:        target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   2267:        variable <code class="varname">LOCALBASE</code>:</p>
                   2268: <pre class="screen">
                   2269: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2270: /usr/pkg
                   2271: <code class="prompt">%</code>
1.88      wiz      2272:        </pre>
1.75      rillig   2273: </li>
                   2274: </ol></div>
                   2275: <p>If you want to install a binary package that you've either
1.88      wiz      2276:     created yourself (see next section), that you put into
                   2277:     pkgsrc/packages manually or that is located on a remote FTP
                   2278:     server, you can use the "bin-install" target. This target will
                   2279:     install a binary package - if available - via <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2280:     else do a <span><strong class="command">make package</strong></span>.  The list of remote FTP
                   2281:     sites searched is kept in the variable
                   2282:     <code class="varname">BINPKG_SITES</code>, which defaults to
                   2283:     ftp.NetBSD.org. Any flags that should be added to <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
                   2284:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2285:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2286:     details.</p>
                   2287: <p>A final word of warning: If you set up a system that has a
                   2288:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2289:     set that before any packages are installed, as you cannot use
                   2290:     several directories for the same purpose. Doing so will result in
                   2291:     pkgsrc not being able to properly detect your installed packages,
                   2292:     and fail miserably. Note also that precompiled binary packages are
                   2293:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2294:     <code class="filename">/usr/pkg</code>, and that you should
                   2295:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2296:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2297: </div>
                   2298: </div>
                   2299: </div>
                   2300: <div class="chapter" lang="en">
                   2301: <div class="titlepage"><div><div><h2 class="title">
                   2302: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2303: <div class="toc">
                   2304: <p><b>Table of Contents</b></p>
                   2305: <dl>
                   2306: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2307: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103   ! wiz      2308: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
        !          2309: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2310: <dd><dl>
1.103   ! wiz      2311: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
        !          2312: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
        !          2313: <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      2314: </dl></dd>
1.103   ! wiz      2315: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
        !          2316: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2317: </dl>
                   2318: </div>
1.89      rillig   2319: <p>The whole pkgsrc system is configured in a single file, usually
                   2320: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2321: that file depends on the installation. On NetBSD, when you use
                   2322: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
                   2323: <code class="filename">/etc/</code>. In all other cases the default location is
                   2324: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2325: bootstrap program to install the binary packages.</p>
                   2326: <p>During the bootstrap, an example configuration file is created. To
                   2327: use that, you have to create the directory
                   2328: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2329: there.</p>
                   2330: <p>The format of the configuration file is that of the usual
                   2331: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2332: is done by setting variables in this file. Note that you can define all
                   2333: kinds of variables, and no special error checking (for example for
                   2334: spelling mistakes) takes place, so you have to try it out to see if it
                   2335: works.</p>
1.75      rillig   2336: <div class="sect1" lang="en">
                   2337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2338: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2339: <p>In this section, you can find some variables that apply to all
1.89      rillig   2340:     pkgsrc packages. A complete list of the variables that can be
                   2341:     configured by the user is available in
                   2342:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2343:     comments that describe each variable's intent.</p>
1.75      rillig   2344: <div class="itemizedlist"><ul type="disc">
                   2345: <li><p><code class="varname">LOCALBASE</code>: Where
                   2346:            packages will be installed. The default is
1.76      rillig   2347:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2348:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2349: <li><p><code class="varname">CROSSBASE</code>: Where
                   2350:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2351:            installed. The default is
1.76      rillig   2352:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2353: <li><p><code class="varname">X11BASE</code>: Where
                   2354:            X11 is installed on the system. The default is
1.76      rillig   2355:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2356: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2357:            downloaded copies of the original source distributions used
                   2358:            for building pkgsrc packages. The default is
1.76      rillig   2359:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2360: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2361:            database about installed packages is stored.  The default is
                   2362:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2363: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2364:            If set, override the packages'
                   2365:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2366: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2367:            Backup location(s) for distribution files and patch files
                   2368:            if not found locally or in
1.76      rillig   2369:            <code class="filename">${MASTER_SITES}</code> or
                   2370:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2371:            The defaults are
1.76      rillig   2372:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2373:            and
1.76      rillig   2374:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2375: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2376:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2377:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2378:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2379:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2380: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2381:            List of acceptable licenses. Whenever you try to build a package
                   2382:            whose license is not in this list, you will get an error message
                   2383:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2384: </ul></div>
                   2385: </div>
                   2386: <div class="sect1" lang="en">
                   2387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2388: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2389: <p>XXX
                   2390:       </p>
                   2391: <div class="itemizedlist"><ul type="disc">
                   2392: <li><p><code class="varname">PACKAGES</code>: The top level
                   2393:            directory for the binary packages. The default is
1.76      rillig   2394:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2395: <li><p><code class="varname">WRKOBJDIR</code>:
                   2396:            The top level directory where, if defined, the separate
                   2397:            working directories will get created, and symbolically
1.76      rillig   2398:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2399:            This is useful for building packages on several
1.76      rillig   2400:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2401:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2402:            is local to every architecture. (It should be noted that
                   2403:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.103   ! wiz      2404:            &#8212; it is an internal definition which refers to the
1.75      rillig   2405:            root of the pkgsrc tree. It is possible to have many
                   2406:            pkgsrc tree instances.)</p></li>
                   2407: <li><p><code class="varname">LOCALPATCHES</code>:
                   2408:            Directory for local patches that aren't part of pkgsrc.
1.90      rillig   2409:            See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2410:            information.</p></li>
1.75      rillig   2411: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.76      rillig   2412:            the <code class="filename">mk.conf</code> file used by a package's
1.75      rillig   2413:            BSD-style Makefile. If this is not set,
                   2414:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2415:            <code class="filename">/dev/null</code> to avoid picking up
                   2416:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2417: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2418:            By default, dependencies are only installed, and no binary
                   2419:            package is created for them. You can set this variable to
                   2420:            <code class="literal">package</code> to automatically create binary
                   2421:            packages after installing dependencies.</p></li>
1.75      rillig   2422: </ul></div>
                   2423: </div>
                   2424: <div class="sect1" lang="en">
                   2425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      2426: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
        !          2427: <p>A growing number of packages support installation into a
        !          2428:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
        !          2429:     to be built, before the actual filesystem is touched. DESTDIR
        !          2430:     support exists in two variations:</p>
        !          2431: <div class="itemizedlist"><ul type="disc">
        !          2432: <li><p>Basic DESTDIR support means that the package
        !          2433:       installation and packaging is still run as
        !          2434:       root.</p></li>
        !          2435: <li><p>Full DESTDIR support can run the complete build,
        !          2436:       installation and packaging as normal user. Root privileges are
        !          2437:       only needed to add packages.</p></li>
        !          2438: </ul></div>
        !          2439: <p>To use the DESTDIR support, set either
        !          2440:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
        !          2441:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
        !          2442:     get the full support with fallback to basic
        !          2443:     support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
        !          2444:     newer). It might become the default DESTDIR support later.</p>
        !          2445: <p>DESTDIR support changes the behaviour of various targets
        !          2446:     slightly. To install a package after building it, use
        !          2447:     <code class="literal">package-install</code>. <code class="literal">package</code> and
        !          2448:     <code class="literal">install</code> don't do that any
        !          2449:     longer. <code class="literal">package-install</code> can be used as
        !          2450:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
        !          2451:     will ask for the root password to install the package and fail,
        !          2452:     <code class="literal">package-install</code> will ask again.</p>
        !          2453: <p>With basic DESTDIR support, <strong class="userinput"><code>make
        !          2454:     clean</code></strong> needs to be run as root.</p>
        !          2455: </div>
        !          2456: <div class="sect1" lang="en">
        !          2457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
        !          2458: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2459: <div class="sect2" lang="en">
                   2460: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      2461: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2462: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2463:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2464: <div class="variablelist"><dl>
                   2465: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2466: <dd>
                   2467: <p>This is a list of values specifying the chain of
                   2468:          compilers to invoke when building packages.  Valid values
                   2469:          are:</p>
                   2470: <div class="itemizedlist"><ul type="disc">
                   2471: <li><p><code class="varname">distcc</code>:
                   2472:            distributed C/C++ (chainable)</p></li>
                   2473: <li><p><code class="varname">ccache</code>:
                   2474:            compiler cache (chainable)</p></li>
                   2475: <li><p><code class="varname">gcc</code>:
                   2476:            GNU C/C++ Compiler</p></li>
                   2477: <li><p><code class="varname">mipspro</code>:
                   2478:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2479: <li><p><code class="varname">mipspro</code>:
                   2480:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2481: <li><p><code class="varname">sunpro</code>:
                   2482:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2483: </ul></div>
                   2484: <p>The default is
                   2485:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2486:          <code class="varname">ccache</code> and/or
                   2487:          <code class="varname">distcc</code> with an appropriate
                   2488:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2489:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2490:          variable should always be terminated with a value for
                   2491:          a real compiler.  Note that only one real compiler
                   2492:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2493:          is not allowed).</p>
1.89      rillig   2494: </dd>
                   2495: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2496: <dd><p>This specifies the minimum version of GCC to use
                   2497:          when building packages.  If the system GCC doesn't
                   2498:          satisfy this requirement, then pkgsrc will build and
                   2499:          install one of the GCC packages to use instead.</p></dd>
                   2500: </dl></div>
                   2501: </div>
                   2502: <div class="sect2" lang="en">
                   2503: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      2504: <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   2505: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2506:        please make sure to use the <code class="literal">+=</code> operator
                   2507:        instead of the <code class="literal">=</code> operator:</p>
                   2508: <pre class="programlisting">
1.100     rillig   2509: CFLAGS+=        -your -flags
1.78      rillig   2510: </pre>
                   2511: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
                   2512:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that need
                   2513:        to add their own flags.  Also, you may want to take a look at
1.91      rillig   2514:        the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
1.78      rillig   2515:        you're interested in optimization for the current CPU.</p>
                   2516: </div>
1.88      wiz      2517: <div class="sect2" lang="en">
                   2518: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      2519: <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      2520: <p>If you want to pass flags to the linker, both in the configure
                   2521: step and the build step, you can do this in two ways.  Either set
                   2522: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2523: between the two is that <code class="varname">LIBS</code> will be appended to
                   2524: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2525: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2526: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2527: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2528: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2529: settings, use the <code class="literal">+=</code> operator:</p>
                   2530: <pre class="programlisting">
1.100     rillig   2531: LDFLAGS+=        -your -linkerflags
1.88      wiz      2532: </pre>
                   2533: </div>
1.78      rillig   2534: </div>
                   2535: <div class="sect1" lang="en">
                   2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      2537: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2538: <p>XXX
                   2539:       </p>
                   2540: <div class="itemizedlist"><ul type="disc">
                   2541: <li>
                   2542: <p><code class="varname">PKG_DEVELOPER</code>:
                   2543:            Run some sanity checks that package developers want:
                   2544:            </p>
                   2545: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2546: <li><p>make sure patches apply with zero
                   2547:              fuzz</p></li>
                   2548: <li><p>run check-shlibs to see that all
                   2549:              binaries will find their shared libs.</p></li>
1.75      rillig   2550: </ul></div>
                   2551: <p>
1.87      wiz      2552:        </p>
1.75      rillig   2553: </li>
1.88      wiz      2554: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2555:        of debugging output which is displayed whilst making and
                   2556:        installing the package.  The default value for this is 0,
                   2557:        which will not display the commands as they are executed
                   2558:        (normal, default, quiet operation); the value 1 will display
                   2559:        all shell commands before their invocation, and the value 2
                   2560:        will display both the shell commands before their invocation,
                   2561:        and their actual execution progress with <span><strong class="command">set
                   2562:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2563: </ul></div>
                   2564: <p>
                   2565:     </p>
                   2566: </div>
                   2567: <div class="sect1" lang="en">
                   2568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      2569: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2570: <p>Some packages have build time options, usually to select
                   2571:     between different dependencies, enable optional support for big
                   2572:     dependencies or enable experimental features.</p>
1.75      rillig   2573: <p>To see which options, if any, a package supports, and which
1.88      wiz      2574:     options are mutually exclusive, run <span><strong class="command">make
                   2575:     show-options</strong></span>, for example:</p>
1.75      rillig   2576: <pre class="programlisting">
                   2577:     The following options are supported by this package:
                   2578:         ssl      Enable SSL support.
                   2579:     Exactly one of the following gecko options is required:
                   2580:         firefox  Use firefox as gecko rendering engine.
                   2581:         mozilla  Use mozilla as gecko rendering engine.
                   2582:     At most one of the following database options may be selected:
                   2583:         mysql    Enable support for MySQL database.
                   2584:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2585: 
1.75      rillig   2586:     These options are enabled by default: firefox
                   2587:     These options are currently enabled: mozilla ssl
1.1       grant    2588: </pre>
1.75      rillig   2589: <p>The following variables can be defined in
1.88      wiz      2590:     <code class="filename">/etc/mk.conf</code> to select which options to
                   2591:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2592:     which can be used to select or disable options for all packages
                   2593:     that support them, and
                   2594:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2595:     which can be used to select or disable options specifically for
                   2596:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2597:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2598:     are disabled. A few examples:</p>
1.75      rillig   2599: <pre class="screen">
                   2600: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" /etc/mk.conf</strong></span>
                   2601: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2602: PKG_OPTIONS.kdebase=    debug -sasl
                   2603: PKG_OPTIONS.apache=     suexec </pre>
1.88      wiz      2604: <p>The following settings are consulted in the order given, and
                   2605:     the last setting that selects or disables an option is
                   2606:     used:</p>
1.75      rillig   2607: <div class="orderedlist"><ol type="1">
                   2608: <li><p>the default options as suggested by the package
1.88      wiz      2609:       maintainer</p></li>
1.75      rillig   2610: <li><p>the options implied by the settings of legacy
1.88      wiz      2611:       variables (see below)</p></li>
1.75      rillig   2612: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2613: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2614: </ol></div>
                   2615: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2616:     selected is used, all others are automatically disabled.  If an
                   2617:     option of the group is explicitly disabled, the previously
                   2618:     selected option, if any, is used.  It is an error if no option
                   2619:     from a required group of options is selected, and building the
                   2620:     package will fail.</p>
                   2621: <p>Before the options framework was introduced, build options
                   2622:     were selected by setting a variable (often named
                   2623:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
                   2624:     <code class="filename">/etc/mk.conf</code> for each option.  To ease
                   2625:     transition to the options framework for the user, these legacy
                   2626:     variables are converted to the appropriate options setting
                   2627:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2628:     automatically.  A warning is issued to prompt the user to update
                   2629:     <code class="filename">/etc/mk.conf</code> to use the options framework
                   2630:     directly.  Support for the legacy variables will be removed
                   2631:     eventually.</p>
1.75      rillig   2632: </div>
                   2633: </div>
                   2634: <div class="chapter" lang="en">
                   2635: <div class="titlepage"><div><div><h2 class="title">
                   2636: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2637: <div class="toc">
                   2638: <p><b>Table of Contents</b></p>
                   2639: <dl>
                   2640: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2641: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2642: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
                   2643: <dd><dl>
                   2644: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
                   2645: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
                   2646: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
                   2647: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
                   2648: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
                   2649: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2650: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
                   2651: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
                   2652: </dl></dd>
                   2653: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2654: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
                   2655: </dl>
                   2656: </div>
                   2657: <div class="sect1" lang="en">
                   2658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2659: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2660: <p>Once you have built and installed a package, you can create
                   2661:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
                   2662:     another system with <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
                   2663:     the same package on a group of hosts and wasting CPU time. It also
                   2664:     provides a simple means for others to install your package, should
                   2665:     you distribute it.</p>
                   2666: <p>To create a binary package, change into the appropriate
                   2667:     directory in pkgsrc, and run <span><strong class="command">make
                   2668:     package</strong></span>:</p>
                   2669: <pre class="screen">
                   2670: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2671: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2672:     </pre>
                   2673: <p>This will build and install your package (if not already done),
                   2674:     and then build a binary package from what was installed. You can
                   2675:     then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
                   2676:     it. Binary packages are created by default in
                   2677:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
                   2678:     gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.91      rillig   2679:     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.90      rillig   2680: <p>See <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2681:     such a binary package.</p>
1.75      rillig   2682: </div>
                   2683: <div class="sect1" lang="en">
                   2684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2685: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90      rillig   2686: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.75      rillig   2687: </div>
                   2688: <div class="sect1" lang="en">
                   2689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2690: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
                   2691: <p>If you want to get a full set of precompiled binary
1.87      wiz      2692:     packages, this section describes how to get them. Beware that
                   2693:     the bulk build will remove all currently installed packages from
                   2694:     your system!</p>
1.75      rillig   2695: <p>Having an FTP server configured either on the
1.87      wiz      2696:     machine doing the bulk builds or on a nearby NFS server can help
                   2697:     to make the packages available to other machines that can then
                   2698:     save time by installing only the binary packages. See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftpd+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftpd</span>(8)</span></a> for
                   2699:     more information. If you use a remote NFS server's storage, be
                   2700:     sure to not actually compile on NFS storage, as this slows
                   2701:     things down a lot.</p>
1.75      rillig   2702: <div class="sect2" lang="en">
                   2703: <div class="titlepage"><div><div><h3 class="title">
                   2704: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
                   2705: <div class="sect3" lang="en">
                   2706: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2707: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
                   2708: </h4></div></div></div>
1.76      rillig   2709: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2710:        configuration file for bulk builds. You can configure how your
                   2711:        copy of pkgsrc is kept up to date, how the distfiles are
                   2712:        downloaded, how the packages are built and how the report is
                   2713:        generated. You can find an annotated example file in
                   2714:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2715:        it, copy <code class="filename">build.conf-example</code> to
                   2716:        <code class="filename">build.conf</code> and edit it, following the
                   2717:        comments in that file.</p>
1.75      rillig   2718: </div>
                   2719: <div class="sect3" lang="en">
                   2720: <div class="titlepage"><div><div><h4 class="title">
                   2721: <a name="binary.mk.conf"></a>6.3.1.2. /etc/mk.conf</h4></div></div></div>
                   2722: <p>You may want to set variables in
1.87      wiz      2723:        <code class="filename">/etc/mk.conf</code>.
                   2724:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2725:        details of the default settings. You will want to ensure that
                   2726:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2727:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
                   2728:        accepts <span class="emphasis"><em>all</em></span> licenses.</p>
                   2729: <pre class="programlisting">
1.100     rillig   2730: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2731: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2732: BSDSRCDIR=      /usr/src
                   2733: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2734: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2735: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2736: PKG_DEVELOPER?= yes
                   2737: _ACCEPTABLE=    yes
                   2738: </pre>
1.75      rillig   2739: <p>Some options that are especially useful for bulk builds
                   2740:        can be found at the top lines of the file
1.76      rillig   2741:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2742:        options of these are briefly described here.</p>
                   2743: <div class="itemizedlist"><ul type="disc">
                   2744: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2745:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2746:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2747: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2748:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2749:          to the directory where all log files are created. Otherwise the
                   2750:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2751: <li><p>Another important variable is
1.87      wiz      2752:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2753:          should be always available while building other
                   2754:          packages.</p></li>
1.75      rillig   2755: </ul></div>
                   2756: <p>Some other options are scattered in the pkgsrc
                   2757:        infrastructure:</p>
                   2758: <div class="itemizedlist"><ul type="disc">
                   2759: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2760:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2761:          builds is creating binary packages, no matter if they are
                   2762:          vulnerable or not. When uploading the packages to a public
                   2763:          server, the vulnerable packages will be put into a directory of
                   2764:          their own. Leaving this variable unset would prevent the bulk
                   2765:          build system from even trying to build them, so possible
                   2766:          building errors would not show up.</p></li>
1.75      rillig   2767: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2768:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2769:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2770:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2771: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2772:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2773:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2774:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2775:          interpreter.</p></li>
1.91      rillig   2776: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2777:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2778:          package's self-test before installing it. Note that some
                   2779:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2780:          numbers, so you need to assure that the machine on which you
                   2781:          are doing the bulk builds is not completely idle. Otherwise
                   2782:          some test programs will seem to hang, while they are just
                   2783:          waiting for new random data to be
                   2784:          available.</p></li>
1.75      rillig   2785: </ul></div>
                   2786: </div>
                   2787: <div class="sect3" lang="en">
                   2788: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   2789: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
                   2790: </h4></div></div></div>
1.75      rillig   2791: <p>It is possible to configure the bulk build to perform
1.87      wiz      2792:        certain site-specific tasks at the end of the pre-build
                   2793:        stage.  If the file
                   2794:        <code class="filename">pre-build.local</code> exists in
                   2795:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
                   2796:        (as a <a href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
                   2797:        stage.  An example use of
                   2798:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2799: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2800:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2801: <p>to prevent the system from trying to build a particular package
1.87      wiz      2802:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2803: </div>
                   2804: </div>
                   2805: <div class="sect2" lang="en">
                   2806: <div class="titlepage"><div><div><h3 class="title">
                   2807: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2808: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2809:       deleted at the start of bulk builds, make sure your login
                   2810:       shell is placed somewhere else. Either drop it into
                   2811:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2812:       shell in the passwd file), or (re-)install it via
                   2813:       <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
                   2814:       you can login after a reboot (remember that your current
                   2815:       process won't die if the package is removed, you just can't
                   2816:       start any new instances of the shell any more).  Also, if you
                   2817:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2818:       version of ssh for some reason, be sure to install ssh before
                   2819:       starting it from <code class="filename">rc.local</code>:</p>
                   2820: <pre class="programlisting">
1.100     rillig   2821: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2822: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2823:   /usr/pkg/etc/rc.d/sshd
                   2824: fi
                   2825: </pre>
1.75      rillig   2826: <p>Not doing so will result in you being not able to log in
1.87      wiz      2827:       via ssh after the bulk build is finished or if the machine
                   2828:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2829: </div>
                   2830: <div class="sect2" lang="en">
                   2831: <div class="titlepage"><div><div><h3 class="title">
                   2832: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
                   2833: <p>Make sure you don't need any of the packages still
1.87      wiz      2834:       installed.</p>
1.75      rillig   2835: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2836: <h3 class="title">Warning</h3>
1.99      rillig   2837: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2838:        configuration files and some more files from
                   2839:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2840:        possibly other locations will be removed! So don't run a bulk
                   2841:        build with privileges that might harm your
                   2842:        system.</em></span></p>
1.75      rillig   2843: </div>
                   2844: <p>Be sure to remove all other things that might
1.87      wiz      2845:       interfere with builds, like some libs installed in
                   2846:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2847: <pre class="screen">
                   2848: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2849: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2850:       </pre>
1.75      rillig   2851: <p>If for some reason your last build didn't complete (power
1.87      wiz      2852:       failure, system panic, ...), you can continue it by
                   2853:       running:</p>
1.75      rillig   2854: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2855: <p>At the end of the bulk build, you will get a summary via mail,
                   2856:       and find build logs in the directory specified by
                   2857:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2858:       file.</p>
1.75      rillig   2859: </div>
                   2860: <div class="sect2" lang="en">
                   2861: <div class="titlepage"><div><div><h3 class="title">
                   2862: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
                   2863: <p>The bulk builds consist of three steps:</p>
                   2864: <div class="variablelist"><dl>
                   2865: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2866: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2867:            cleans out any broken distfiles, and removes all
                   2868:            packages installed.</p></dd>
1.75      rillig   2869: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2870: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2871:            an optimised order in which packages will be
                   2872:            built. Packages that don't require other packages will
                   2873:            be built first, and packages with many dependencies will
                   2874:            be built later.</p></dd>
1.75      rillig   2875: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2876: <dd><p>Generates a report that's placed in the directory
                   2877:            specified in the <code class="filename">build.conf</code> file
                   2878:            named <code class="filename">broken.html</code>, a short version
                   2879:            of that report will also be mailed to the build's
                   2880:            admin.</p></dd>
1.75      rillig   2881: </dl></div>
1.87      wiz      2882: <p>During the build, a list of broken packages will be compiled
                   2883:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2884:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2885:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2886:       of broken builds can be found in the package's
                   2887:       directory. These files are used by the bulk-targets to mark
                   2888:       broken builds to not waste time trying to rebuild them, and
                   2889:       they can be used to debug these broken package builds
                   2890:       later.</p>
1.75      rillig   2891: </div>
                   2892: <div class="sect2" lang="en">
                   2893: <div class="titlepage"><div><div><h3 class="title">
                   2894: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
                   2895: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2896:       NetBSD 2.0/i386:</p>
1.75      rillig   2897: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2898: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2899: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2900: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2901: </ul></div>
                   2902: <p>Note that all pkgs will be de-installed as soon as they are
                   2903:       turned into a binary package, and that sources are removed,
                   2904:       so there is no excessively huge demand to disk
                   2905:       space. Afterwards, if the package is needed again, it will
                   2906:       be installed via <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
                   2907:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2908: </div>
                   2909: <div class="sect2" lang="en">
                   2910: <div class="titlepage"><div><div><h3 class="title">
                   2911: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2912: <p>If you don't want all the packages nuked from a machine
                   2913:       (rendering it useless for anything but pkg compiling), there
                   2914:       is the possibility of doing the package bulk build inside a
                   2915:       chroot environment.</p>
                   2916: <p>The first step is to set up a chroot sandbox,
                   2917:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2918:       using null mounts, or manually.</p>
                   2919: <p>There is a shell script called
                   2920:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2921:       up the sandbox environment using null mounts. It will also
                   2922:       create a script called <code class="filename">sandbox</code> in the
                   2923:       root of the sandbox environment, which will allow the null
                   2924:       mounts to be activated using the <span><strong class="command">sandbox
                   2925:       mount</strong></span> command and deactivated using the
                   2926:       <span><strong class="command">sandbox umount</strong></span> command.</p>
                   2927: <p>To set up a sandbox environment by hand, after extracting all
                   2928:       the sets from a NetBSD installation or doing a <span><strong class="command">make
                   2929:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2930:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2931:       are present and properly configured:</p>
1.75      rillig   2932: <div class="procedure"><ol type="1">
                   2933: <li>
                   2934: <p>Kernel</p>
                   2935: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2936: </li>
                   2937: <li>
1.76      rillig   2938: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2939: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2940: </li>
                   2941: <li>
1.91      rillig   2942: <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   2943: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2944: </li>
                   2945: <li>
                   2946: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2947: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2948: </li>
                   2949: <li>
1.91      rillig   2950: <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   2951: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2952: </li>
                   2953: <li>
1.76      rillig   2954: <p><code class="filename">/usr/src</code> (system sources,
1.103   ! wiz      2955:          e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.75      rillig   2956: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2957:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2958: </li>
                   2959: <li>
1.76      rillig   2960: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2961: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2962: </li>
                   2963: <li>
1.76      rillig   2964: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2965: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2966: </li>
                   2967: <li>
                   2968: <p>Checkout pkgsrc via cvs into
1.87      wiz      2969:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2970: <pre class="screen">
                   2971: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2972: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2973:          </pre>
1.75      rillig   2974: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2975:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2976: </li>
                   2977: <li><p>Make
1.87      wiz      2978:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2979:          <code class="filename">.../distfiles</code> point somewhere
                   2980:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.76      rillig   2981: <li><p>Edit <code class="filename">/etc/mk.conf</code>, see <a href="#binary.mk.conf" title="6.3.1.2. /etc/mk.conf">Section 6.3.1.2, &#8220;/etc/mk.conf&#8221;</a>.</p></li>
                   2982: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2983: </ol></div>
                   2984: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2985:       the build with the following steps:</p>
                   2986: <pre class="screen">
                   2987: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2988: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2989:       </pre>
                   2990: <p>This will just jump inside the sandbox and start building.  At
                   2991:        the end of the build, mail will be sent with the results of
                   2992:        the build. Created binary pkgs will be in
                   2993:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2994:       (wherever that points/mounts to/from).</p>
1.75      rillig   2995: </div>
                   2996: <div class="sect2" lang="en">
                   2997: <div class="titlepage"><div><div><h3 class="title">
                   2998: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2999: <p>In addition to building a complete set of all packages in
                   3000:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   3001:       may be used to build a subset of the packages contained in
                   3002:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
                   3003:       in <code class="filename">/etc/mk.conf</code>, the variables</p>
1.75      rillig   3004: <div class="itemizedlist"><ul type="disc">
                   3005: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   3006: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   3007: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   3008: <li><p>USER_SPECIFIC_PKGS</p></li>
                   3009: </ul></div>
1.87      wiz      3010: <p>will define the set of packages which should be built.
                   3011:       The bulk build code will also include any packages which are
                   3012:       needed as dependencies for the explicitly listed packages.</p>
                   3013: <p>One use of this is to do a bulk build with
                   3014:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   3015:       periodically to have a complete set of the binary packages
                   3016:       needed for your site available without the overhead of
                   3017:       building extra packages that are not needed.</p>
1.75      rillig   3018: </div>
                   3019: <div class="sect2" lang="en">
                   3020: <div class="titlepage"><div><div><h3 class="title">
                   3021: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      3022: <p>This section describes how pkgsrc developers can upload binary
                   3023:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   3024: <p>If you would like to automatically create checksum files for the
                   3025:       binary packages you intend to upload, remember to set
                   3026:       <code class="varname">MKSUMS=yes</code> in your
                   3027:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   3028: <p>If you would like to PGP sign the checksum files (highly
                   3029:       recommended!), remember to set
                   3030:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   3031:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   3032:       your GPG password to sign the files before uploading everything.</p>
                   3033: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   3034:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   3035:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   3036: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   3037: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      3038:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   3039:       is different from your local login, write your login directly
                   3040:       into the variable, e.g. my local account is "feyrer", but for my
                   3041:       login "hubertf", I use:</p>
1.93      rillig   3042: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      3043: <p>A separate <code class="filename">upload</code> directory is used
                   3044:       here to allow "closing" the directory during upload. To do
                   3045:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   3046: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87      wiz      3047: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   3048:       only appropriate for packages for the NetBSD operating
                   3049:       system. Binary packages for other operating systems should go
                   3050:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   3051: <p>Before uploading the binary pkgs, ssh authentication needs
                   3052:       to be set up. This example shows how to set up temporary keys
                   3053:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   3054:       (assuming that no keys should be present there usually):</p>
                   3055: <pre class="screen">
                   3056: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   3057: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   3058: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      3059: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   3060:       </pre>
                   3061: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   3062:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   3063:       file on ftp.NetBSD.org. You can remove the key after the
                   3064:       upload is done!</p>
                   3065: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   3066: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      3067: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   3068: <p>Now after all this works, you can exit the sandbox and start
                   3069:       the upload:</p>
                   3070: <pre class="screen">
                   3071: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   3072: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      3073: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   3074:       </pre>
                   3075: <p>The upload process may take quite some time. Use <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   3076:       <a href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
                   3077:       upload. The upload script will take care of not uploading
                   3078:       restricted packages and putting vulnerable packages into the
                   3079:       <code class="filename">vulnerable</code> subdirectory.</p>
                   3080: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3081: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3082:       Gdd:x! </pre>
                   3083: <p>Use whatever is needed to remove the key you've entered
                   3084:       before! Last, move the uploaded packages out of the
                   3085:       <code class="filename">upload</code> directory to have them accessible
                   3086:       to everyone:</p>
                   3087: <pre class="screen">
1.93      rillig   3088: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   3089: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3090: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      3091: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   3092:       </pre>
1.75      rillig   3093: </div>
                   3094: </div>
                   3095: <div class="sect1" lang="en">
                   3096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3097: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3098: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3099:     create a CD-ROM set of the resulting binary packages to assist
                   3100:     in installing packages on other machines.  The
1.91      rillig   3101:     <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      3102:     a simple tool for creating the ISO 9660 images.
                   3103:     <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
                   3104:     way that keeps all the dependencies for a given package on the same
                   3105:     CD as that package.</p>
1.75      rillig   3106: <div class="sect2" lang="en">
                   3107: <div class="titlepage"><div><div><h3 class="title">
                   3108: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3109: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3110:       man page. The following short example assumes that the binary
                   3111:       packages are left in
                   3112:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3113:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3114:       hold the ISO 9660 images.</p>
                   3115: <pre class="screen">
                   3116: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3117: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3118: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3119:       </pre>
                   3120: <p>If you wish to include a common set of files
                   3121:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3122:       etc.) on each CD in the collection, then you need to create a
                   3123:       directory which contains these files. e.g.</p>
                   3124: <pre class="screen">
                   3125: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3126: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3127: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3128: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3129: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3130: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3131: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3132:       </pre>
1.75      rillig   3133: <p>Now create the images:</p>
                   3134: <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   3135: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3136:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3137:       in their root directories.</p>
1.75      rillig   3138: </div>
                   3139: </div>
                   3140: </div>
                   3141: <div class="chapter" lang="en">
                   3142: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3143: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
                   3144: <div class="toc">
                   3145: <p><b>Table of Contents</b></p>
                   3146: <dl>
1.91      rillig   3147: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90      rillig   3148: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                   3149: </dl>
                   3150: </div>
                   3151: <p>The files that are installed by pkgsrc are organized in a way that
                   3152: is similar to what you find in the <code class="filename">/usr</code> directory
                   3153: of the base system. But some details are different. This is because
                   3154: pkgsrc initially came from FreeBSD and had adopted its file system
                   3155: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3156: which operating system you are using pkgsrc with, you can expect the
                   3157: same layout for pkgsrc.</p>
1.91      rillig   3158: <p>There are mainly four root directories for pkgsrc, which are all
                   3159: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3160: When pkgsrc has been installed as root, the default locations
                   3161: are:</p>
                   3162: <pre class="programlisting">
1.100     rillig   3163: LOCALBASE=              /usr/pkg
                   3164: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3165: VARBASE=                /var
                   3166: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3167: </pre>
                   3168: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3169: user), the default locations are:</p>
                   3170: <pre class="programlisting">
1.100     rillig   3171: LOCALBASE=              ${HOME}/pkg
                   3172: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3173: VARBASE=                ${HOME}/pkg/var
                   3174: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3175: </pre>
                   3176: <p>What these four directories are for, and what they look like is
                   3177: explained below.</p>
1.90      rillig   3178: <div class="itemizedlist"><ul type="disc">
                   3179: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3180: <code class="filename">/usr</code> directory in the base system. It is the
                   3181: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3182: the well-known subdirectories like <code class="filename">bin</code>,
                   3183: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3184: <code class="filename">share</code> and
                   3185: <code class="filename">sbin</code>.</p></li>
                   3186: <li><p><code class="varname">VARBASE</code> corresponds to
                   3187: <code class="filename">/var</code> in the base system. Some programs (especially
                   3188: games, network daemons) need write access to it during normal
                   3189: operation.</p></li>
                   3190: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3191: <code class="filename">/etc</code> in the base system. It contains configuration
                   3192: files of the packages, as well as pkgsrc's <code class="filename">mk.conf</code>
                   3193: itself.</p></li>
                   3194: </ul></div>
                   3195: <div class="sect1" lang="en">
                   3196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3197: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
                   3198: </h2></div></div></div>
1.90      rillig   3199: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3200: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3201: <div class="variablelist"><dl>
                   3202: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3203: <dd><p>Contains executable programs that are intended to be
                   3204: directly used by the end user.</p></dd>
                   3205: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3206: <dd><p>Contains files for the emulation layers of various other
                   3207: operating systems, especially for
                   3208: NetBSD.</p></dd>
                   3209: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3210: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3211: <dd><p>Contains
                   3212: the configuration files.</p></dd>
                   3213: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3214: <dd><p>Contains headers for the C and C++ programming
                   3215: languages.</p></dd>
                   3216: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3217: <dd><p>Contains GNU info files of various
                   3218: packages.</p></dd>
                   3219: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3220: <dd><p>Contains shared and static
                   3221: libraries.</p></dd>
                   3222: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3223: <dd><p>Contains data files that don't change after
                   3224: installation. Other data files belong into
                   3225: <code class="filename">${VARBASE}</code>.</p></dd>
                   3226: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3227: <dd><p>Contains programs that are not intended to be used by
                   3228: end users, such as helper programs or network
                   3229: daemons.</p></dd>
                   3230: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3231: <dd><p>Contains programs that are intended to be executed as
                   3232: CGI scripts by a web server.</p></dd>
                   3233: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3234: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3235: <dd><p>Contains brief
                   3236: documentation in form of manual pages.</p></dd>
                   3237: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3238: <dd><p>Contains programs that are intended to be used only by
                   3239: the super-user.</p></dd>
                   3240: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3241: <dd><p>Contains platform-independent data files that don't
                   3242: change after installation.</p></dd>
                   3243: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3244: <dd><p>Contains documentation files provided by the
                   3245: packages.</p></dd>
                   3246: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3247: <dd><p>Contains example files provided by the packages. Among
                   3248: others, the original configuration files are saved here and copied to
                   3249: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3250: installation.</p></dd>
                   3251: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3252: <dd><p>Contains the original files for rc.d
                   3253: scripts.</p></dd>
                   3254: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3255: <code class="filename">${VARBASE}</code>)</span></dt>
                   3256: <dd><p>Contains files
                   3257: that may be modified after
                   3258: installation.</p></dd>
                   3259: </dl></div>
                   3260: </div>
                   3261: <div class="sect1" lang="en">
                   3262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   3263: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
                   3264: </h2></div></div></div>
1.90      rillig   3265: <div class="variablelist"><dl>
                   3266: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3267: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3268: <dd><p>Contains
                   3269: information about the currently installed
                   3270: packages.</p></dd>
                   3271: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3272: <dd><p>Contains highscore
                   3273: files.</p></dd>
                   3274: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3275: <dd><p>Contains log files.</p></dd>
                   3276: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3277: <dd><p>Contains informational files about daemons that are
                   3278: currently running.</p></dd>
                   3279: </dl></div>
                   3280: </div>
                   3281: </div>
                   3282: <div class="chapter" lang="en">
                   3283: <div class="titlepage"><div><div><h2 class="title">
                   3284: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3285: <div class="toc">
                   3286: <p><b>Table of Contents</b></p>
                   3287: <dl>
1.90      rillig   3288: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3289: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
                   3290: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
                   3291: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
                   3292: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103   ! wiz      3293: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
        !          3294: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
        !          3295: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
        !          3296: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
        !          3297: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3298: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</a></span></dt>
1.103   ! wiz      3299: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</a></span></dt>
        !          3300: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
        !          3301: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
        !          3302: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
        !          3303: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
        !          3304: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build.  What shall I do?</a></span></dt>
        !          3305: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</a></span></dt>
1.75      rillig   3306: </dl>
                   3307: </div>
                   3308: <p>This section contains hints, tips &amp; tricks on special things in
                   3309: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3310: it contains items for both pkgsrc users and developers.</p>
                   3311: <div class="sect1" lang="en">
                   3312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3313: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3314: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3315: <div class="itemizedlist"><ul type="disc">
1.103   ! wiz      3316: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3317:          This is a general purpose list for most issues regarding
                   3318:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3319:          for pkgsrc configuration, unexpected build failures, using
                   3320:          particular packages, upgrading pkgsrc installations,
                   3321:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3322:          proposals for changes that impact the pkgsrc user community,
                   3323:          e.g. major infrastructure changes, new features, package
                   3324:          removals, etc., may also be posted.</p></li>
1.103   ! wiz      3325: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3326:          A list where the results of pkgsrc bulk builds are sent and
                   3327:          discussed.</p></li>
1.103   ! wiz      3328: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3329:          This list is for those who are interested in getting a
                   3330:          commit message for every change committed to pkgsrc. It is
                   3331:          also available in digest form, meaning one daily message
                   3332:          containing all commit messages for changes to the package
                   3333:          source tree in that 24 hour period.</p></li>
                   3334: </ul></div>
                   3335: <p>To subscribe, do:</p>
                   3336: <pre class="programlisting">
1.100     rillig   3337: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3338: </pre>
                   3339: <p>Archives for all these mailing lists are available from
                   3340: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
                   3341: </div>
                   3342: <div class="sect1" lang="en">
                   3343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3344: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3345: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3346: pkgviews User's guide in
1.76      rillig   3347: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3348: </div>
                   3349: <div class="sect1" lang="en">
                   3350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3351: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3352: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3353: a number of useful utilities for both users and developers of pkgsrc.  This
                   3354: section attempts only to make the reader aware of the utilities and when
                   3355: they might be useful, and not to duplicate the documentation that comes
                   3356: with each package.</p>
                   3357: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3358: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   3359:       Symlinks for use by buildlink.</p></li></ul></div>
                   3360: <p>OS tool augmentation (automatically installed when needed):</p>
                   3361: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3362: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3363:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3364: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   3365:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3366: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      3367:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3368: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   3369:       Up-to-date replacement for
1.76      rillig   3370:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3371:       systems where pkg_install is not present.</p></li>
                   3372: </ul></div>
                   3373: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3374: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3375: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3376:       Create a binary package from an
                   3377:       already-installed package.  Used by <span><strong class="command">make replace</strong></span> to
                   3378:       save the old package.</p></li>
1.91      rillig   3379: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   3380:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3381:       from multiple locations. It currently supports the following
                   3382:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3383: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75      rillig   3384:       packages someplace else (enabled by default).</p></li>
1.91      rillig   3385: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine the
1.75      rillig   3386:       best compiler flags to optimise code for your current CPU and
                   3387:       compiler.</p></li>
                   3388: </ul></div>
                   3389: <p>Utilities for keeping track of installed packages, being up to date,
                   3390: etc:</p>
                   3391: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3392: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3393:       packages whose installed versions do not match the latest pkgsrc
                   3394:       entries.</p></li>
1.91      rillig   3395: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   3396:       dependency graphs of packages, to aid in choosing a strategy for
                   3397:       updating.</p></li>
1.91      rillig   3398: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   3399:       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>
                   3400: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.75      rillig   3401:       pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
                   3402:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3403: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   3404:       packages you have installed.</p></li>
                   3405: </ul></div>
                   3406: <p>Utilities for people maintaining or creating individual packages:</p>
                   3407: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3408: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3409:       making and maintaining patches for a package (includes pkgdiff,
                   3410:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3411: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
                   3412:       <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   3413:       converting to pkgsrc.</p></li>
1.91      rillig   3414: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75      rillig   3415:       pkgsrc to a Solaris package.</p></li>
                   3416: </ul></div>
                   3417: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3418: utilities)</p>
                   3419: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3420: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3421:       packages in a chrooted area.</p></li>
1.91      rillig   3422: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3423:       kernel version for chrooted cross builds.</p></li>
                   3424: </ul></div>
                   3425: </div>
                   3426: <div class="sect1" lang="en">
                   3427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3428: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3429: <p>If you want to use pkgsrc as non-root user, you can set some
                   3430: variables to make pkgsrc work under these conditions.  At the very least,
                   3431: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3432: will turn on unprivileged mode and set multiple related variables to allow
                   3433: installation of packages as non-root.</p>
                   3434: <p>In case the defaults are not enough, you may want to tune some other
                   3435: variables used.  For example, if the automatic user/group detection leads
                   3436: to incorrect values (or not the ones you would like to use), you can change
                   3437: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3438: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3439: <p>As regards bootstrapping, please note that the
                   3440: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
                   3441: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3442: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3443: installation targets.  These directories can be overridden by the
1.75      rillig   3444: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3445: that allow finer tuning of the tree layout.</p>
                   3446: </div>
                   3447: <div class="sect1" lang="en">
                   3448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   3449: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3450: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3451: enable this feature by adding the option
                   3452: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.76      rillig   3453: <code class="filename">/etc/mk.conf</code>.  If, during a fetch step, an incomplete
1.75      rillig   3454: distfile is found, pkgsrc will try to resume it.</p>
                   3455: <p>You can also
                   3456: use a different program than the default <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
                   3457: <code class="varname">FETCH_CMD</code> variable.  Don't forget to set
                   3458: <code class="varname">FETCH_RESUME_ARGS</code> and
                   3459: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
                   3460: values.</p>
                   3461: <p>For example, if you want to use
1.76      rillig   3462: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75      rillig   3463: like:</p>
                   3464: <pre class="programlisting">
1.100     rillig   3465: FETCH_CMD=             wget
                   3466: FETCH_BEFORE_ARGS=     --passive-ftp
                   3467: FETCH_RESUME_ARGS=     -c
                   3468: FETCH_OUTPUT_ARGS=     -O
1.1       grant    3469: </pre>
1.75      rillig   3470: </div>
                   3471: <div class="sect1" lang="en">
                   3472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3473: <a name="x.org-from-pkgsrc"></a>8.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
        !          3474: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3475: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3476: you will have to add the following line into
1.76      rillig   3477: <code class="filename">/etc/mk.conf</code>:</p>
1.75      rillig   3478: <pre class="programlisting">
1.103   ! wiz      3479: X11_TYPE=modular
1.1       grant    3480: </pre>
1.75      rillig   3481: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3482: <h3 class="title">Note</h3>
1.103   ! wiz      3483: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
        !          3484: </p>
1.75      rillig   3485: </div>
                   3486: </div>
                   3487: <div class="sect1" lang="en">
                   3488: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3489: <a name="fetch-behind-firewall"></a>8.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3490: <p>If you are sitting behind a firewall which does not allow direct
                   3491: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3492: relevant proxy hosts.  This is done using an environment variable in the
                   3493: form of a URL, e.g. in Amdahl, the machine
                   3494: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3495: port 80 as the proxy port number.  So the proxy environment variables
                   3496: are:</p>
                   3497: <pre class="programlisting">
1.100     rillig   3498: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3499: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3500: </pre>
1.75      rillig   3501: </div>
                   3502: <div class="sect1" lang="en">
                   3503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3504: <a name="passive-ftp"></a>8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3505: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3506: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3507: the first available command from the following list:</p>
                   3508: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3509: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3510: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3511: </ul></div>
                   3512: <p>On a default NetBSD installation, this will be
1.76      rillig   3513: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3514: connections first, and falls back to active connections if the server
                   3515: refuses to do passive.  For the other tools, add the following to your
1.76      rillig   3516: <code class="filename">/etc/mk.conf</code> file:
1.75      rillig   3517: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3518: <p>Having that option present will prevent
1.76      rillig   3519: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3520: transfers.</p>
                   3521: </div>
                   3522: <div class="sect1" lang="en">
                   3523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3524: <a name="fetching-all-distfiles"></a>8.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3525: <p>You would like to download all the distfiles in a single batch
                   3526: from work or university, where you can't run a <span><strong class="command">make
                   3527: fetch</strong></span>.  There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3528: but downloading the entire directory may not be appropriate.</p>
                   3529: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76      rillig   3530: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3531: resulting list to your machine at work/school and use it there.  If you
                   3532: don't have a NetBSD-compatible <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
                   3533: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3534: URL:</p>
                   3535: <p>At home:</p>
                   3536: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3537: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3538: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3539: <p>At work:</p>
                   3540: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3541: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3542: home.</p>
                   3543: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3544: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3545: machine architecture), you can do so by using the above-mentioned
                   3546: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
                   3547: directly by running:</p>
1.75      rillig   3548: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3549: <p>If you even decide to ignore
                   3550: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3551: by running:</p>
                   3552: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3553: </div>
                   3554: <div class="sect1" lang="en">
                   3555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3556: <a name="tmac.andoc-missing"></a>8.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3557: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3558: <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   3559: package, you get the error from make that it doesn't know how to make
1.76      rillig   3560: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3561: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3562: the NetBSD base distribution on your machine.  It is recommended to do
                   3563: that to format man pages.</p>
1.91      rillig   3564: <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   3565: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.76      rillig   3566: environment or in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   3567: </div>
                   3568: <div class="sect1" lang="en">
                   3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3570: <a name="bsd.own.mk-missing"></a>8.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3571: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3572: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3573: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3574: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3575: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3576: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.75      rillig   3577: the one that corresponds to your release (determine via <span><strong class="command">uname
                   3578: -r</strong></span>).</p>
                   3579: </div>
                   3580: <div class="sect1" lang="en">
                   3581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3582: <a name="using-sudo-with-pkgsrc"></a>8.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3583: <p>When installing packages as non-root user and using the just-in-time
                   3584: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
                   3585: password for each required package installed.  To avoid this, the sudo
                   3586: package can be used, which does password caching over a limited time.  To
                   3587: use it, install sudo (either as binary package or from
1.98      wiz      3588: <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
                   3589: following into your <code class="filename">/etc/mk.conf</code>, somewhere
                   3590: <span class="emphasis"><em>after</em></span> the definition of the
                   3591: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3592: <pre class="programlisting">
1.100     rillig   3593: .if exists(${LOCALBASE}/bin/sudo)
                   3594: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3595: .endif
1.1       grant    3596: </pre>
1.75      rillig   3597: </div>
                   3598: <div class="sect1" lang="en">
                   3599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3600: <a name="faq.conf"></a>8.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3601: <p>As the system administrator, you can choose where configuration files
                   3602: are installed.  The default settings make all these files go into
1.76      rillig   3603: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3604: be suboptimal depending on your expectations (e.g., a read-only,
                   3605: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3606: configuration of the provided packages).</p>
                   3607: <p>In order to change the defaults, you can modify the
                   3608: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.76      rillig   3609: <code class="filename">/etc/mk.conf</code>) to point to your preferred configuration
                   3610: directory; some common examples include <code class="filename">/etc</code> or
                   3611: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3612: <p>Furthermore, you can change this value on a per-package basis by
                   3613: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3614: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3615: package you would like to modify, that is, the contents of
                   3616: <code class="varname">PKGBASE</code>.</p>
                   3617: <p>Note that after changing these settings, you must rebuild and
                   3618: reinstall any affected packages.</p>
                   3619: </div>
                   3620: <div class="sect1" lang="en">
                   3621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3622: <a name="audit-packages"></a>8.14. Automated security checks</h2></div></div></div>
1.75      rillig   3623: <p>Please be aware that there can often be bugs in third-party software,
                   3624: and some of these bugs can leave a machine vulnerable to exploitation by
                   3625: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3626: maintains a database of known-exploits to packages which have at one time
                   3627: been included in pkgsrc.  The database can be downloaded automatically, and
                   3628: a security audit of all packages installed on a system can take place.  To
1.91      rillig   3629: do this, install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> package.  It has two
1.75      rillig   3630: components:</p>
                   3631: <div class="orderedlist"><ol type="1">
                   3632: <li>
                   3633: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
                   3634:     download a list of the security vulnerabilities information.  This list
                   3635:     is kept up to date by the NetBSD security officer and the NetBSD
                   3636:     packages team, and is distributed from the NetBSD ftp server:</p>
                   3637: <p><a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
                   3638: </li>
                   3639: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
                   3640:     current machine, checking each vulnerability which is known.  If a
                   3641:     vulnerable package is installed, it will be shown by output to stdout,
                   3642:     including a description of the type of vulnerability, and a URL
                   3643:     containing more information.</p></li>
                   3644: </ol></div>
1.91      rillig   3645: <p>Use of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>
1.75      rillig   3646: package is strongly recommended!  After
                   3647: &#8220;<span class="quote">audit-packages</span>&#8221; is installed, please read
                   3648: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
                   3649: audit-packages</code></strong>.</p>
1.87      wiz      3650: <p>If this package is installed, pkgsrc builds will use it to
                   3651: perform a security check before building any package.  See <a href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
                   3652: check.</p>
1.75      rillig   3653: </div>
                   3654: <div class="sect1" lang="en">
                   3655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3656: <a name="ufaq-cflags"></a>8.15. 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.76      rillig   3659:        <code class="filename">mk.conf</code>, these flags are passed in
                   3660:        environment variables to the <code class="filename">./configure</code>
1.75      rillig   3661:        scripts and to <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
                   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>
                   3667:        you should run <span><strong class="command">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
                   3671:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   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.80      rillig   3676: <div class="sect1" lang="en">
                   3677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3678: <a name="ufaq-fail"></a>8.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3679: <div class="procedure"><ol type="1">
                   3680: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   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>
                   3686: <li><p>Make sure that you don't have any CVS conflicts.
                   3687:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3688:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3689:        files.</p></li>
                   3690: <li><p>Make sure that you don't have old copies of the packages
                   3691:        extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
                   3692:        verify this.</p></li>
                   3693: <li><p>If the problem still exists, write a mail to the
                   3694:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3695: </ol></div>
                   3696: </div>
1.88      wiz      3697: <div class="sect1" lang="en">
                   3698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103   ! wiz      3699: <a name="faq.rcs-conflicts"></a>8.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.89      rillig   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
                   3707: anymore, you can remove that file and run <span><strong class="command">cvs -q update
                   3708: -dP</strong></span> in that directory to download the current version.</p>
                   3709: </div>
1.75      rillig   3710: </div>
                   3711: </div>
                   3712: <div class="part" lang="en">
                   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.77      rillig   3715: <div class="partintro" lang="en">
                   3716: <div></div>
                   3717: <p>This part of the book deals with creating and
                   3718:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   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.90      rillig   3724: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3725: <dd><dl>
                   3726: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3727: <dd><dl>
                   3728: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3729: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3730: </dl></dd>
                   3731: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3732: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3733: </dl></dd>
1.90      rillig   3734: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75      rillig   3735: <dd><dl>
1.90      rillig   3736: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   3737: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   3738: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   3739: <dd><dl>
1.93      rillig   3740: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   3741: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   3742: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   3745: </dl></dd>
                   3746: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   3747: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   3748: <dd><dl>
                   3749: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   3750: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   3751: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
                   3752: </dl></dd>
                   3753: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   3754: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
                   3755: </dl></dd>
                   3756: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
                   3757: <dd><dl>
1.97      rillig   3758: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                   3759: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3760: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                   3761: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                   3762: <dd><dl>
                   3763: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                   3764: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                   3765: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                   3767: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90      rillig   3768: </dl></dd>
                   3769: </dl></dd>
                   3770: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
                   3771: <dd><dl>
                   3772: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   3773: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3774: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   3775: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   3776: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3778: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   3779: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
                   3780: </dl></dd>
                   3781: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
                   3782: <dd><dl>
                   3783: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   3784: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3785: <dd><dl>
                   3786: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3787: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   3788: </dl></dd>
                   3789: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3790: <dd><dl>
                   3791: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   3792: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3793: </dl></dd>
                   3794: </dl></dd>
                   3795: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
                   3796: <dd><dl>
                   3797: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
                   3798: <dd><dl>
                   3799: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   3800: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
                   3801: </dl></dd>
                   3802: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
                   3803: <dd><dl>
                   3804: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3805: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   3806: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   3807: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   3808: </dl></dd>
                   3809: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   3810: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3811: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   3812: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   3813: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3814: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   3815: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3816: </dl></dd>
                   3817: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
                   3818: <dd><dl>
                   3819: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   3820: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   3821: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
                   3822: </dl></dd>
                   3823: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
                   3824: <dd><dl>
                   3825: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   3826: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   3827: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   3828: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   3829: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3830: <dd><dl>
                   3831: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   3832: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   3833: </dl></dd>
                   3834: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3835: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3836: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3837: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3838: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3839: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3840: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3841: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3842: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3843: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3844: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   3845: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
                   3846: </dl></dd>
                   3847: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
                   3848: <dd><dl>
                   3849: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3850: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3851: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig   3852: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90      rillig   3853: </dl></dd>
                   3854: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
                   3855: <dd><dl>
                   3856: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
                   3857: <dd><dl>
                   3858: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   3859: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   3860: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   3861: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   3862: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   3866: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3867: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3870: </dl></dd>
                   3871: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3872: <dd><dl>
                   3873: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3874: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3875: </dl></dd>
                   3876: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3877: <dd><dl>
                   3878: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   3879: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3880: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   3881: </dl></dd>
                   3882: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   3883: <dd><dl>
                   3884: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   3885: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   3886: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   3887: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   3888: </dl></dd>
                   3889: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3890: <dd><dl>
                   3891: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3892: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   3893: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   3894: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   3895: </dl></dd>
                   3896: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3897: <dd><dl>
                   3898: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   3899: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100     rillig   3900: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103   ! wiz      3901: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
        !          3902: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
        !          3903: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
        !          3904: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
        !          3905: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
        !          3906: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
        !          3907: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
        !          3908: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
        !          3909: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
        !          3910: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
        !          3911: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
        !          3912: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
        !          3913: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
        !          3914: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
        !          3915: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87      wiz      3916:     emulation</a></span></dt>
1.103   ! wiz      3917: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
        !          3918: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3919: </dl></dd>
1.90      rillig   3920: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3921: </dl></dd>
1.90      rillig   3922: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
                   3923: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77      rillig   3924: <dd><dl>
1.90      rillig   3925: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   3926: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3927: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3928: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   3929: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   3930: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
                   3931: </dl></dd>
                   3932: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
                   3933: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3934: <dd><dl>
                   3935: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3936: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3937: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3938: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     3939: </dl></dd>
1.75      rillig   3940: </dl>
                   3941: </div>
1.77      rillig   3942: </div>
                   3943: <div class="chapter" lang="en">
                   3944: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   3945: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3946: <div class="toc">
                   3947: <p><b>Table of Contents</b></p>
                   3948: <dl>
                   3949: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
                   3950: <dd><dl>
                   3951: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
                   3952: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
                   3953: </dl></dd>
                   3954: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
                   3955: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3956: </dl>
                   3957: </div>
1.77      rillig   3958: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3959: most likely have a URL from where you can download the source
                   3960: code. Starting with this URL, creating a package involves only a
                   3961: few steps.</p>
1.77      rillig   3962: <div class="procedure"><ol type="1">
1.91      rillig   3963: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77      rillig   3964: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3965: category in which you want to place your package. You can also create a
                   3966: directory of your own (maybe called <code class="filename">local</code>). In that
                   3967: category directory, create another directory for your package and change
                   3968: into it.</p></li>
                   3969: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
                   3970: you for a URL. Enter the URL of the distribution file (in most cases a
                   3971: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3972: of your package are created automatically. The distribution file is
                   3973: extracted automatically to fill in some details in the
                   3974: <code class="filename">Makefile</code> that would otherwise have to be done
                   3975: manually.</p></li>
                   3976: <li>
                   3977: <p>Examine the extracted files to determine the dependencies of
                   3978: your package. Ideally, this is mentioned in some
                   3979: <code class="filename">README</code> file, but things may differ. For each of
                   3980: these dependencies, look where it exists in pkgsrc, and if there is a
                   3981: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3982: line to your package <code class="filename">Makefile</code> which includes that
                   3983: file just before the last line. If the
                   3984: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3985: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3986: version of the dependency and where it can be found in pkgsrc. This line
                   3987: should be placed in the third paragraph. If the dependency is only
                   3988: needed for building the package, but not when using it, use
                   3989: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3990: Your package may then look like this:</p>
1.77      rillig   3991: <pre class="programlisting">
1.100     rillig   3992: [...]
1.77      rillig   3993: 
1.100     rillig   3994: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3995: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3996: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3997: 
1.100     rillig   3998: [...]
1.77      rillig   3999: 
1.100     rillig   4000: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   4001: .include "../../devel/glib2/buildlink3.mk"
                   4002: .include "../../mk/bsd.pkg.mk"
1.77      rillig   4003: </pre>
                   4004: </li>
1.91      rillig   4005: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
                   4006: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
                   4007: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
                   4008: --explain</strong></span> or <span><strong class="command">pkglint
                   4009: -e</strong></span>, which outputs additional
                   4010: explanations.</p></li>
                   4011: <li><p>In many cases the package is not yet ready to build. You can
                   4012: find instructions for the most common cases in the next section, <a href="#creating.common" title="9.1. Common types of packages">Section 9.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
                   4013: over there, you can hopefully continue here.</p></li>
                   4014: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
                   4015: directory from the extracted files. Besides these files, a lot of cache
                   4016: files and other system information has been saved in the working
                   4017: directory, which may become wrong after you edited the
                   4018: <code class="filename">Makefile</code>.</p></li>
                   4019: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
                   4020: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 18. Making your package work">Chapter 18, <i>Making your package work</i></a>.</p></li>
                   4021: <li><p>When the package builds fine, the next step is to install
                   4022: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
                   4023: everything works.</p></li>
                   4024: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   4025: contains a list of the files that are installed by the package, is
                   4026: nearly empty. Run <span><strong class="command">bmake print-PLIST
                   4027: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   4028: the file using your preferred text editor to see if the list of
                   4029: files looks plausible.</p></li>
                   4030: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
                   4031: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   4032: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
                   4033: has been registered in the database of installed files, but with an
                   4034: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
                   4035: and <span><strong class="command">bmake install</strong></span> again. Now the package is
                   4036: registered with the list of files from
                   4037: <code class="filename">PLIST</code>.</p></li>
                   4038: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
                   4039: package from the set of installed files.</p></li>
1.77      rillig   4040: </ol></div>
1.91      rillig   4041: <div class="sect1" lang="en">
                   4042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4043: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
                   4044: <div class="sect2" lang="en">
                   4045: <div class="titlepage"><div><div><h3 class="title">
                   4046: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
                   4047: <p>Simple Perl modules are handled automatically by
                   4048: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
                   4049: </div>
                   4050: <div class="sect2" lang="en">
                   4051: <div class="titlepage"><div><div><h3 class="title">
                   4052: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
                   4053: <p>KDE applications should always include
                   4054: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4055: settings that are typical of KDE packages.</p>
                   4056: </div>
                   4057: </div>
                   4058: <div class="sect1" lang="en">
                   4059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4060: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
                   4061: <div class="sect2" lang="en">
                   4062: <div class="titlepage"><div><div><h3 class="title">
                   4063: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   4064: <div class="sect3" lang="en">
                   4065: <div class="titlepage"><div><div><h4 class="title">
                   4066: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
                   4067: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4068: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4069: pkgsrc. As the description says it has to do with the web, the obvious
                   4070: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4071: <pre class="programlisting">
1.100     rillig   4072: <code class="prompt">$</code> mkdir www/nvu
                   4073: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4074: </pre>
                   4075: <p>The web site says that the sources are available as a tar file, so
                   4076: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
                   4077: <pre class="programlisting">
1.100     rillig   4078: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4079: </pre>
                   4080: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4081: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4082: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4083: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4084: <code class="varname">COMMENT</code> fields. Then the package
                   4085: <code class="filename">Makefile</code> looked like that:</p>
                   4086: <pre class="programlisting">
1.100     rillig   4087: # $NetBSD$
                   4088: #
1.91      rillig   4089: 
1.100     rillig   4090: DISTNAME=       nvu-1.0-sources
                   4091: PKGNAME=        nvu-1.0
                   4092: CATEGORIES=     www
                   4093: MASTER_SITES=   http://cvs.nvu.com/download/
                   4094: EXTRACT_SUFX=   .tar.bz2
                   4095: 
                   4096: MAINTAINER=     rillig@NetBSD.org
                   4097: HOMEPAGE=       http://cvs.nvu.com/
                   4098: COMMENT=        Web Authoring System
1.91      rillig   4099: 
1.100     rillig   4100: # url2pkg-marker (please do not remove this line.)
                   4101: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4102: </pre>
                   4103: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4104: source archive:</p>
                   4105: <pre class="programlisting">
1.100     rillig   4106: url2pkg&gt; Running "make makesum" ...
                   4107: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4108: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4109: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4110: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4111: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4112: url2pkg&gt; Running "make extract" ...
                   4113: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4114: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4115: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4116: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4117: ===&gt; Installing dependencies for nvu-1.0
                   4118: ===&gt; Overriding tools for nvu-1.0
                   4119: ===&gt; Extracting for nvu-1.0
                   4120: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4121: 
1.100     rillig   4122: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4123: 
1.100     rillig   4124: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4125: </pre>
                   4126: </div>
                   4127: <div class="sect3" lang="en">
                   4128: <div class="titlepage"><div><div><h4 class="title">
                   4129: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   4130: <p>Now that the package has been extracted, let's see what's inside
                   4131: it. The package has a <code class="filename">README.txt</code>, but that only
                   4132: says something about mozilla, so it's probably useless for seeing what
                   4133: dependencies this package has. But since there is a GNU configure script
                   4134: in the package, let's hope that it will complain about everything it
                   4135: needs.</p>
                   4136: <pre class="programlisting">
1.100     rillig   4137: <code class="prompt">$</code> bmake
                   4138: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4139: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4140: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4141: ===&gt; Patching for nvu-1.0
                   4142: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4143: ===&gt; Configuring for nvu-1.0
                   4144: [...]
                   4145: configure: error: Perl 5.004 or higher is required.
                   4146: [...]
                   4147: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4148: [...]
1.91      rillig   4149: </pre>
                   4150: <p>That worked quite well. So I opened the package Makefile in my
                   4151: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4152: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4153: package have changed now, and since a perl wrapper is automatically
                   4154: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4155: from scratch.</p>
                   4156: <pre class="programlisting">
1.100     rillig   4157: <code class="prompt">$</code> bmake clean
                   4158: ===&gt; Cleaning for nvu-1.0
                   4159: <code class="prompt">$</code> bmake
                   4160: [...]
                   4161: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4162: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4163: [...]
1.91      rillig   4164: </pre>
                   4165: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4166: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4167: <pre class="programlisting">
1.100     rillig   4168: [...]
                   4169: checking for GTK - version &gt;= 1.2.0... no
                   4170: *** Could not run GTK test program, checking why...
                   4171: [...]
1.91      rillig   4172: </pre>
                   4173: <p>Now to the other dependencies. The first question is: Where is the
                   4174: GTK package hidden in pkgsrc?</p>
                   4175: <pre class="programlisting">
1.100     rillig   4176: <code class="prompt">$</code> echo ../../*/gtk*
                   4177: [many packages ...]
                   4178: <code class="prompt">$</code> echo ../../*/gtk
                   4179: ../../x11/gtk
                   4180: <code class="prompt">$</code> echo ../../*/gtk2
                   4181: ../../x11/gtk2
                   4182: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4183: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4184: </pre>
                   4185: <p>The first try was definitely too broad. The second one had exactly
                   4186: one result, which is very good. But there is one pitfall with GNOME
                   4187: packages. Before GNOME 2 had been released, there were already many
                   4188: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4189: packages, the GNOME 2 packages were imported as separate packages, and
                   4190: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4191: whether this was the case here, and indeed it was.</p>
                   4192: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4193: file, adding the dependency is very easy. I just inserted an
                   4194: <code class="literal">.include</code> line before the last line of the package
                   4195: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4196: <pre class="programlisting">
1.100     rillig   4197: [...]
                   4198: .include "../../x11/gtk2/buildlink3.mk"
                   4199: .include "../../mk/bsd.pkg.mk
1.91      rillig   4200: </pre>
                   4201: <p>After another <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span>, the answer
                   4202: was:</p>
                   4203: <pre class="programlisting">
1.100     rillig   4204: [...]
                   4205: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4206: checking for GTK - version &gt;= 1.2.0... no
                   4207: *** Could not run GTK test program, checking why...
                   4208: *** The test program failed to compile or link. See the file config.log for the
                   4209: *** exact error that occured. This usually means GTK was incorrectly installed
                   4210: *** or that you have moved GTK since it was installed. In the latter case, you
                   4211: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4212: configure: error: Test for GTK failed.
                   4213: [...]
1.91      rillig   4214: </pre>
                   4215: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4216: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4217: told me that this package really wanted to have the GNOME 1 version of
                   4218: GTK. If the package had looked for GTK2, it would have looked for
                   4219: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
                   4220: So I changed the <code class="literal">x11/gtk2</code> to
                   4221: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4222: and tried again.</p>
                   4223: <pre class="programlisting">
1.100     rillig   4224: [...]
                   4225: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"   -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include   -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe  -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0   -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
                   4226: In file included from xpidl.c:42:
                   4227: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4228: In file included from xpidl.c:42:
                   4229: xpidl.h:132: error: parse error before "IDL_ns"
                   4230: [...]
1.91      rillig   4231: </pre>
                   4232: <p>The package still does not find all of its dependencies. Now the
                   4233: question is: Which package provides the
                   4234: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4235: <pre class="programlisting">
1.100     rillig   4236: <code class="prompt">$</code> echo ../../*/*idl*
                   4237: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4238: <code class="prompt">$</code> echo ../../*/*IDL*
                   4239: ../../net/libIDL
1.91      rillig   4240: </pre>
                   4241: <p>Let's take the one from the second try. So I included the
                   4242: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4243: again. But the error didn't change. After digging through some of the
                   4244: code, I concluded that the build process of the package was broken and
                   4245: couldn't have ever worked, but since the Mozilla source tree is quite
                   4246: large, I didn't want to fix it. So I added the following to the package
                   4247: <code class="filename">Makefile</code> and tried again:</p>
                   4248: <pre class="programlisting">
1.100     rillig   4249: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4250: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4251: </pre>
                   4252: <p>The latter line is needed because the package expects the library
                   4253: <code class="filename">libIDL.so</code>, but only
                   4254: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4255: wrapper to rewrite that on the fly.</p>
                   4256: <p>The next problem was related to a recent change of the FreeType
                   4257: 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>
                   4258: which patch files were relevant for this issue and copied them to the
                   4259: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4260: patches so that they applied cleanly and retried again. This time,
                   4261: everything worked.</p>
                   4262: </div>
                   4263: <div class="sect3" lang="en">
                   4264: <div class="titlepage"><div><div><h4 class="title">
                   4265: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
                   4266: <pre class="programlisting">
1.100     rillig   4267: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4268: [...]
                   4269: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4270: <code class="prompt">$</code> bmake deinstall
                   4271: <code class="prompt">$</code> bmake install
1.91      rillig   4272: </pre>
                   4273: </div>
                   4274: </div>
                   4275: </div>
1.77      rillig   4276: </div>
1.75      rillig   4277: <div class="chapter" lang="en">
                   4278: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4279: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4280: <div class="toc">
                   4281: <p><b>Table of Contents</b></p>
                   4282: <dl>
1.90      rillig   4283: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
                   4284: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
                   4285: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
                   4286: <dd><dl>
1.93      rillig   4287: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
                   4288: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
                   4289: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
                   4290: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
                   4291: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90      rillig   4292: </dl></dd>
                   4293: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
                   4294: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
                   4295: <dd><dl>
                   4296: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
                   4297: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
                   4298: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4299: </dl></dd>
1.90      rillig   4300: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
                   4301: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   4302: </dl>
                   4303: </div>
1.87      wiz      4304: <p>Whenever you're preparing a package, there are a number of
                   4305: files involved which are described in the following
                   4306: sections.</p>
1.75      rillig   4307: <div class="sect1" lang="en">
                   4308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4309: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
                   4310: </h2></div></div></div>
1.75      rillig   4311: <p>Building, installation and creation of a binary package are all
1.87      wiz      4312:   controlled by the package's <code class="filename">Makefile</code>.
                   4313:   The <code class="filename">Makefile</code> describes various things about
                   4314:   a package, for example from where to get it, how to configure,
                   4315:   build, and install it.</p>
1.76      rillig   4316: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4317:   sections that describe the package.</p>
1.75      rillig   4318: <p>In the first section there are the following variables, which
1.87      wiz      4319:   should appear exactly in the order given here.  The order and
                   4320:   grouping of the variables is mostly historical and has no further
                   4321:   meaning.</p>
1.75      rillig   4322: <div class="itemizedlist"><ul type="disc">
                   4323: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4324:     distribution file to be downloaded from the package's
                   4325:     website.</p></li>
1.75      rillig   4326: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4327:     package, as used by pkgsrc. You only need to provide it if
                   4328:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4329:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4330:     directory name together with the version number. It must match the
                   4331:     regular expression
                   4332:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4333:     starts with a letter or digit, and contains only letters, digits,
                   4334:     dashes, underscores, dots and plus signs.</p></li>
                   4335: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4336:     the package file to create if the <code class="varname">PKGNAME</code>
                   4337:     isn't unique on a SVR4 system. The default is
                   4338:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4339:     <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      4340:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4341:     does not produce an unique package name on a SVR4 system.
                   4342:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4343:     characters.</p></li>
1.75      rillig   4344: <li>
                   4345: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4346:     which the package fits in. You can choose any of the top-level
                   4347:     directories of pkgsrc for it.</p>
1.75      rillig   4348: <p>Currently the following values are available for
1.87      wiz      4349:     <code class="varname">CATEGORIES</code>. If more than
                   4350:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4351: <pre class="programlisting">
1.100     rillig   4352: archivers     cross         geography     meta-pkgs     security
                   4353: audio         databases     graphics      misc          shells
                   4354: benchmarks    devel         ham           multimedia    sysutils
                   4355: biology       editors       inputmethod   net           textproc
                   4356: cad           emulators     lang          news          time
                   4357: chat          finance       mail          parallel      wm
                   4358: comms         fonts         math          pkgtools      www
                   4359: converters    games         mbone         print         x11
                   4360: </pre>
1.75      rillig   4361: </li>
1.81      rillig   4362: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4363:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4364:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4365:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.90      rillig   4366:     <a href="#build.fetch" title="16.5. The fetch phase">Section 16.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4367: </ul></div>
                   4368: <p>The second section contains information about separately
1.87      wiz      4369:   downloaded patches, if any.
                   4370:   </p>
1.75      rillig   4371: <div class="itemizedlist"><ul type="disc">
                   4372: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4373:     Name(s) of additional files that contain distribution patches.
                   4374:     There is no default. pkgsrc will look for them at
                   4375:     <code class="varname">PATCH_SITES</code>.
                   4376:     They will automatically be uncompressed before patching if
                   4377:     the names end with <code class="filename">.gz</code> or
                   4378:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4379: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4380:     Primary location(s) for distribution patch files (see
                   4381:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4382: </ul></div>
                   4383: <p>The third section contains the following variables.
1.87      wiz      4384:   </p>
1.75      rillig   4385: <div class="itemizedlist"><ul type="disc">
                   4386: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87      wiz      4387:     of the person who feels responsible for this package, and who is
                   4388:     most likely to look at problems or questions regarding this
                   4389:     package which have been reported with <a href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
                   4390:     developers should contact the <code class="varname">MAINTAINER</code> before
                   4391:     making major changes to the package. When packaging a new program,
                   4392:     set <code class="varname">MAINTAINER</code> to yourself. If you really can't
                   4393:     maintain the package for future updates, set it to
                   4394:     <code class="email">&lt;<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.75      rillig   4395: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4396:     find more information about the package.</p></li>
1.75      rillig   4397: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4398:     description of the package (should not include the package
                   4399:     name).</p></li>
1.75      rillig   4400: </ul></div>
                   4401: <p>Other variables that affect the build:
1.87      wiz      4402:   </p>
1.75      rillig   4403: <div class="itemizedlist"><ul type="disc"><li>
                   4404: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4405:       interesting distribution files of the package are found. The
                   4406:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4407:       works for most packages.</p>
1.75      rillig   4408: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4409:       (most GNU software does, for instance), but extracts itself in
                   4410:       the current directory, you should set
                   4411:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4412: <p>If a package doesn't create a subdirectory with the
                   4413:       name of <code class="varname">DISTNAME</code> but some different name,
                   4414:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4415:       <code class="filename">${WRKDIR}</code>, for example
                   4416:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4417:       <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   4418: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4419:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4420:       variable. By default, its value is
                   4421:       <code class="filename">work</code>. If you want to use the same
                   4422:       pkgsrc tree for building different kinds of binary packages,
                   4423:       you can change the variable according to your needs. Two
                   4424:       other variables handle common cases of setting
                   4425:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4426:       <code class="varname">OBJHOSTNAME</code> is defined in
                   4427:       <code class="filename">/etc/mk.conf</code>, the first component of
                   4428:       the host's name is attached to the directory name. If
                   4429:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4430:       is attached, which might look like
                   4431:       <code class="filename">work.i386</code> or
                   4432:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4433: </li></ul></div>
                   4434: <p>Please pay attention to the following gotchas:</p>
                   4435: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4436: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4437:       installed in compressed form by the package.  For packages using
                   4438:       BSD-style makefiles which honor MANZ, there is
                   4439:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4440: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4441:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4442:       below).</p></li>
1.103   ! wiz      4443: <li><p>If the package installs any info files, see <a href="#faq.info-files" title="18.6.7. Packages installing info files">Section 18.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4444: </ul></div>
                   4445: </div>
                   4446: <div class="sect1" lang="en">
                   4447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4448: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
                   4449: </h2></div></div></div>
1.76      rillig   4450: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4451:   digest, or checksum, of each distfile needed for the package. This
                   4452:   ensures that the distfiles retrieved from the Internet have not been
                   4453:   corrupted during transfer or altered by a malign force to introduce
                   4454:   a security hole. Due to recent rumor about weaknesses of digest
                   4455:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4456:   message digests, as well as the file size.</p>
1.76      rillig   4457: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4458:   checksums for all the patches found in the
1.90      rillig   4459:   <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a>).</p>
1.76      rillig   4460: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87      wiz      4461:   <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
                   4462:   command.</p>
1.75      rillig   4463: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4464:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87      wiz      4465:   <code class="filename">distinfo</code> file and care should be taken when
                   4466:   upgrading such a package to ensure distfile information is not
                   4467:   lost.</p>
1.75      rillig   4468: </div>
                   4469: <div class="sect1" lang="en">
                   4470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4471: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93      rillig   4472: <p>Many packages still don't work out-of-the box on the various
                   4473:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4474:   patch files are needed to make the package work. These patch files are
                   4475:   found in the <code class="filename">patches/</code> directory.</p>
                   4476: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4477:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   4478:   extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
                   4479:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4480:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4481: <div class="sect2" lang="en">
                   4482: <div class="titlepage"><div><div><h3 class="title">
                   4483: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4484: <p>The <code class="filename">patch-*</code> files should be in
1.87      wiz      4485:   <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4486:   problems. (To force patches to apply with fuzz you can set
                   4487:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4488:   should contain only changes for a single file, and no file should be
1.93      rillig   4489:   patched by more than one patch file. This helps to keep future
                   4490:   modifications simple.</p>
                   4491: <p>Each patch file is structured as follows: In the first line,
                   4492:   there is the RCS Id of the patch itself. The second line should be
                   4493:   empty for aesthetic reasons. After that, there should be a comment for
                   4494:   each change that the patch does. There are a number of standard
                   4495:   cases:</p>
                   4496: <div class="itemizedlist"><ul type="disc">
                   4497: <li><p>Patches that replace the <code class="literal">==</code>
                   4498:   operator for <a href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
                   4499:   should contain a reference to , to avoid
                   4500:   redundant explanations.</p></li>
                   4501: <li><p>Patches for commonly known vulnerabilities should
                   4502:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4503: <li><p>Patches that change source code should mention the
                   4504:   platform and other environment (for example, the compiler) that the
                   4505:   patch is needed for.</p></li>
                   4506: </ul></div>
                   4507: <p>In all other cases, the patch should be commented so that any
                   4508:   developer who knows the code of the application can make some use of
                   4509:   the patch. Special care should be taken for the upstream developers,
                   4510:   since we generally want that they accept our patches, so we have less
                   4511:   work in the future.</p>
                   4512: </div>
                   4513: <div class="sect2" lang="en">
                   4514: <div class="titlepage"><div><div><h3 class="title">
                   4515: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
                   4516: <p>One important thing to mention is to pay attention that no RCS
                   4517:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4518:   later checked into the NetBSD CVS tree. Use the
1.93      rillig   4519:   <span><strong class="command">pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
                   4520:   problems.</p>
1.87      wiz      4521: <p>For even more automation, we recommend using
                   4522:   <span><strong class="command">mkpatches</strong></span> from the same package to make a
                   4523:   whole set of patches. You just have to backup files before you
                   4524:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   4525:   <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
                   4526:   using <span><strong class="command">pkgvi</strong></span> again from the same package. If
                   4527:   you upgrade a package this way, you can easily compare the new
                   4528:   set of patches with the previously existing one with
                   4529:   <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
                   4530:   or update from the <code class="filename">work/.newpatches</code>
                   4531:   directory to <code class="filename">patches/</code>.</p>
                   4532: <p>When you have finished a package, remember to generate
                   4533:   the checksums for the patch files by using the <span><strong class="command">make
1.90      rillig   4534:   makepatchsum</strong></span> command, see <a href="#components.distinfo" title="10.2. distinfo">Section 10.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      4535: <p>When adding a patch that corrects a problem in the
                   4536:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4537:   man pages should go), send the patch as a bug report to the
                   4538:   maintainer.  This benefits non-pkgsrc users of the package,
                   4539:   and usually makes it possible to remove the patch in future
                   4540:   version.</p>
1.101     rillig   4541: <p>The file names of the patch files are usually of the form
                   4542:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4543: </div>
                   4544: <div class="sect2" lang="en">
                   4545: <div class="titlepage"><div><div><h3 class="title">
                   4546: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4547: <p>If you want to share patches between multiple packages
                   4548:   in pkgsrc, e.g. because they use the same distfiles, set
                   4549:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4550:   can be found, e.g.:</p>
                   4551: <pre class="programlisting">
1.100     rillig   4552: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4553: </pre>
1.75      rillig   4554: <p>Patch files that are distributed by the author or other
1.87      wiz      4555:     maintainers can be listed in
                   4556:     <code class="varname">PATCHFILES</code>.</p>
                   4557: <p>If it is desired to store any patches that should not be
                   4558:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4559:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4560:     directory tree there is expected to have the same
                   4561:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4562:     patches are expected to be stored inside these dirs (also
                   4563:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4564:     example, if you want to keep a private patch for
                   4565:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4566:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4567:     files in the named directory are expected to be patch files,
                   4568:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4569:     applied</em></span>.</p>
1.93      rillig   4570: </div>
1.85      jmmv     4571: <div class="sect2" lang="en">
                   4572: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4573: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4574: <p>When fixing a portability issue in the code do not use
                   4575:       preprocessor magic to check for the current operating system nor
                   4576:       platform.  Doing so hurts portability to other platforms because
                   4577:       the OS-specific details are not abstracted appropriately.</p>
                   4578: <p>The general rule to follow is: instead of checking for the
                   4579:       operating system the application is being built on, check for the
                   4580:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4581:       instead of assuming that kqueue is available under NetBSD and
                   4582:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.103   ! wiz      4583:       kqueue support, add a check that detects kqueue itself &#8212;
1.85      jmmv     4584:       yes, this generally involves patching the
                   4585:       <span><strong class="command">configure</strong></span> script.  There is absolutely nothing
                   4586:       that prevents some OSes from adopting interfaces from other OSes
                   4587:       (e.g. Linux implementing kqueue), something that the above checks
                   4588:       cannot take into account.</p>
                   4589: <p>Of course, checking for features generally involves more
                   4590:       work on the developer's side, but the resulting changes are
1.87      wiz      4591:       cleaner and there are chances they will work on many other
1.85      jmmv     4592:       platforms.  Not to mention that there are higher chances of being
                   4593:       later integrated into the mainstream sources.  Remember:
                   4594:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4595: <p>Some typical examples:</p>
                   4596: <div class="table">
1.90      rillig   4597: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91      rillig   4598: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4599: <colgroup>
                   4600: <col>
                   4601: <col>
                   4602: <col>
                   4603: </colgroup>
                   4604: <thead><tr>
                   4605: <th>Where</th>
                   4606: <th>Incorrect</th>
                   4607: <th>Correct</th>
                   4608: </tr></thead>
                   4609: <tbody>
                   4610: <tr>
                   4611: <td>configure script</td>
                   4612: <td>
1.100     rillig   4613: <pre class="programlisting">
                   4614: case ${target_os} in
                   4615: netbsd*) have_kvm=yes ;;
                   4616: *)       have_kvm=no  ;;
                   4617: esac
                   4618: </pre>
1.85      jmmv     4619:              </td>
                   4620: <td>
1.100     rillig   4621: <pre class="programlisting">
                   4622: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4623: </pre>
1.85      jmmv     4624:              </td>
                   4625: </tr>
                   4626: <tr>
                   4627: <td>C source file</td>
                   4628: <td>
1.100     rillig   4629: <pre class="programlisting">
                   4630: #if defined(__NetBSD__)
                   4631: #  include &lt;sys/event.h&gt;
                   4632: #endif
                   4633: </pre>
1.85      jmmv     4634:              </td>
                   4635: <td>
1.100     rillig   4636: <pre class="programlisting">
                   4637: #if defined(HAVE_SYS_EVENT_H)
                   4638: #  include &lt;sys/event.h&gt;
                   4639: #endif
                   4640: </pre>
1.85      jmmv     4641:              </td>
                   4642: </tr>
                   4643: <tr>
                   4644: <td>C source file</td>
                   4645: <td>
1.100     rillig   4646: <pre class="programlisting">
                   4647: int
                   4648: monitor_file(...)
                   4649: {
                   4650: #if defined(__NetBSD__)
                   4651:         int fd = kqueue();
                   4652:         ...
                   4653: #else
                   4654:         ...
                   4655: #endif
                   4656: }
                   4657: </pre>
1.85      jmmv     4658:              </td>
                   4659: <td>
1.100     rillig   4660: <pre class="programlisting">
                   4661: int
                   4662: monitor_file(...)
                   4663: {
                   4664: #if defined(HAVE_KQUEUE)
                   4665:         int fd = kqueue();
                   4666:         ...
                   4667: #else
                   4668:        ...
                   4669: #endif
                   4670: }
                   4671: </pre>
1.85      jmmv     4672:              </td>
                   4673: </tr>
                   4674: </tbody>
1.91      rillig   4675: </table></div>
1.85      jmmv     4676: </div>
1.91      rillig   4677: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85      jmmv     4678:       packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4679:       1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
                   4680:       2</a>).  It summarizes multiple details on how to make
                   4681:       software easier to package; all the suggestions in it were
                   4682:       collected from our experience in pkgsrc work, so they are possibly
                   4683:       helpful when creating patches too.</p>
                   4684: </div>
                   4685: <div class="sect2" lang="en">
                   4686: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   4687: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4688: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4689:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4690:       improvements you do to a package to the mainstream developers.
                   4691:       This is the only way to get their attention on portability issues
                   4692:       and to ensure that future versions can be built out-of-the box on
                   4693:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4694:       the fixes straight from the packaged code.</p>
1.93      rillig   4695: <p>This generally involves cleaning up the patches
                   4696:       (because sometimes the patches that are
1.85      jmmv     4697:       added to pkgsrc are quick hacks), filling bug reports in the
                   4698:       appropriate trackers for the projects and working with the
                   4699:       mainstream authors to accept your changes.  It is
                   4700:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4701:       the packages in pkgsrc are kept simple and thus further changes
                   4702:       can be done without much hassle.</p>
                   4703: <p>Support the idea of free software!</p>
                   4704: </div>
1.75      rillig   4705: </div>
                   4706: <div class="sect1" lang="en">
                   4707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4708: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4709: <div class="variablelist"><dl>
1.76      rillig   4710: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4711: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4712:          any credits where they are due.  Please bear in mind that others do not
                   4713:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4714:          will read everything that you write here.</p></dd>
1.76      rillig   4715: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4716: <dd><p>This file governs the files that are installed on your
                   4717:          system: all the binaries, manual pages, etc. There are other
                   4718:          directives which may be entered in this file, to control the
                   4719:          creation and deletion of directories, and the location of
1.90      rillig   4720:          inserted files.  See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87      wiz      4721:          information.</p></dd>
1.75      rillig   4722: </dl></div>
                   4723: </div>
                   4724: <div class="sect1" lang="en">
                   4725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   4726: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78      rillig   4727: <div class="sect2" lang="en">
                   4728: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4729: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4730: <div class="variablelist"><dl>
1.76      rillig   4731: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75      rillig   4732: <dd><p>This shell script is invoked twice by <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4733:            First time after package extraction and before files are
                   4734:            moved in place, the second time after the files to install
                   4735:            are moved in place. This can be used to do any custom
                   4736:            procedures not possible with @exec commands in
                   4737:            <code class="filename">PLIST</code>. See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
1.90      rillig   4738:            <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.76      rillig   4739: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4740: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4741:            this script's responsibility to clean up any additional messy details
                   4742:            around the package's installation, since all pkg_delete knows is how to
                   4743:            delete the files created in the original distribution.
                   4744:            See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4745:            and <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76      rillig   4746: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4747: <dd>
                   4748: <p>This file is displayed after installation of the package.
1.87      wiz      4749:            Useful for things like legal notices on almost-free
                   4750:            software and hints for updating config files after
                   4751:            installing modules for apache, PHP etc.
                   4752:            Please note that you can modify variables in it easily by using
                   4753:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4754:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4755: <pre class="programlisting">
1.100     rillig   4756: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4757: </pre>
1.75      rillig   4758: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4759:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4760:            performed for <code class="varname">PKGNAME</code>,
                   4761:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4762:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4763:            <code class="varname">X11BASE</code>,
                   4764:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4765:            <code class="varname">ROOT_GROUP</code>, and
                   4766:            <code class="varname">ROOT_GROUP</code>.</p>
                   4767: <p>You can display a different or additional files by
                   4768:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4769:            default is <code class="filename">MESSAGE</code>, if the file
                   4770:            exists.</p>
1.75      rillig   4771: </dd>
1.78      rillig   4772: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4773: <dd><p>FIXME: There is no documentation on the
                   4774:        alternatives framework.</p></dd>
                   4775: </dl></div>
                   4776: </div>
                   4777: <div class="sect2" lang="en">
                   4778: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4779: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4780: <div class="variablelist"><dl>
                   4781: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4782: <dd><p>This file contains arbitrary things that could
                   4783:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4784:        to be used by more than one package. This file should only be
                   4785:        used when the packages that will use the file are known in
                   4786:        advance. For other purposes it is often better to write a
                   4787:        <code class="filename">*.mk</code> file and give it a good name that
                   4788:        describes what it does.</p></dd>
                   4789: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4790: <dd><p>This file contains the dependency information
1.90      rillig   4791:        for the buildlink3 framework (see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4792: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4793: <dd><p>This file contains workarounds for compiler bugs
                   4794:        and similar things. It is included automatically by the pkgsrc
                   4795:        infrastructure, so you don't need an extra
                   4796:        <code class="literal">.include</code> line for
                   4797:        it.</p></dd>
                   4798: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4799: <dd><p>This file contains the code for the
1.90      rillig   4800:        package-specific options (see <a href="#options" title="Chapter 15. Options handling">Chapter 15, <i>Options handling</i></a>) that can be
1.78      rillig   4801:        selected by the user. If a package has only one or two options,
                   4802:        it is equally acceptable to put the code directly into the
                   4803:        <code class="filename">Makefile</code>.</p></dd>
                   4804: </dl></div>
                   4805: </div>
                   4806: <div class="sect2" lang="en">
                   4807: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   4808: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4809: <div class="variablelist"><dl>
                   4810: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4811: <dd><p>These files do not take place in the creation of
                   4812:        a package and thus are purely informative to the package
                   4813:        developer.</p></dd>
                   4814: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4815: <dd><p>This file contains things that need to be done
                   4816:        to make the package even
                   4817:        better.</p></dd>
1.75      rillig   4818: </dl></div>
                   4819: </div>
1.78      rillig   4820: </div>
1.75      rillig   4821: <div class="sect1" lang="en">
                   4822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4823: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
                   4824: </h2></div></div></div>
1.75      rillig   4825: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87      wiz      4826:     unpacked into the directory denoted by
                   4827:     <code class="varname">WRKDIR</code>. It can be removed by running
                   4828:     <span><strong class="command">make clean</strong></span>. Besides the sources, this
                   4829:     directory is also used to keep various timestamp files.
                   4830:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4831:     The default is <code class="filename">${.CURDIR}/work</code>
                   4832:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4833:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4834: </div>
                   4835: <div class="sect1" lang="en">
                   4836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   4837: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
                   4838: </h2></div></div></div>
1.75      rillig   4839: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4840:     to configuration or building, you could place these files here and use
                   4841:     a <span><strong class="command">${CP}</strong></span> command in the
                   4842:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4843:     this. Alternatively, you could simply diff the file against
                   4844:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4845:     the creation of this file.</p>
                   4846: <p>If you want to share files in this way with other
                   4847:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4848:     to the other package's <code class="filename">files</code> directory,
                   4849:     e.g.:</p>
                   4850: <pre class="programlisting">
1.100     rillig   4851: FILESDIR=${.CURDIR}/../xemacs/files
                   4852: </pre>
1.75      rillig   4853: </div>
                   4854: </div>
                   4855: <div class="chapter" lang="en">
                   4856: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   4857: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4858: <div class="toc">
                   4859: <p><b>Table of Contents</b></p>
                   4860: <dl>
1.97      rillig   4861: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
                   4862: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4863: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
                   4864: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
                   4865: <dd><dl>
                   4866: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
                   4867: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
                   4868: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
                   4869: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
                   4870: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4871: </dl></dd>
                   4872: </dl>
                   4873: </div>
1.76      rillig   4874: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4875:   each of which forms a well-defined part of the pkgsrc system. Using
                   4876:   the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
                   4877:   like pkgsrc requires some discipline to keep the code correct and
                   4878:   understandable.</p>
1.76      rillig   4879: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4880:   programming are variables (which are actually macros) and shell
                   4881:   commands. Among these shell commands may even be more complex ones
                   4882:   like <a href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
                   4883:   as intended it is necessary to quote all variables correctly when they
                   4884:   are used.</p>
                   4885: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4886:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4887:   with them.</p>
                   4888: <div class="sect1" lang="en">
                   4889: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97      rillig   4890: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
                   4891: <div class="itemizedlist"><ul type="disc"><li>
                   4892: <p>When you are creating a file as a
                   4893:     target of a rule, always write the data to a temporary file first
                   4894:     and finally rename that file. Otherwise there might occur an error
                   4895:     in the middle of generating the file, and when the user runs
                   4896:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
                   4897:     regenerated properly. Example:</p>
                   4898: <pre class="programlisting">
1.100     rillig   4899: wrong:
                   4900:         @echo "line 1" &gt; ${.TARGET}
                   4901:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4902:         @false
                   4903: 
                   4904: correct:
                   4905:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4906:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4907:         @false
                   4908:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4909: </pre>
                   4910: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
                   4911:     <code class="filename">wrong</code> will exist, although there was an error
                   4912:     message in the first run. On the other hand, running <span><strong class="command">make
                   4913:     correct</strong></span> gives an error message twice, as expected.</p>
                   4914: <p>You might remember that <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
                   4915:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4916:     happens when it is interrupted, for example by pressing
                   4917:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
                   4918:     when one of the commands fails (like <a href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
                   4919: </li></ul></div>
                   4920: </div>
                   4921: <div class="sect1" lang="en">
                   4922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4923: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4924: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4925:     can be processed using the five operators ``='', ``+='', ``?='',
                   4926:     ``:='', and ``!='', which are described in the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
                   4927:     page.</p>
                   4928: <p>When a variable's value is parsed from a
1.76      rillig   4929:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4930:     backslash character ``\'' are handled specially. If a backslash is
                   4931:     followed by a newline, any whitespace immediately in front of the
                   4932:     backslash, the backslash, the newline, and any whitespace
                   4933:     immediately behind the newline are replaced with a single space. A
                   4934:     backslash character and an immediately following hash character are
                   4935:     replaced with a single hash character. Otherwise, the backslash is
                   4936:     passed as is. In a variable assignment, any hash character that is
                   4937:     not preceded by a backslash starts a comment that continues upto the
                   4938:     end of the logical line.</p>
                   4939: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4940:     the only way to create a variable consisting of a single backslash
                   4941:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4942: <p>So far for defining variables. The other thing you can do with
                   4943:     variables is evaluating them. A variable is evaluated when it is
                   4944:     part of the right side of the ``:='' or the ``!='' operator, or
                   4945:     directly before executing a shell command which the variable is part
                   4946:     of. In all other cases, <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
                   4947:     is, variables are not evaluated until there's no other way. The
                   4948:     ``modifiers'' mentioned in the man page also evaluate the
                   4949:     variable.</p>
                   4950: <p>Some of the modifiers split the string into words and then
                   4951:     operate on the words, others operate on the string as a whole. When
                   4952:     a string is split into words, it is split as you would expect
                   4953:     it from <a href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.103   ! wiz      4954: <p>No rule without exception&#8212;the <span><strong class="command">.for</strong></span>
1.75      rillig   4955:     loop does not follow the shell quoting rules but splits at sequences
                   4956:     of whitespace.</p>
                   4957: <p>There are several types of variables that should be handled
                   4958:     differently. Strings and two types of lists.</p>
                   4959: <div class="itemizedlist"><ul type="disc">
                   4960: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4961:       characters. Nevertheless, you should restrict yourself to only
                   4962:       using printable characters. Examples are
                   4963:       <code class="varname">PREFIX</code> and
                   4964:       <code class="varname">COMMENT</code>.</p></li>
                   4965: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4966:       are never exported to any shell command. Their elements are
                   4967:       separated by whitespace. Therefore, the elements themselves cannot
                   4968:       have embedded whitespace. Any other characters are allowed.
                   4969:       Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
                   4970:       Examples are <code class="varname">DEPENDS</code> and
                   4971:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4972: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4973:       may be exported to a shell command. Their elements can contain any
                   4974:       characters, including whitespace. That's why they cannot be used
                   4975:       in <span><strong class="command">.for</strong></span> loops. Examples are
                   4976:       <code class="varname">DISTFILES</code> and
                   4977:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4978: </ul></div>
                   4979: <div class="sect2" lang="en">
                   4980: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   4981: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4982: <div class="itemizedlist"><ul type="disc">
                   4983: <li><p>All variable names starting with an underscore
                   4984:        are reserved for use by the pkgsrc infrastructure. They shall
                   4985:        not be used by package
1.76      rillig   4986:        <code class="filename">Makefile</code>s.</p></li>
1.75      rillig   4987: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
                   4988:        lowercase variable names for the iteration
                   4989:        variables.</p></li>
                   4990: <li><p>All list variables should have a ``plural''
                   4991:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4992:        <code class="varname">DISTFILES</code>.</p></li>
                   4993: </ul></div>
                   4994: </div>
                   4995: </div>
                   4996: <div class="sect1" lang="en">
                   4997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97      rillig   4998: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75      rillig   4999: <p>This section presents you with some code snippets you should
                   5000:     use in your own code. If you don't find anything appropriate here,
                   5001:     you should test your code and add it here.</p>
                   5002: <div class="sect2" lang="en">
                   5003: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5004: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   5005: <pre class="programlisting">
1.100     rillig   5006: STRING=                 foo * bar `date`
                   5007: INT_LIST=               # empty
                   5008: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5009: EXT_LIST=               # empty
                   5010: ANOTHER_EXT_LIST=       a=b c=d
                   5011: 
                   5012: INT_LIST+=              ${STRING}               # 1
                   5013: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5014: EXT_LIST+=              ${STRING:Q}             # 3
                   5015: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    5016: </pre>
1.75      rillig   5017: <p>When you add a string to an external list (example 3), it
                   5018:       must be quoted. In all other cases, you must not add a quoting
                   5019:       level. You must not merge internal and external lists, unless you
                   5020:       are sure that all entries are correctly interpreted in both
                   5021:       lists.</p>
                   5022: </div>
                   5023: <div class="sect2" lang="en">
                   5024: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5025: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   5026: <pre class="programlisting">
1.100     rillig   5027: EXT_LIST=       # empty
                   5028: .for i in ${INT_LIST}
                   5029: EXT_LIST+=      ${i:Q}""
                   5030: .endfor
1.1       grant    5031: </pre>
1.75      rillig   5032: <p>This code converts the internal list
                   5033:       <code class="varname">INT_LIST</code> into the external list
                   5034:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5035:       are unquoted they must be quoted here. The reason for appending
                   5036:       <code class="varname">""</code> is explained below.</p>
                   5037: </div>
                   5038: <div class="sect2" lang="en">
                   5039: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5040: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   5041: <p>Sometimes you may want to print an arbitrary string. There
                   5042:        are many ways to get it wrong and only few that can handle every
                   5043:        nastiness.</p>
1.75      rillig   5044: <pre class="programlisting">
1.100     rillig   5045: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5046: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5047: 
1.100     rillig   5048: all:
                   5049:         echo ${STRING}                  # 1
                   5050:         echo "${STRING}"                # 2
                   5051:         echo "${STRING:Q}"              # 3
                   5052:         echo ${STRING:Q}                # 4
                   5053:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5054:         printf "%s\\n" ${STRING:Q}""    # 6
                   5055:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5056: </pre>
1.75      rillig   5057: <p>Example 1 leads to a syntax error in the shell, as the
                   5058:       characters are just copied.</p>
                   5059: <p>Example 2 leads to a syntax error too, and if you leave out
                   5060:       the last " character from <code class="varname">${STRING}</code>,
                   5061:       <a href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
                   5062:       variable would be evaluated, too.</p>
                   5063: <p>Example 3 outputs each space character preceded by a
                   5064:       backslash (or not), depending on the implementation of the
                   5065:       <a href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
                   5066: <p>Example 4 handles correctly every string that does not start
                   5067:       with a dash. In that case, the result depends on the
                   5068:       implementation of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
                   5069:       guarantee that your input does not start with a dash, this form is
                   5070:       appropriate.</p>
                   5071: <p>Example 5 handles even the case of a leading dash
                   5072:       correctly.</p>
1.79      rillig   5073: <p>Example 6 also works with every string and is the
                   5074:       light-weight solution, since it does not involve a pipe, which has
                   5075:       its own problems.</p>
1.75      rillig   5076: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5077:       because the quoting has already been done when adding elements to
                   5078:       the list.</p>
                   5079: <p>As internal lists shall not be passed to the shell, there is
                   5080:       no example for it.</p>
                   5081: </div>
                   5082: <div class="sect2" lang="en">
                   5083: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5084: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5085: <p>There are many possible sources of wrongly quoted variables.
                   5086:       This section lists some of the commonly known ones.</p>
                   5087: <div class="itemizedlist"><ul type="disc">
                   5088: <li>
                   5089: <p>Whenever you use the value of a list, think
                   5090:        about what happens to leading or trailing whitespace. If the
                   5091:        list is a well-formed shell expression, you can apply the
                   5092:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5093:        whitespace from each word. The <code class="varname">:M</code> operator
                   5094:        first splits its argument according to the rules of the shell,
                   5095:        and then creates a new list consisting of all words that match
                   5096:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5097:        One class of situations where this is needed is when adding a
                   5098:        variable like <code class="varname">CPPFLAGS</code> to
                   5099:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5100:        invokes other configure scripts, it strips the leading and
                   5101:        trailing whitespace from the variable and then passes it to the
                   5102:        other configure scripts. But these configure scripts expect the
                   5103:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5104:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5105:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5106:        here is how we do it:</p>
                   5107: <pre class="programlisting">
1.100     rillig   5108: CPPFLAGS=               # empty
                   5109: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5110: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5111: 
                   5112: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5113: 
                   5114: all:
                   5115:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5116:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5117: </pre>
1.75      rillig   5118: </li>
                   5119: <li><p>The example above contains one bug: The
                   5120:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5121:        expression, but there is the C compiler after it, which also
                   5122:        expects a properly quoted string (this time in C syntax). The
                   5123:        version above is therefore only correct if
                   5124:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5125:        or double quotes. If you want to allow these, you have to add
                   5126:        another layer of quoting to each variable that is used as a C
                   5127:        string literal. You cannot use the <code class="varname">:Q</code>
                   5128:        operator for it, as this operator only works for the
                   5129:        shell.</p></li>
                   5130: <li>
                   5131: <p>Whenever a variable can be empty, the
                   5132:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5133:        are two completely different cases which can be solved with the
                   5134:        same trick.</p>
                   5135: <pre class="programlisting">
1.100     rillig   5136: EMPTY=                  # empty
                   5137: empty_test:
                   5138:         for i in a ${EMPTY:Q} c; do \
                   5139:             echo "$$i"; \
                   5140:         done
                   5141: 
                   5142: for_test:
                   5143: .for i in a:\ a:\test.txt
                   5144:         echo ${i:Q}
                   5145:         echo "foo"
                   5146: .endfor
1.1       grant    5147: </pre>
1.75      rillig   5148: <p>The first example will only print two of the three lines
                   5149:        we might have expected. This is because
                   5150:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5151:        the shell cannot see. The workaround is to write
                   5152:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5153:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5154:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5155: <p>The second example will only print three lines instead of
                   5156:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5157:        This is because the backslash of the value
                   5158:        <code class="varname">a:\</code> is interpreted as a line-continuation by
                   5159:        <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5160:        <a href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
                   5161:        <code class="varname">${i:Q}""</code>.</p>
                   5162: </li>
                   5163: </ul></div>
                   5164: </div>
                   5165: <div class="sect2" lang="en">
                   5166: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig   5167: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5168: <p>The pkgsrc bmake program does not handle the following
                   5169:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5170:       contains a ``-'' character, one of the closing braces is included
                   5171:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5172: <pre class="programlisting">
1.100     rillig   5173: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5174: </pre>
1.75      rillig   5175: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5176:       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   5177:       <code class="varname">bug1</code>.</p>
                   5178: </div>
                   5179: </div>
                   5180: </div>
                   5181: <div class="chapter" lang="en">
                   5182: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5183: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75      rillig   5184: <div class="toc">
                   5185: <p><b>Table of Contents</b></p>
                   5186: <dl>
1.90      rillig   5187: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
                   5188: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5189: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
                   5190: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
                   5191: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
                   5192: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   5193: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
                   5194: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5195: </dl>
                   5196: </div>
1.87      wiz      5197: <p>The <code class="filename">PLIST</code> file contains a package's
                   5198:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5199:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5200:   directory it's been installed in) plus some additional statements
                   5201:   - see the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
                   5202:   This chapter addresses some issues that need attention when
                   5203:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5204:   below!).</p>
1.75      rillig   5205: <div class="sect1" lang="en">
                   5206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5207: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87      wiz      5208: <p>Be sure to add a RCS ID line as the first thing in any
                   5209:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5210: <pre class="programlisting">
1.100     rillig   5211: @comment $NetBSD$
1.87      wiz      5212:     </pre>
1.75      rillig   5213: </div>
                   5214: <div class="sect1" lang="en">
                   5215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5216: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75      rillig   5217: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87      wiz      5218:     to output a PLIST that matches any new files since the package
1.90      rillig   5219:     was extracted.  See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      5220:     more information on this target.</p>
1.75      rillig   5221: </div>
                   5222: <div class="sect1" lang="en">
                   5223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5224: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
                   5225: </h2></div></div></div>
1.87      wiz      5226: <p>If you have used any of the *-dirs packages, as explained in
1.90      rillig   5227:     <a href="#faq.common-dirs" title="12.8. Sharing directories between packages">Section 12.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
1.87      wiz      5228:     <span><strong class="command">make print-PLIST</strong></span> outputs a set of
                   5229:     <code class="varname">@comment</code>s instead of real
                   5230:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5231:     specific directories and files, so that the results of that
                   5232:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5233:     lot</em></span> during the update of packages.</p>
                   5234: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5235:     of AWK patterns and actions that are used to filter the output of
                   5236:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5237:     scripting you like to it, but be careful with quoting.</p>
                   5238: <p>For example, to get all files inside the
                   5239:     <code class="filename">libdata/foo</code> directory removed from the
                   5240:     resulting PLIST:</p>
                   5241: <pre class="programlisting">
1.100     rillig   5242: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5243:     </pre>
                   5244: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5245:     to a specific (shared) directory converted to
                   5246:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5247: <pre class="programlisting">
1.100     rillig   5248: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5249:     </pre>
1.75      rillig   5250: </div>
                   5251: <div class="sect1" lang="en">
                   5252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5253: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5254: <p>A number of variables are substituted automatically in
                   5255:     PLISTs when a package is installed on a system. This includes the
                   5256:     following variables:</p>
1.75      rillig   5257: <div class="variablelist"><dl>
                   5258: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5259: <dd>
                   5260: <p>Some packages like emacs and perl embed information
1.87      wiz      5261:          about which architecture they were built on into the
                   5262:          pathnames where they install their files. To handle this
                   5263:          case, PLIST will be preprocessed before actually used, and
                   5264:          the symbol
                   5265:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
                   5266:          replaced by what <span><strong class="command">uname -p</strong></span> gives. The
                   5267:          same is done if the string
                   5268:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5269:          PLIST somewhere - use this on packages that have GNU
                   5270:          autoconf-created configure scripts.</p>
1.75      rillig   5271: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5272: <h3 class="title">Legacy note</h3>
                   5273: <p>There used to be a symbol
1.87      wiz      5274:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
                   5275:            was replaced by the output of <span><strong class="command">uname
                   5276:            -m</strong></span>, but that's no longer supported and has
                   5277:            been removed.</p>
1.75      rillig   5278: </div>
                   5279: </dd>
                   5280: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5281: <dd>
                   5282: <p>Some packages want to embed the OS name and version
1.87      wiz      5283:          into some paths.  To do this, use these variables in the
                   5284:          <code class="filename">PLIST</code>:
                   5285:          </p>
1.75      rillig   5286: <div class="itemizedlist"><ul type="disc">
                   5287: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span><strong class="command">uname -s</strong></span></span>&#8221;</p></li>
                   5288: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
                   5289: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span><strong class="command">uname -r</strong></span></span>&#8221;</p></li>
                   5290: </ul></div>
                   5291: </dd>
                   5292: </dl></div>
1.87      wiz      5293: <p>For a complete list of values which are replaced by
                   5294:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5295:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5296: <p>If you want to change other variables not listed above, you
                   5297:     can add variables and their expansions to this variable in the
1.90      rillig   5298:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="10.5. Optional files">Section 10.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   5299: <pre class="programlisting">
1.100     rillig   5300: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5301:     </pre>
1.75      rillig   5302: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5303:     in the <code class="filename">PLIST</code> with
                   5304:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.75      rillig   5305: </div>
                   5306: <div class="sect1" lang="en">
                   5307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5308: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75      rillig   5309: <p>Man pages should be installed in compressed form if
1.87      wiz      5310:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5311:     and uncompressed otherwise. To handle this in the
                   5312:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5313:     appended/removed automatically for man pages according to
                   5314:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5315:     or not, see above for details. This modification of the
                   5316:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5317:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5318: </div>
                   5319: <div class="sect1" lang="en">
                   5320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   5321: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   5322: </h2></div></div></div>
1.76      rillig   5323: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5324:     in generating the binary package, set the variable
                   5325:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   5326:     The files are later concatenated using <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
                   5327:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5328:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5329: </div>
                   5330: <div class="sect1" lang="en">
                   5331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5332: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5333: <p>Some packages decide to install a different set of files based on
1.87      wiz      5334:     the operating system being used. These differences can be
                   5335:     automatically handled by using the following files:</p>
1.75      rillig   5336: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5337: <li><p><code class="filename">PLIST.common</code></p></li>
                   5338: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5339: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5340: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5341: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5342: </ul></div>
                   5343: </div>
                   5344: <div class="sect1" lang="en">
                   5345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5346: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5347: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5348:     multiple (and unrelated) packages install files.  These
                   5349:     directories are problematic because you have to add special tricks
                   5350:     in the PLIST to conditionally remove them, or have some
                   5351:     centralized package handle them.</p>
                   5352: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5353:     is shared by a few unrelated packages, it's often not worth to add
                   5354:     an extra package to remove it.  Therefore, one simply does:</p>
                   5355: <pre class="programlisting">
1.100     rillig   5356: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5357:     </pre>
                   5358: <p>in the PLISTs of all affected packages, instead of the
                   5359:     regular "@dirrm" line.</p>
                   5360: <p>However, if the directory is shared across many packages, two
                   5361:     different solutions are available:</p>
1.75      rillig   5362: <div class="orderedlist"><ol type="1">
1.87      wiz      5363: <li><p>If the packages have a common dependency, the directory
                   5364:        can be removed in that.  For example, see
1.91      rillig   5365:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87      wiz      5366:        removes the shared directory
                   5367:        <code class="filename">share/omf</code>.</p></li>
                   5368: <li><p>If the packages using the directory are not related at
                   5369:        all (they have no common dependencies), a *-dirs package is
                   5370:        used.</p></li>
1.75      rillig   5371: </ol></div>
1.87      wiz      5372: <p>From now on, we'll discuss the second solution.  To get an
                   5373:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5374: <pre class="programlisting">
1.100     rillig   5375: <code class="prompt">%</code> cd .../pkgsrc
                   5376: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5377:     </pre>
                   5378: <p>Their use from other packages is very simple.  The
                   5379:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5380:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5381:     version number (always pick the latest one when writing new
                   5382:     packages).</p>
                   5383: <p>For example, if a package installs files under
                   5384:     <code class="filename">share/applications</code>, it should have the
                   5385:     following line in it:</p>
                   5386: <pre class="programlisting">
1.100     rillig   5387: USE_DIRS+=      xdg-1.1
1.87      wiz      5388:     </pre>
                   5389: <p>After regenerating the PLIST using <span><strong class="command">make
                   5390:     print-PLIST</strong></span>, you should get the right (commented out)
                   5391:     lines.</p>
                   5392: <p>Note that even if your package is using
                   5393:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5394:     *-x11-dirs packages.  Just specify the name without that part and
                   5395:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5396:     care of it.</p>
1.75      rillig   5397: </div>
                   5398: </div>
                   5399: <div class="chapter" lang="en">
                   5400: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5401: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75      rillig   5402: <div class="toc">
                   5403: <p><b>Table of Contents</b></p>
                   5404: <dl>
1.90      rillig   5405: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
                   5406: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5407: <dd><dl>
1.90      rillig   5408: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   5409: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5410: </dl></dd>
1.90      rillig   5411: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5412: <dd><dl>
1.90      rillig   5413: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   5414: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5415: </dl></dd>
                   5416: </dl>
                   5417: </div>
                   5418: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5419:   are seen by a package's configure and build processes.  This is implemented
                   5420:   in a two step process:</p>
1.75      rillig   5421: <div class="orderedlist"><ol type="1">
                   5422: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5423:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5424:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5425: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5426:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5427:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5428:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5429:       native compiler on some operating systems look like GCC, so that
                   5430:       packages that expect GCC won't require modifications to build with
                   5431:       those native compilers.</p></li>
1.75      rillig   5432: </ol></div>
                   5433: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5434:   package may be built consistently despite what other software may be
                   5435:   installed. Please note that the normal system header and library paths,
                   5436:   e.g. <code class="filename">/usr/include</code>,
                   5437:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5438:   designed to insulate the package build from non-system-supplied
                   5439:   software.</p>
1.75      rillig   5440: <div class="sect1" lang="en">
                   5441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5442: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5443: <p>The process of converting packages to use the buildlink3
1.87      wiz      5444:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5445:     The things to keep in mind are:</p>
1.75      rillig   5446: <div class="orderedlist"><ol type="1">
1.87      wiz      5447: <li><p>Ensure that the build always calls the wrapper scripts
                   5448:        instead of the actual toolchain.  Some packages are tricky,
                   5449:        and the only way to know for sure is the check
                   5450:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5451:        wrappers are being invoked.</p></li>
                   5452: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5453:        the package Makefile, e.g. Java VMs, standalone shells,
                   5454:        etc., because the code to symlink files into
                   5455:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5456:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5457:        </p></li>
                   5458: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5459:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5460:        package's Makefile are added as dependencies for that package.
                   5461:        </p></li>
1.75      rillig   5462: </ol></div>
1.87      wiz      5463: <p>If a dependency on a particular package is required for its libraries and
                   5464:     headers, then we replace:</p>
1.75      rillig   5465: <pre class="programlisting">
1.100     rillig   5466: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5467: </pre>
1.75      rillig   5468: <p>with</p>
                   5469: <pre class="programlisting">
1.100     rillig   5470: .include "../../category/foo/buildlink3.mk"
                   5471: </pre>
1.75      rillig   5472: <p>The buildlink3.mk files usually define the required dependencies.
                   5473:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5474:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5475: <pre class="programlisting">
1.100     rillig   5476: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5477: .include "../../category/foo/buildlink3.mk"
                   5478: </pre>
1.76      rillig   5479: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5480:     files in <code class="filename">pkgsrc/mk</code>
                   5481:     that handle special package issues:</p>
1.75      rillig   5482: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5483: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5484:        the native or a pkgsrc Berkeley DB implementation based on
                   5485:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5486:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5487: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5488:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5489:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76      rillig   5490: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5491:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5492:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5493:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5494: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5495:        system-provided Motif installation or adds a dependency on
1.91      rillig   5496:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.88      wiz      5497:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5498:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5499:        which Motif version will be used.</p></li>
1.76      rillig   5500: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5501:        variables that may be used by packages that use the
                   5502:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5503: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5504:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5505:        the file for more information.</p></li>
1.76      rillig   5506: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5507:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5508:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76      rillig   5509: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5510:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5511:        library.</p></li>
1.75      rillig   5512: </ul></div>
1.76      rillig   5513: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5514:     files provide a more complete
                   5515:     description of how to use them properly.</p>
1.75      rillig   5516: </div>
                   5517: <div class="sect1" lang="en">
                   5518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5519: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87      wiz      5520: <p>A package's <code class="filename">buildlink3.mk</code> file is
                   5521:     included by Makefiles to indicate the need to compile and link
                   5522:     against header files and libraries provided by the package.  A
                   5523:     <code class="filename">buildlink3.mk</code> file should always provide
                   5524:     enough information to add the correct type of dependency
                   5525:     relationship and include any other
                   5526:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5527:     headers and libraries that it needs in turn.</p>
                   5528: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5529:     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      5530:     package is highly recommended.  For most packages, the following
                   5531:     command will generate a good starting point for
                   5532:     <code class="filename">buildlink3.mk</code> files:</p>
                   5533: <pre class="screen">
                   5534: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5535: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5536:     </pre>
1.75      rillig   5537: <div class="sect2" lang="en">
                   5538: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5539: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5540: <p>The following real-life example
1.87      wiz      5541:       <code class="filename">buildlink3.mk</code> is taken
                   5542:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5543: <pre class="programlisting">
1.100     rillig   5544: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5545: 
1.100     rillig   5546: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5547: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5548: 
1.100     rillig   5549: .if ${BUILDLINK_DEPTH} == "+"
                   5550: BUILDLINK_DEPENDS+=     tiff
                   5551: .endif
1.87      wiz      5552: 
1.100     rillig   5553: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5554: BUILDLINK_PACKAGES+=    tiff
1.87      wiz      5555: 
1.100     rillig   5556: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5557: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5558: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5559: .endif  # TIFF_BUILDLINK3_MK
1.87      wiz      5560: 
1.100     rillig   5561: .include "../../devel/zlib/buildlink3.mk"
                   5562: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      5563: 
1.100     rillig   5564: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5565: </pre>
1.87      wiz      5566: <p>The header and footer manipulate
                   5567:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5568:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5569:       at what depth we are including
                   5570:       <code class="filename">buildlink3.mk</code> files.</p>
                   5571: <p>The first section controls if the dependency on
                   5572:       <em class="replaceable"><code>pkg</code></em> is added.
                   5573:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5574:       packages for which dependencies are added by
                   5575:       buildlink3.</p>
                   5576: <p>The second section advises pkgsrc that the
                   5577:       <code class="filename">buildlink3.mk</code> file for
                   5578:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5579:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5580:       packages for which <code class="filename">buildlink3.mk</code> files
                   5581:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5582:       appended to within a <code class="filename">buildlink3.mk</code>
                   5583:       file.</p>
                   5584: <p>The third section is protected from multiple inclusion
                   5585:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5586:       added.  Several important variables are set in the section:</p>
                   5587: <div class="itemizedlist"><ul type="disc">
                   5588: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5589:          is the actual dependency recorded in the installed
                   5590:          package; this should always be set using
                   5591:          <span><strong class="command">+=</strong></span> to ensure that
                   5592:          we're appending to any pre-existing list of values.  This
                   5593:          variable should be set to the first version of the
                   5594:          package that had an API change.
                   5595:          </p></li>
                   5596: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5597:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5598:          pkgsrc directory.</p></li>
                   5599: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5600:          (not shown above) controls whether we use
                   5601:          <code class="varname">BUILD_DEPENDS</code> or
                   5602:          <code class="varname">DEPENDS</code> to add the dependency on
                   5603:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5604:          selected by setting
                   5605:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5606:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5607:          used.</p></li>
                   5608: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5609:            and
                   5610:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5611:            (not shown above) are lists of subdirectories of
1.76      rillig   5612:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5613:            to add to the header and library search paths.  These
                   5614:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5615:          respectively.</p></li>
                   5616: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5617:            (not shown above) is the list of preprocessor flags to add
                   5618:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5619:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5620:            should be avoided and instead be handled using
                   5621:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5622:          above.</p></li>
1.75      rillig   5623: </ul></div>
1.87      wiz      5624: <p>The following variables are all optionally defined within
                   5625:       this second section (protected against multiple inclusion) and
                   5626:       control which package files are symlinked into
                   5627:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5628:       transformed during the symlinking:</p>
1.75      rillig   5629: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5630: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5631:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5632:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5633:            to be symlinked into
1.76      rillig   5634:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5635:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5636: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5637:            (not shown above) is a shell pipeline that
                   5638:            outputs to stdout a list of files relative to
                   5639:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5640:            The resulting files are to be symlinked
                   5641:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5642:            this takes the <code class="filename">+CONTENTS</code> of a
                   5643:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5644:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5645: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5646:            (not shown above) is a filter command that filters
1.76      rillig   5647:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5648:            relative to
1.76      rillig   5649:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5650:            on stdout.  By default for overwrite packages,
                   5651:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5652:            outputs the contents of the <code class="filename">include</code>
                   5653:            and <code class="filename">lib</code> directories in the package
                   5654:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5655:            it outputs any libtool archives in
1.87      wiz      5656:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5657: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5658:            (not shown above) is a list of sed arguments used to
                   5659:            transform the name of the source filename into a
                   5660:            destination filename, e.g. <span><strong class="command">-e
1.87      wiz      5661:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5662: </ul></div>
1.87      wiz      5663: <p>The last section includes any
                   5664:       <code class="filename">buildlink3.mk</code> needed for
                   5665:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5666:       Including these <code class="filename">buildlink3.mk</code> files
                   5667:       means that the headers and libraries for these
                   5668:       dependencies are also symlinked into
                   5669:       <code class="filename">${BUILDLINK_DIR}</code>
                   5670:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5671:       <code class="filename">buildlink3.mk</code>
                   5672:       file is included.</p>
1.75      rillig   5673: </div>
                   5674: <div class="sect2" lang="en">
                   5675: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5676: <a name="updating-buildlink-depends"></a>13.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87      wiz      5677: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5678:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5679:        after a package update is when the API or interface to the
1.87      wiz      5680:       header files change.</p>
                   5681: <p>In this case,
                   5682:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5683:       should be adjusted to require at least the new package
                   5684:       version.  In some cases, the packages that depend on this new
                   5685:       version may need their <code class="varname">PKGREVISION</code>s
                   5686:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5687:       files, their
                   5688:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5689:       adjusted, too.  This is needed so pkgsrc will require the
                   5690:       correct package dependency and not settle for an older one
                   5691:       when building the source.</p>
                   5692: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5693:        should be increased when the binary interface or sonames
                   5694:        (major number of the library version) of any installed
                   5695:        shared libraries change.  This is needed so that binary
                   5696:        packages made using it will require the correct package
                   5697:        dependency and not settle for an older one which will not
1.87      wiz      5698:       contain the necessary shared libraries.</p>
1.90      rillig   5699: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5700:        more information about dependencies on other packages,
                   5701:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5702:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5703: <p>Please take careful consideration before adjusting
                   5704:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5705:       or
                   5706:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5707:       as we don't want to cause unneeded package deletions and
                   5708:       rebuilds.  In many cases, new versions of packages work just
                   5709:       fine with older dependencies.</p>
                   5710: <p>Also it is not needed to set
1.75      rillig   5711:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5712:        when it is identical to
1.87      wiz      5713:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5714: </div>
                   5715: </div>
                   5716: <div class="sect1" lang="en">
                   5717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5718: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5719: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5720:       coincide with headers and libraries present in the base system.
1.76      rillig   5721:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5722:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5723:       file that includes the necessary checks to decide whether using
                   5724:       the built-in software or the pkgsrc software is
1.87      wiz      5725:     appropriate.</p>
                   5726: <p>The only requirements of a builtin.mk file for
                   5727:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5728: <div class="orderedlist"><ol type="1">
1.87      wiz      5729: <li><p>It should set
                   5730:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5731:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5732:        after it is included.</p></li>
                   5733: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5734:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5735:        which is already set before the
                   5736:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5737: <li><p>It should be written to allow multiple inclusion.  This
                   5738:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5739:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5740: </ol></div>
                   5741: <div class="sect2" lang="en">
                   5742: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5743: <a name="anatomy-of-builtin.mk"></a>13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5744: <p>The following is the recommended template for builtin.mk
1.87      wiz      5745:       files:</p>
1.75      rillig   5746: <pre class="programlisting">
1.100     rillig   5747: .if !defined(IS_BUILTIN.foo)
                   5748: #
                   5749: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5750: # genuinely exists in the system or not.
                   5751: #
                   5752: IS_BUILTIN.foo?=        no
                   5753: 
                   5754: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5755: # version can be determined.
                   5756: #
                   5757: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5758: BUILTIN_PKG.foo?=       foo-1.0
                   5759: .  endif
                   5760: .endif  # IS_BUILTIN.foo
                   5761: 
                   5762: .if !defined(USE_BUILTIN.foo)
                   5763: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5764: .  if defined(BUILTIN_PKG.foo)
                   5765: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5766: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5767: USE_BUILTIN.foo!=                                                       \
                   5768:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5769:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5770: .      endif
                   5771: .    endfor
                   5772: .  endif
                   5773: .endif  # USE_BUILTIN.foo
                   5774: 
                   5775: CHECK_BUILTIN.foo?=     no
                   5776: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5777: #
                   5778: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5779: # "yes" or "no".
                   5780: #
                   5781: .endif  # CHECK_BUILTIN.foo
                   5782: </pre>
1.87      wiz      5783: <p>The first section sets
                   5784:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5785:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5786:       in the base system.  This should not be a base system software
                   5787:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5788:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5789:       included as part of the base system.  This variable is only
                   5790:       used internally within the <code class="filename">builtin.mk</code>
                   5791:       file.</p>
                   5792: <p>The second section sets
                   5793:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5794:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5795:       system if it exists (if
                   5796:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5797:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5798:       within the <code class="filename">builtin.mk</code> file.</p>
                   5799: <p>The third section sets
                   5800:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5801:       and is <span class="emphasis"><em>required</em></span> in all
                   5802:       <code class="filename">builtin.mk</code> files.  The code in this
                   5803:       section must make the determination whether the built-in
                   5804:       software is adequate to satisfy the dependencies listed in
                   5805:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5806:       This is typically done by comparing
                   5807:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5808:       against each of the dependencies in
                   5809:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5810:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5811:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5812:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5813:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5814:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5815:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5816:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5817:       that the built-in version of the software is similar enough to
                   5818:       be used as a replacement.</p>
                   5819: <p>The last section is guarded by
                   5820:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5821:       and includes code that uses the value of
                   5822:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5823:       set in the previous section.  This typically includes, e.g.,
                   5824:       adding additional dependency restrictions and listing additional
                   5825:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5826:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5827: </div>
                   5828: <div class="sect2" lang="en">
                   5829: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5830: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5831: <p>When building packages, it's possible to choose whether to set
                   5832:        a global preference for using either the built-in (native)
                   5833:        version or the pkgsrc version of software to satisfy a
                   5834:        dependency.  This is controlled by setting
                   5835:        <code class="varname">PREFER_PKGSRC</code> and
                   5836:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5837:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5838:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5839:        use the pkgsrc versions of software, while
                   5840:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5841:        built-in versions.  Preferences are determined by the most
                   5842:        specific instance of the package in either
                   5843:        <code class="varname">PREFER_PKGSRC</code> or
                   5844:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5845:        in neither or in both variables, then
                   5846:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5847:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5848:        using pkgsrc versions of software for all but the most basic
                   5849:       bits on a NetBSD system, you can set:</p>
                   5850: <pre class="programlisting">
1.100     rillig   5851: PREFER_PKGSRC=  yes
                   5852: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5853: </pre>
1.87      wiz      5854: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5855:       <code class="filename">builtin.mk</code>
                   5856:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5857:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5858: </div>
                   5859: </div>
                   5860: </div>
                   5861: <div class="chapter" lang="en">
                   5862: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   5863: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75      rillig   5864: <div class="toc">
                   5865: <p><b>Table of Contents</b></p>
                   5866: <dl>
1.90      rillig   5867: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5868: <dd><dl>
1.90      rillig   5869: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
                   5870: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75      rillig   5871: </dl></dd>
1.90      rillig   5872: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75      rillig   5873: <dd><dl>
1.90      rillig   5874: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5875: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
                   5876: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
                   5877: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
                   5878: </dl></dd>
                   5879: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
                   5880: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5881: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
                   5882: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
                   5883: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5884: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
                   5885: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5886: </dl>
                   5887: </div>
                   5888: <p>This chapter describes the framework known as
                   5889: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5890: <div class="itemizedlist"><ul type="disc">
                   5891: <li><p>Generic installation and manipulation of directories and files
                   5892:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5893: <li><p>Automatic handling of configuration files during installation,
                   5894:     provided that packages are correctly designed.</p></li>
                   5895: <li><p>Generation and installation of system startup scripts.</p></li>
                   5896: <li><p>Registration of system users and groups.</p></li>
                   5897: <li><p>Registration of system shells.</p></li>
                   5898: <li><p>Automatic updating of fonts databases.</p></li>
                   5899: </ul></div>
                   5900: <p>The following sections inspect each of the above points in detail.</p>
                   5901: <p>You may be thinking that many of the things described here could be
                   5902: easily done with simple code in the package's post-installation target
                   5903: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5904: as the code in them is only executed when building from source.  Machines
                   5905: using binary packages could not benefit from it at all (as the code itself
                   5906: could be unavailable).  Therefore, the only way to achieve any of the items
                   5907: described above is by means of the installation scripts, which are
                   5908: automatically generated by pkginstall.</p>
                   5909: <div class="sect1" lang="en">
                   5910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   5911: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5912: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5913: of files and directories that belong to a package.  The names used in it
1.76      rillig   5914: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5915: which means that it cannot register files outside this directory (absolute
                   5916: path names are not allowed).  Despite this restriction, some packages need
                   5917: to install files outside this location; e.g., under
1.76      rillig   5918: <code class="filename">${VARBASE}</code> or
1.87      wiz      5919: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5920: is to create such files during installation time by using
                   5921: installation scripts.</p>
                   5922: <p>The generic installation scripts are shell scripts that can
                   5923: contain arbitrary code.  The list of scripts to execute is taken from
                   5924: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5925: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5926: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5927: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5928: commands, so they have the potential to create and manage files
                   5929: anywhere in the file system.</p>
                   5930: <p>Using these general installation files is not recommended, but
                   5931: may be needed in some special cases.  One reason for avoiding them is
                   5932: that the user has to trust the packager that there is no unwanted or
                   5933: simply erroneous code included in the installation script. Also,
                   5934: previously there were many similar scripts for the same functionality,
                   5935: and fixing a common error involved finding and changing all of
                   5936: them.</p>
                   5937: <p>The pkginstall framework offers another, standardized way.  It
                   5938: provides generic scripts to abstract the manipulation of such files
                   5939: and directories based on variables set in the package's
                   5940: <code class="filename">Makefile</code>.  The rest of this section describes
                   5941: these variables.</p>
1.75      rillig   5942: <div class="sect2" lang="en">
                   5943: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5944: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5945: <p>The following variables can be set to request the creation of
                   5946: directories anywhere in the file system:</p>
                   5947: <div class="itemizedlist"><ul type="disc">
                   5948: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5949:     contain a list of directories that should be created and should attempt
                   5950:     to be destroyed by the installation scripts.  The difference between
                   5951:     the two is that the latter prompts the administrator to remove any
                   5952:     directories that may be left after deinstallation (because they were
                   5953:     not empty), while the former does not.</p></li>
                   5954: <li>
                   5955: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5956:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5957:     which directories should be created and should attempt to be destroyed
                   5958:     by the installation scripts.  Each tuple holds the following values,
                   5959:     separated by spaces: the directory name, its owner, its group and its
                   5960:     numerical mode.  For example:</p>
                   5961: <pre class="programlisting">
1.100     rillig   5962: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5963: </pre>
1.75      rillig   5964: <p>The difference between the two is exactly the same as their
                   5965:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5966: </li>
                   5967: </ul></div>
                   5968: </div>
                   5969: <div class="sect2" lang="en">
                   5970: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   5971: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5972: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5973: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5974: To overcome this problem, the only solution is to extract the file in the
                   5975: known place (i.e., inside the installation prefix) and copy it to the
                   5976: appropriate location during installation (done by the installation scripts
                   5977: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5978: file</em></span> in the following paragraphs, which describe the variables
                   5979: that can be used to automatically and consistently handle files outside the
                   5980: installation prefix:</p>
                   5981: <div class="itemizedlist"><ul type="disc">
                   5982: <li>
                   5983: <p><code class="varname">CONF_FILES</code> and
                   5984:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5985:     During installation time, the master file is copied to the target one
                   5986:     if and only if the latter does not exist.  Upon deinstallation, the
                   5987:     target file is removed provided that it was not modified by the
                   5988:     installation.</p>
                   5989: <p>The difference between the two is that the latter prompts the
                   5990:     administrator to remove any files that may be left after
                   5991:     deinstallation (because they were not empty), while the former does
                   5992:     not.</p>
                   5993: </li>
                   5994: <li>
                   5995: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5996:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5997:     files as well as their target locations.  For each of them, it also
                   5998:     specifies their owner, their group and their numeric permissions, in
                   5999:     this order.  For example:</p>
                   6000: <pre class="programlisting">
1.100     rillig   6001: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6002: </pre>
1.75      rillig   6003: <p>The difference between the two is exactly the same as their
                   6004:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6005: </li>
                   6006: </ul></div>
                   6007: </div>
                   6008: </div>
                   6009: <div class="sect1" lang="en">
                   6010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6011: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75      rillig   6012: <p>Configuration files are special in the sense that they are installed
                   6013: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6014: need special treatment during installation (most of which is automated by
                   6015: pkginstall).  The main concept you must bear in mind is that files marked
                   6016: as configuration files are automatically copied to the right place (somewhere
                   6017: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6018: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6019: be removed if they have local modifications.  This ensures that
                   6020: administrators never lose any custom changes they may have made.</p>
                   6021: <div class="sect2" lang="en">
                   6022: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6023: <a name="conf-files-sysconfdir"></a>14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   6024: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6025: specifies where configuration files shall be installed.  Its contents are
                   6026: set based upon the following variables:</p>
                   6027: <div class="itemizedlist"><ul type="disc">
                   6028: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   6029:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   6030:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   6031:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   6032:     Packages must not use it directly.</p></li>
                   6033: <li>
                   6034: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6035:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6036:     for the package being built shall be installed.  The definition of this
                   6037:     variable only makes sense in the package's
1.76      rillig   6038:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   6039: <p>As an example, consider the Apache package,
1.91      rillig   6040:     <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   6041:     configuration files under the
1.76      rillig   6042:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6043:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6044:     Makefile.</p>
                   6045: </li>
                   6046: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6047:     variable that holds this package's configuration directory (if
                   6048:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6049:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6050:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6051: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6052:     directory where the configuration files for the package identified by
                   6053:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6054: </ul></div>
                   6055: <p>Based on the above variables, pkginstall determines the value of
                   6056: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6057: variable that can be used within a package to refer to its configuration
                   6058: directory.  The algorithm used to set its value is basically the
                   6059: following:</p>
                   6060: <div class="orderedlist"><ol type="1">
                   6061: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6062:     its value is used.</p></li>
                   6063: <li><p>If the previous variable is not defined but
                   6064:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6065:     <code class="filename">Makefile</code>, the resulting value is
                   6066:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   6067: <li><p>Otherwise, it is set to
1.76      rillig   6068:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6069: </ol></div>
1.76      rillig   6070: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90      rillig   6071: automatically added to <code class="filename">OWN_DIRS</code>.  See <a href="#dirs-outside-prefix" title="14.1.1. Directory manipulation">Section 14.1.1, &#8220;Directory manipulation&#8221;</a> what this means.</p>
1.75      rillig   6072: </div>
                   6073: <div class="sect2" lang="en">
                   6074: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6075: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6076: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6077: known place, you need to teach each package where it shall install its
                   6078: files.  In some cases you will have to patch the package Makefiles to
                   6079: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6080: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6081: generated files:</p>
                   6082: <pre class="programlisting">
1.100     rillig   6083: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6084: </pre>
1.75      rillig   6085: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6086: for</em></span> its configuration files, not where they will be originally
                   6087: installed (although the difference is never explicit,
                   6088: unfortunately).</p>
                   6089: </div>
                   6090: <div class="sect2" lang="en">
                   6091: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6092: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6093: <p>As said before, pkginstall automatically handles configuration files.
                   6094: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6095: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6096: directly</strong></span>.  Bad news is that many software installation scripts
                   6097: will, out of the box, mess with the contents of that directory.  So what is
                   6098: the correct procedure to fix this issue?</p>
                   6099: <p>You must teach the package (usually by manually patching it) to
                   6100: install any configuration files under the examples hierarchy,
1.76      rillig   6101: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6102: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6103: has the original copies available.</p>
                   6104: <p>Once the required configuration files are in place (i.e., under the
                   6105: examples hierarchy), the pkginstall framework can use them as master copies
                   6106: during the package installation to update what is in
1.76      rillig   6107: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6108: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90      rillig   6109: used.  Check out <a href="#files-outside-prefix" title="14.1.2. File manipulation">Section 14.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   6110: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6111: <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   6112: <pre class="programlisting">
1.100     rillig   6113: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6114: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6115: </pre>
1.75      rillig   6116: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6117: package and has no meaning outside it.</p>
                   6118: </div>
                   6119: <div class="sect2" lang="en">
                   6120: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6121: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6122: <p>The automatic copying of config files can be toggled by setting the
                   6123: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6124: installation.</p>
                   6125: </div>
                   6126: </div>
                   6127: <div class="sect1" lang="en">
                   6128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6129: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75      rillig   6130: <p>System startup scripts are special files because they must be
                   6131: installed in a place known by the underlying OS, usually outside the
1.90      rillig   6132: installation prefix.  Therefore, the same rules described in <a href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   6133: can be used.  However, pkginstall provides a special mechanism to handle
                   6134: these files.</p>
                   6135: <p>In order to provide system startup scripts, the package has
                   6136: to:</p>
                   6137: <div class="orderedlist"><ol type="1">
1.76      rillig   6138: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6139:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6140:     <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   6141:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6142: <li>
                   6143: <p>Tell pkginstall to handle it, appending the name of the script,
                   6144:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6145:     Continuing the previous example:</p>
                   6146: <pre class="programlisting">
1.100     rillig   6147: RCD_SCRIPTS+=   cupsd
1.1       grant    6148: </pre>
1.75      rillig   6149: </li>
                   6150: </ol></div>
                   6151: <p>Once this is done, pkginstall will do the following steps for each
                   6152: script in an automated fashion:</p>
                   6153: <div class="orderedlist"><ol type="1">
                   6154: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6155:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6156:     variable.</p></li>
                   6157: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6158:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6159:     that this master file must be explicitly registered in the
1.76      rillig   6160:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6161: <li><p>Add code to the installation scripts to copy the startup script
                   6162:     from the examples hierarchy into the system-wide startup scripts
                   6163:     directory.</p></li>
                   6164: </ol></div>
                   6165: <div class="sect2" lang="en">
                   6166: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6167: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6168: <p>The automatic copying of config files can be toggled by setting the
                   6169: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6170: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6171: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6172: matter what the value of this variable is.</p>
                   6173: </div>
                   6174: </div>
                   6175: <div class="sect1" lang="en">
                   6176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6177: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75      rillig   6178: <p>If a package needs to create special users and/or groups during
                   6179: installation, it can do so by using the pkginstall framework.</p>
                   6180: <p>Users can be created by adding entries to the
                   6181: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6182: syntax:</p>
                   6183: <pre class="programlisting">
1.100     rillig   6184: user:group
1.1       grant    6185: </pre>
1.87      wiz      6186: <p>Further specification of user details may be done by setting
                   6187: per-user variables.
                   6188: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6189: numeric UID for the user.
                   6190: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6191: user's description or comment.
                   6192: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6193: user's home directory, and defaults to
                   6194: <code class="filename">/nonexistent</code> if not specified.
                   6195: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6196: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6197: not specified.</p>
1.75      rillig   6198: <p>Similarly, groups can be created by adding entries to the
                   6199: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6200: <pre class="programlisting">
1.100     rillig   6201: group
1.1       grant    6202: </pre>
1.93      rillig   6203: <p>The numeric GID of the group may be set by defining
1.75      rillig   6204: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6205: <p>If a package needs to create the users and groups at an earlier
                   6206: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6207: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6208: indicate the phase before which the users and groups are created.  In
                   6209: this case, the numeric UIDs and GIDs of the created users and groups
                   6210: are automatically hardcoded into the final installation scripts.</p>
                   6211: </div>
                   6212: <div class="sect1" lang="en">
                   6213: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6214: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75      rillig   6215: <p>Packages that install system shells should register them in the shell
1.76      rillig   6216: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6217: administrator.  This must be done from the installation scripts to keep
                   6218: binary packages working on any system.  pkginstall provides an easy way to
                   6219: accomplish this task.</p>
                   6220: <p>When a package provides a shell interpreter, it has to set the
                   6221: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6222: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6223: 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   6224: <pre class="programlisting">
1.100     rillig   6225: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6226: </pre>
1.75      rillig   6227: <div class="sect2" lang="en">
                   6228: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6229: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6230: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6231: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6232: environment variable to <code class="literal">NO</code>.</p>
                   6233: </div>
                   6234: </div>
                   6235: <div class="sect1" lang="en">
                   6236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6237: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75      rillig   6238: <p>Packages that install X11 fonts should update the database files
                   6239: that index the fonts within each fonts directory.  This can easily be
                   6240: accomplished within the pkginstall framework.</p>
                   6241: <p>When a package installs X11 fonts, it must list the directories in
                   6242: which fonts are installed in the
                   6243: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6244: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6245: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6246: installation scripts to run the appropriate commands to update the fonts
                   6247: database files within each of those directories.  For convenience, if the
                   6248: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6249: 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   6250: <pre class="programlisting">
1.100     rillig   6251: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6252: </pre>
1.75      rillig   6253: <div class="sect2" lang="en">
                   6254: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6255: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6256: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6257: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6258: environment variable to <code class="literal">NO</code>.</p>
                   6259: </div>
                   6260: </div>
                   6261: </div>
                   6262: <div class="chapter" lang="en">
                   6263: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6264: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75      rillig   6265: <div class="toc">
                   6266: <p><b>Table of Contents</b></p>
                   6267: <dl>
1.90      rillig   6268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
                   6269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   6270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75      rillig   6271: </dl>
                   6272: </div>
                   6273: <p>Many packages have the ability to be built to support different
1.76      rillig   6274: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6275: in pkgsrc that provides generic handling of those options that
                   6276: determine different ways in which the packages can be built.  It's
                   6277: possible for the user to specify exactly which sets of options will be
                   6278: built into a package or to allow a set of global default options
                   6279: apply.</p>
                   6280: <div class="sect1" lang="en">
                   6281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6282: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75      rillig   6283: <p>Global default options are listed in
                   6284: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6285: that should be built into every package if that option is supported.
1.76      rillig   6286: This variable should be set in <code class="filename">/etc/mk.conf</code>.</p>
1.75      rillig   6287: </div>
                   6288: <div class="sect1" lang="en">
                   6289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93      rillig   6290: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   6291: </h2></div></div></div>
1.75      rillig   6292: <p>The following example shows how
1.76      rillig   6293: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6294: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6295: <code class="filename">Makefile</code>, or in a file,
                   6296: e.g. <code class="filename">options.mk</code>, that is included by the
                   6297: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6298: <pre class="programlisting">
1.100     rillig   6299: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6300: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6301: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6302: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6303: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6304: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6305: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6306: 
                   6307: .include "../../mk/bsd.prefs.mk"
                   6308: 
                   6309: # this package was previously named wibble2
                   6310: .if defined(PKG_OPTIONS.wibble2)
                   6311: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6312: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6313:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6314: .endif
                   6315: 
                   6316: .include "../../mk/bsd.options.mk"
                   6317: 
                   6318: # Package-specific option-handling
                   6319: 
                   6320: ###
                   6321: ### FOO support
                   6322: ###
                   6323: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6324: CONFIGURE_ARGS+=    --enable-foo
                   6325: .endif
                   6326: 
                   6327: ###
                   6328: ### LDAP support
                   6329: ###
                   6330: .if !empty(PKG_OPTIONS:Mldap)
                   6331: .  include "../../databases/openldap-client/buildlink3.mk"
                   6332: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6333: .endif
                   6334: 
                   6335: ###
                   6336: ### database support
                   6337: ###
                   6338: .if !empty(PKG_OPTIONS:Mmysql)
                   6339: .  include "../../mk/mysql.buildlink3.mk"
                   6340: .endif
                   6341: .if !empty(PKG_OPTIONS:Mpgsql)
                   6342: .  include "../../mk/pgsql.buildlink3.mk"
                   6343: .endif
1.75      rillig   6344: </pre>
                   6345: <p>The first section contains the information about which build
                   6346: options are supported by the package, and any default options settings
                   6347: if needed.</p>
                   6348: <div class="orderedlist"><ol type="1">
                   6349: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   6350: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
                   6351: options.  It should be set to
1.78      rillig   6352: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6353: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6354: at the point where the options are processed.</p></li>
1.75      rillig   6355: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6356: build options supported by the package.</p></li>
                   6357: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6358: list of names of groups of mutually exclusive options.  The options in
                   6359: each group are listed in
                   6360: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6361: The most specific setting of any option from the group takes
                   6362: precedence over all other options in the group.  Options from the
                   6363: groups will be automatically added to
                   6364: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6365: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6366: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6367: packages will fail if no option from the group is
                   6368: selected.</p></li>
                   6369: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6370: of names of sets of options.  At least one option from each set must
                   6371: be selected.  The options in each set are listed in
                   6372: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6373: Options from the sets will be automatically added to
                   6374: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6375: fail if no option from the set is selected.</p></li>
                   6376: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6377: build options which are enabled by default.</p></li>
                   6378: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6379: of
                   6380: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.76      rillig   6381: pairs that map legacy <code class="filename">/etc/mk.conf</code> variables to
1.75      rillig   6382: their option counterparts.  Pairs should be added with
                   6383: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6384: warning will be issued if the user uses a legacy
                   6385: variable.</p></li>
                   6386: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6387: of
                   6388: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6389: pairs that map options that have been renamed to their new
                   6390: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6391: the listing of global legacy options.  A warning will be issued if
                   6392: the user uses a legacy option.</p></li>
                   6393: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6394: options implied by deprecated variables used.  This can be used for
                   6395: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6396: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6397: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6398: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6399: a list of warnings about deprecated variables or options used, and
                   6400: what to use instead.</p></li>
                   6401: </ol></div>
                   6402: <p>A package should never modify
                   6403: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6404: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6405: To suggest a default set of options, use
                   6406: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6407: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6408: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6409: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6410: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6411: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6412: happen with platform-specific options if none of them is supported on
                   6413: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6414: empty list and the package is otherwise treated as not using the
                   6415: options framework.</p>
1.76      rillig   6416: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6417: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6418: build options, properly filtered to remove unsupported and duplicate
                   6419: options.</p>
                   6420: <p>The remaining sections contain the logic that is specific to
                   6421: each option.  The correct way to check for an option is to check
                   6422: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6423: <pre class="programlisting">
1.100     rillig   6424: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6425: </pre>
                   6426: </div>
                   6427: <div class="sect1" lang="en">
                   6428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6429: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75      rillig   6430: <p>Options that enable similar features in different packages (like
                   6431: optional support for a library) should use a common name in all
                   6432: packages that support it (like the name of the library).  If another
                   6433: package already has an option with the same meaning, use the same
                   6434: name.</p>
                   6435: <p>Options that enable features specific to one package, where it's
                   6436: unlikely that another (unrelated) package has the same (or a similar)
                   6437: optional feature, should use a name prefixed with
                   6438: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6439: <p>If a group of related packages share an optional feature
                   6440: specific to that group, prefix it with the name of the
                   6441: &#8220;<span class="quote">main</span>&#8221; package
                   6442: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6443: <p>For new options, add a line to
1.76      rillig   6444: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6445: fields, separated by tab.  The first field is the option name, the
                   6446: second its description.  The description should be a whole sentence
                   6447: (starting with an uppercase letter and ending with a period) that
                   6448: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6449: support.</span>&#8221; The file is sorted by option names.</p>
                   6450: </div>
                   6451: </div>
                   6452: <div class="chapter" lang="en">
                   6453: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   6454: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75      rillig   6455: <div class="toc">
                   6456: <p><b>Table of Contents</b></p>
                   6457: <dl>
1.90      rillig   6458: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
                   6459: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
                   6460: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
                   6461: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
                   6462: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6463: <dd><dl>
                   6464: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
                   6465: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
                   6466: </dl></dd>
                   6467: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6468: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6469: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6470: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6471: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6472: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6473: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6474: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6475: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6476: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   6477: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
                   6478: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75      rillig   6479: </dl>
                   6480: </div>
                   6481: <div class="sect1" lang="en">
                   6482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6483: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75      rillig   6484: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6485:     built. Building a package is separated into different
                   6486:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6487:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6488:     described in the following sections. Each phase is splitted into
                   6489:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6490:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6491:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6492:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6493:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6494: <p>Never override the regular targets (like
                   6495:     <code class="varname">fetch</code>), if you have to, override the
                   6496:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6497: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6498:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6499:     the local system and then extracted. After any pkgsrc-specific patches
                   6500:     to compile properly are applied, the software can be configured, then
                   6501:     built (usually by compiling), and finally the generated binaries, etc.
                   6502:     can be put into place on the system.</p>
1.97      rillig   6503: <p>To get more details about what is happening at each step,
                   6504:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6505:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6506:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6507: </div>
                   6508: <div class="sect1" lang="en">
                   6509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6510: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75      rillig   6511: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6512:     the next section, here's a brief discussion on where programs are
                   6513:     installed, and which variables influence this.</p>
1.75      rillig   6514: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6515:     where all files of the final program shall be installed. It is
                   6516:     usually set to <code class="varname">LOCALBASE</code>
                   6517:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6518:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6519:     <code class="varname">PREFIX</code> needs to be put
                   6520:     into the various places in the program's source where paths to
1.90      rillig   6521:     these files are encoded.  See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> and <a href="#fixes.libtool" title="18.3.1. Shared libraries - libtool">Section 18.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6522: <p>When choosing which of these variables to use,
1.87      wiz      6523:     follow the following rules:</p>
1.75      rillig   6524: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6525: <li><p><code class="varname">PREFIX</code> always points to the location
                   6526:        where the current pkg will be installed.  When referring to a
                   6527:        pkg's own installation path, use
                   6528:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6529: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6530:        are installed.  If you need to construct a -I or -L argument
                   6531:        to the compiler to find includes and libraries installed by
                   6532:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6533:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6534:        installed all packages in <code class="filename">/usr/local</code>. As
                   6535:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6536:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6537: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6538:        distribution (from xsrc, etc.) is installed. When looking for
                   6539:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6540:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6541: <li>
                   6542: <p>X11-based packages are special in that they may be
                   6543:        installed in either <code class="varname">X11BASE</code> or
                   6544:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6545: <p>Usually, X11 packages should be installed under
1.88      wiz      6546:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6547:        will need to include
                   6548:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6549:        request the presence of X11 and to get the right compilation
                   6550:        flags.</p>
1.75      rillig   6551: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6552:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6553:        files. These packages are special and they must be placed under
                   6554:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6555:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6556:        your package.</p>
1.75      rillig   6557: <p>Some notes: If you need
1.87      wiz      6558:        to find includes or libraries installed by a pkg that has
                   6559:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6560:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6561:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6562:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6563:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6564:        <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      6565:        is enabled by default.</p>
1.75      rillig   6566: </li>
1.88      wiz      6567: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6568:        the installed location of an X11
                   6569:        package. <code class="varname">X11PREFIX</code> will be set to
                   6570:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6571:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6572:        installed.</p></li>
                   6573: <li>
                   6574: <p>If xpkgwedge is installed, it is possible to have some
                   6575:        packages installed in <code class="varname">X11BASE</code> and some in
                   6576:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6577:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6578:        definition can be used. It takes pairs in the format
                   6579:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
                   6580:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6581:        of the installed package &lt;package&gt;, or
                   6582:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6583:        installed.</p>
1.75      rillig   6584: <p>This is best illustrated by example.</p>
                   6585: <p>The following lines are taken from
1.87      wiz      6586:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6587: <pre class="programlisting">
1.100     rillig   6588: EVAL_PREFIX+=           GTKDIR=gtk+
                   6589: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6590: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6591: CONFIGURE_ARGS+=        --enable-multibyte
                   6592: </pre>
1.88      wiz      6593: <p>Specific defaults can be defined for the packages
                   6594:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6595:        definition of the form:</p>
1.75      rillig   6596: <pre class="programlisting">
1.100     rillig   6597: GTKDIR_DEFAULT= ${LOCALBASE}
                   6598: </pre>
1.75      rillig   6599: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6600:        to the first definition in
                   6601:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6602: </li>
1.76      rillig   6603: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87      wiz      6604:        install files according to <a href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
                   6605:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6606:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6607: </ul></div>
                   6608: </div>
                   6609: <div class="sect1" lang="en">
                   6610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6611: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75      rillig   6612: <p>When building a package, a number of directories is used to store
1.87      wiz      6613:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6614:     directories are explained here.</p>
1.75      rillig   6615: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6616:     are two common base directories for these relative directories:
                   6617:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6618:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6619:     inside the package itself.</p>
1.75      rillig   6620: <div class="variablelist"><dl>
                   6621: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6622: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6623:       root directory. Generally, you don't need
                   6624:       it.</p></dd>
1.97      rillig   6625: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6626: <dd><p>This is an absolute pathname that points to the
                   6627:       current package.</p></dd>
1.75      rillig   6628: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6629: <dd><p>This is a pathname relative to
1.87      wiz      6630:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6631:       package.</p></dd>
1.75      rillig   6632: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6633: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6634:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6635:       directory. It also contains temporary directories and log files used by
                   6636:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6637:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6638: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6639: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6640:       where the distfiles are extracted. It is usually a direct subdirectory
                   6641:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6642:       that isn't hidden. This variable may be changed by a package
                   6643:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6644: </dl></div>
                   6645: </div>
                   6646: <div class="sect1" lang="en">
                   6647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6648: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75      rillig   6649: <p>You can run a particular phase by typing <span><strong class="command">make
1.87      wiz      6650:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6651:     phase. This will automatically run all phases that are required for this
                   6652:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   6653:     run <span><strong class="command">make</strong></span> without parameters in a package directory,
                   6654:     the package will be built, but not installed.</p>
1.75      rillig   6655: </div>
                   6656: <div class="sect1" lang="en">
                   6657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6658: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6659: <p>The first step in building a package is to fetch the
1.88      wiz      6660:     distribution files (distfiles) from the sites that are providing
                   6661:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6662:     phase.</p>
1.81      rillig   6663: <div class="sect2" lang="en">
                   6664: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6665: <a name="build.fetch.what"></a>16.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6666: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6667:       defines all URLs from where the distfile, whose name is
                   6668:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6669:       fetched. The more complicated cases are described
                   6670:       below.</p>
                   6671: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6672:       the list of distfiles that have to be fetched. Its value
                   6673:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6674:       so that most packages don't need to define it at all.
                   6675:       <code class="varname">EXTRACT_SUFX</code> is
                   6676:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6677:       freely. Note that if your package requires additional
                   6678:       distfiles to the default one, you cannot just append the
                   6679:       additional filenames using the <code class="literal">+=</code>
                   6680:       operator, but you have write for example:</p>
1.81      rillig   6681: <pre class="programlisting">
1.100     rillig   6682: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6683: </pre>
1.88      wiz      6684: <p>Each distfile is fetched from a list of sites, usually
                   6685:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6686:       <code class="varname">DISTFILES</code> or multiple
                   6687:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6688:       set
                   6689:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6690:       to the list of URLs where the file
                   6691:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6692:       (including the suffix) can be found.</p>
                   6693: <pre class="programlisting">
1.100     rillig   6694: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6695: DISTFILES+=     foo-file.tar.gz
                   6696: SITES.foo-file.tar.gz= \
                   6697: http://www.somewhere.com/somehow/ \
                   6698: http://www.somewhereelse.com/mirror/somehow/
                   6699: </pre>
1.81      rillig   6700: <p>When actually fetching the distfiles, each item from
1.88      wiz      6701:       <code class="varname">MASTER_SITES</code> or
                   6702:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6703:       appended to it, without an intermediate slash. Therefore,
                   6704:       all site values have to end with a slash or other separator
                   6705:       character. This allows for example to set
                   6706:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6707:       that gets the name of the distfile as a parameter. In this
                   6708:       case, the definition would look like:</p>
1.81      rillig   6709: <pre class="programlisting">
1.100     rillig   6710: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6711: </pre>
1.81      rillig   6712: <p>There are some predefined values for
1.88      wiz      6713:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6714:       packages.  The names of the variables should speak for
                   6715:       themselves.</p>
                   6716: <pre class="programlisting">
1.100     rillig   6717: ${MASTER_SITE_APACHE}
                   6718: ${MASTER_SITE_BACKUP}
                   6719: ${MASTER_SITE_CYGWIN}
                   6720: ${MASTER_SITE_DEBIAN}
                   6721: ${MASTER_SITE_FREEBSD}
                   6722: ${MASTER_SITE_FREEBSD_LOCAL}
                   6723: ${MASTER_SITE_GENTOO}
                   6724: ${MASTER_SITE_GNOME}
                   6725: ${MASTER_SITE_GNU}
                   6726: ${MASTER_SITE_GNUSTEP}
                   6727: ${MASTER_SITE_IFARCHIVE}
                   6728: ${MASTER_SITE_KDE}
                   6729: ${MASTER_SITE_MOZILLA}
                   6730: ${MASTER_SITE_MYSQL}
                   6731: ${MASTER_SITE_OPENOFFICE}
                   6732: ${MASTER_SITE_PERL_CPAN}
                   6733: ${MASTER_SITE_PGSQL}
                   6734: ${MASTER_SITE_R_CRAN}
                   6735: ${MASTER_SITE_SOURCEFORGE}
                   6736: ${MASTER_SITE_SOURCEFORGE_JP}
                   6737: ${MASTER_SITE_SUNSITE}
                   6738: ${MASTER_SITE_SUSE}
                   6739: ${MASTER_SITE_TEX_CTAN}
                   6740: ${MASTER_SITE_XCONTRIB}
                   6741: ${MASTER_SITE_XEMACS}
                   6742: </pre>
1.88      wiz      6743: <p>Some explanations for the less self-explaining ones:
                   6744:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93      rillig   6745:       for packages that are maintained in <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   6746:       package source distributions that are maintained in <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6747: <p>If you choose one of these predefined sites, you may
                   6748:       want to specify a subdirectory of that site. Since these
                   6749:       macros may expand to more than one actual site, you
                   6750:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6751:       specify a subdirectory:</p>
1.81      rillig   6752: <pre class="programlisting">
1.100     rillig   6753: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6754: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6755: </pre>
1.81      rillig   6756: <p>Note the trailing slash after the subdirectory
1.88      wiz      6757:       name.</p>
1.81      rillig   6758: </div>
                   6759: <div class="sect2" lang="en">
                   6760: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   6761: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6762: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6763:       all the distfiles exist in a local directory
1.93      rillig   6764:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6765:       user). If the files do not exist, they are fetched using
                   6766:       commands of the form</p>
1.75      rillig   6767: <pre class="programlisting">
1.100     rillig   6768: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6769: </pre>
1.88      wiz      6770: <p>where <code class="literal">${site}</code> varies through
                   6771:       several possibilities in turn: first,
                   6772:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6773:       sites specified in either <code class="varname">SITES.file</code> if
                   6774:       defined, else <code class="varname">MASTER_SITES</code> or
                   6775:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6776:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6777:       all except the first and the last can be optionally sorted
                   6778:       by the user, via setting either
                   6779:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6780:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6781:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97      rillig   6782: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6783:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6784:       distfiles, if they are freely distributable.  Packages setting
                   6785:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6786:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6787:       mirrored.</p>
1.81      rillig   6788: </div>
1.75      rillig   6789: </div>
                   6790: <div class="sect1" lang="en">
                   6791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6792: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6793: <p>After the distfile(s) are fetched, their checksum is
                   6794:     generated and compared with the checksums stored in the
                   6795:     distinfo file. If the checksums don't match, the build is
                   6796:     aborted. This is to ensure the same distfile is used for
                   6797:     building, and that the distfile wasn't changed, e.g. by some
                   6798:     malign force, deliberately changed distfiles on the master
                   6799:     distribution site or network lossage.</p>
1.75      rillig   6800: </div>
                   6801: <div class="sect1" lang="en">
                   6802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6803: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6804: <p>When the distfiles are present on the local system, they
1.88      wiz      6805:     need to be extracted, as they usually come in the form of some
                   6806:     compressed archive format.</p>
1.75      rillig   6807: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6808:     extracted. If you only need some of them, you can set the
                   6809:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6810:     files.</p>
                   6811: <p>Extracting the files is usually done by a little
1.93      rillig   6812:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6813:     already knows how to extract various archive formats, so most
                   6814:     likely you will not need to change anything here. But if you
                   6815:     need, the following variables may help you:</p>
1.75      rillig   6816: <div class="variablelist"><dl>
                   6817: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6818: <dd><p>Use these variables to override the default
1.88      wiz      6819:       options for an extract command, which are defined in
1.93      rillig   6820:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6821: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6822: <dd><p>This variable can be set to
1.93      rillig   6823:       <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
                   6824:       default value), <code class="literal">pax</code>, or an
1.88      wiz      6825:       absolute pathname pointing to the command with which tar
                   6826:       archives should be
                   6827:       extracted.</p></dd>
1.75      rillig   6828: </dl></div>
1.88      wiz      6829: <p>If the <code class="filename">extract</code> program doesn't
                   6830:     serve your needs, you can also override the
                   6831:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6832:     command used for extracting the files. This command is
                   6833:     executed in the <code class="filename">${WRKSRC}</code>
                   6834:     directory. During execution of this command, the shell
                   6835:     variable <code class="varname">extract_file</code> holds the absolute
                   6836:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6837: <p>And if that still does not suffice, you can override the
1.88      wiz      6838:     <code class="varname">do-extract</code> target in the package
                   6839:     Makefile.</p>
1.75      rillig   6840: </div>
                   6841: <div class="sect1" lang="en">
                   6842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6843: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6844: <p>After extraction, all the patches named by the
1.88      wiz      6845:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6846:     subdirectory of the package as well as in
                   6847:     $LOCALPATCHES/$PKGPATH (e.g.
                   6848:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6849:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6850:     <code class="filename">.gz</code> are uncompressed before they are
                   6851:     applied, files ending in <code class="filename">.orig</code> or
                   6852:     <code class="filename">.rej</code> are ignored. Any special options to
                   6853:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.90      rillig   6854:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a href="#components.patches" title="10.3. patches/*">Section 10.3, &#8220;patches/*&#8221;</a> for more details.</p>
1.88      wiz      6855: <p>By default <a href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
                   6856:     it fail if the patches apply with some lines of fuzz. Please
                   6857:     fix (regen) the patches so that they apply cleanly. The
                   6858:     rationale behind this is that patches that don't apply cleanly
                   6859:     may end up being applied in the wrong place, and cause severe
                   6860:     harm there.</p>
1.75      rillig   6861: </div>
                   6862: <div class="sect1" lang="en">
                   6863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6864: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6865: <p>This is covered in <a href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
1.88      wiz      6866:     </p>
1.75      rillig   6867: </div>
                   6868: <div class="sect1" lang="en">
                   6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6870: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6871: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6872:     linkers. The following variables can be used to tweak the
                   6873:     wrappers.</p>
1.75      rillig   6874: <div class="variablelist"><dl>
                   6875: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6876: <dd><p>The command used to print progress
1.88      wiz      6877:       messages. Does nothing by default. Set to
                   6878:       <code class="literal">${ECHO}</code> to see the progress
                   6879:       messages.</p></dd>
1.75      rillig   6880: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6881: <dd><p>This variable can be set to
1.88      wiz      6882:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6883:       depending on whether you want additional information in the
                   6884:       wrapper log file.</p></dd>
1.75      rillig   6885: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6886: <dd><p>This variable can be set to
1.88      wiz      6887:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6888:       on whether the wrapper should use its cache, which will
                   6889:       improve the speed. The default value is
                   6890:       <code class="literal">yes</code>, but is forced to
                   6891:       <code class="literal">no</code> if the platform does not support
                   6892:       it.</p></dd>
1.75      rillig   6893: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6894: <dd><p>A list of reordering commands. A reordering
                   6895:       command has the form
                   6896:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6897:       It ensures that that
                   6898:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6899:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6900:       </p></dd>
1.75      rillig   6901: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6902: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6903:       investigate further]</p></dd>
1.75      rillig   6904: </dl></div>
                   6905: </div>
                   6906: <div class="sect1" lang="en">
                   6907: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6908: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6909: <p>Most pieces of software need information on the header
                   6910:     files, system calls, and library routines which are available
                   6911:     on the platform they run on. The process of determining this
                   6912:     information is known as configuration, and is usually
                   6913:     automated. In most cases, a script is supplied with the
                   6914:     distfiles, and its invocation results in generation of header
                   6915:     files, Makefiles, etc.</p>
                   6916: <p>If the package contains a configure script, this can be
                   6917:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6918:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6919:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6920:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6921:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6922: <pre class="programlisting">
1.100     rillig   6923: .for d in ${CONFIGURE_DIRS}
                   6924:         cd ${WRKSRC} \
                   6925:         &amp;&amp; cd ${d} \
                   6926:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6927: .endfor
                   6928: </pre>
1.88      wiz      6929: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6930:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6931:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6932:     configure script is run with the environment
                   6933:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6934:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6935:     <code class="varname">CONFIGURE_ENV</code>,
                   6936:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   6937:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   6938:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6939:     package.</p>
                   6940: <p>If the program uses an <code class="filename">Imakefile</code>
                   6941:     for configuration, the appropriate steps can be invoked by
                   6942:     setting <code class="varname">USE_IMAKE</code> to
                   6943:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   6944:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   6945:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6946:     xmkmf's environment by adding them to the
                   6947:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   6948: <p>If there is no configure step at all, set
                   6949:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6950: </div>
                   6951: <div class="sect1" lang="en">
                   6952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6953: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6954: <p>For building a package, a rough equivalent of the
                   6955:     following code is executed.</p>
1.75      rillig   6956: <pre class="programlisting">
1.100     rillig   6957: .for d in ${BUILD_DIRS}
                   6958:         cd ${WRKSRC} \
                   6959:         &amp;&amp; cd ${d} \
                   6960:         &amp;&amp; env ${MAKE_ENV} \
                   6961:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6962:                 -f ${MAKE_FILE} \
                   6963:                 ${BUILD_TARGET}
                   6964: .endfor
                   6965: </pre>
1.88      wiz      6966: <p><code class="varname">BUILD_DIRS</code> (default:
                   6967:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6968:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6969:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6970:     <code class="varname">MAKE_ENV</code> and arguments
                   6971:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6972:     <code class="varname">MAKE_ENV</code>,
                   6973:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6974:     <code class="varname">MAKE_FILE</code> and
                   6975:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6976:     package.</p>
1.75      rillig   6977: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      6978:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   6979:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   6980:     default value of <code class="varname">MAKE_FILE</code> is
                   6981:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   6982:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   6983: <p>If there is no build step at all, set
                   6984:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   6985: </div>
                   6986: <div class="sect1" lang="en">
                   6987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6988: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6989: <p>[TODO]</p>
                   6990: </div>
                   6991: <div class="sect1" lang="en">
                   6992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   6993: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6994: <p>Once the build stage has completed, the final step is to
1.88      wiz      6995:     install the software in public directories, so users can
                   6996:     access the programs and files.</p>
1.75      rillig   6997: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6998:     equivalent of the following code is executed. Additionally,
                   6999:     before and after this code, much magic is performed to do
                   7000:     consistency checks, registering the package, and so on.</p>
                   7001: <pre class="programlisting">
1.100     rillig   7002: .for d in ${INSTALL_DIRS}
                   7003:         cd ${WRKSRC} \
                   7004:         &amp;&amp; cd ${d} \
                   7005:         &amp;&amp; env ${MAKE_ENV} \
                   7006:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7007:                 -f ${MAKE_FILE} \
                   7008:                 ${INSTALL_TARGET}
                   7009: .endfor
                   7010: </pre>
1.75      rillig   7011: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      7012:     <span class="emphasis"><em>build</em></span> phase.
                   7013:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7014:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   7015:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   7016:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   7017:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7018:     defined.</p>
1.75      rillig   7019: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      7020:     variables are useful. They are all variations of the
                   7021:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
                   7022:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7023:     install command. The specialized variants, together with their
                   7024:     intended use, are:</p>
1.75      rillig   7025: <div class="variablelist"><dl>
                   7026: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      7027: <dd><p>directories that contain
                   7028:       binaries</p></dd>
1.75      rillig   7029: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7030: <dd><p>directories that contain
                   7031:       scripts</p></dd>
1.75      rillig   7032: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7033: <dd><p>directories that contain shared and static
                   7034:       libraries</p></dd>
1.75      rillig   7035: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7036: <dd><p>directories that contain data
                   7037:       files</p></dd>
1.75      rillig   7038: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7039: <dd><p>directories that contain man
                   7040:       pages</p></dd>
1.75      rillig   7041: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7042: <dd><p>binaries that can be stripped from debugging
                   7043:       symbols</p></dd>
1.75      rillig   7044: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7045: <dd><p>binaries that cannot be
                   7046:       stripped</p></dd>
1.75      rillig   7047: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7048: <dd><p>game
                   7049:       binaries</p></dd>
1.75      rillig   7050: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7051: <dd><p>shared and static
                   7052:       libraries</p></dd>
1.75      rillig   7053: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7054: <dd><p>data files</p></dd>
                   7055: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7056: <dd><p>data files for
                   7057:       games</p></dd>
1.75      rillig   7058: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7059: <dd><p>man pages</p></dd>
                   7060: </dl></div>
                   7061: <p>Some other variables are:</p>
                   7062: <div class="variablelist"><dl>
                   7063: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7064: <dd><p>A list of directories relative to
1.88      wiz      7065:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7066:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7067:       The package is supposed to create all needed directories itself
                   7068:       before installing files to it and list all other directories here.
                   7069:       </p></dd>
1.75      rillig   7070: </dl></div>
1.97      rillig   7071: <p>In the rare cases that a package shouldn't install anything,
                   7072:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7073:     mostly relevant for packages in the <code class="filename">regress</code>
                   7074:     category.</p>
1.75      rillig   7075: </div>
                   7076: <div class="sect1" lang="en">
                   7077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7078: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7079: <p>Once the install stage has completed, a binary package of
                   7080:     the installed files can be built.  These binary packages can be
                   7081:     used for quick installation without previous compilation, e.g. by
                   7082:     the <span><strong class="command">make bin-install</strong></span> or by using
                   7083:     <span><strong class="command">pkg_add</strong></span>.</p>
                   7084: <p>By default, the binary packages are created in
                   7085:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7086:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7087:     one for each category in the <code class="varname">CATEGORIES</code>
                   7088:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7089:     <code class="filename">pkgsrc/packages</code>.</p>
1.97      rillig   7090: <p>If there should be no binary package, set
                   7091:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7092:     This should only be used in rare cases, like when a package
                   7093:     definitely is only usable on the machine where it is built and even
                   7094:     then, a binary package can be useful.</p>
1.88      wiz      7095: </div>
                   7096: <div class="sect1" lang="en">
                   7097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7098: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88      wiz      7099: <p>Once you're finished with a package, you can clean the work
                   7100:     directory by running <span><strong class="command">make clean</strong></span>.  If you want
                   7101:     to clean the work directories of all dependencies too, use
                   7102:     <span><strong class="command">make clean-depends</strong></span>.</p>
1.75      rillig   7103: </div>
                   7104: <div class="sect1" lang="en">
                   7105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7106: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7107: <div class="variablelist"><dl>
                   7108: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7109: <dd><p>For any of the main targets described in the
                   7110:          previous section, two auxiliary targets exist with
1.87      wiz      7111:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7112:          prefix for the main target's name.  These targets are
1.88      wiz      7113:          invoked before and after the main target is called,
                   7114:          allowing extra configuration or installation steps be
                   7115:          performed from a package's Makefile, for example, which
                   7116:          a program's configure script or install target
                   7117:          omitted.</p></dd>
1.75      rillig   7118: <dt><span class="term">do-*</span></dt>
1.88      wiz      7119: <dd><p>Should one of the main targets do the wrong thing,
                   7120:          and should there be no variable to fix this, you can
                   7121:          redefine it with the do-* target.  (Note that redefining
                   7122:          the target itself instead of the do-* target is a bad
                   7123:          idea, as the pre-* and post-* targets won't be called
                   7124:          anymore, etc.) You will not usually need to do
                   7125:          this.</p></dd>
1.75      rillig   7126: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7127: <dd>
                   7128: <p>If you did a <span><strong class="command">make install</strong></span> and
                   7129:          you noticed some file was not installed properly, you
                   7130:          can repeat the installation with this target, which will
                   7131:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7132: <p>This is the default value of
                   7133:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   7134:          <span><strong class="command">make update</strong></span> and <span><strong class="command">make
                   7135:          package</strong></span>, where the defaults are
                   7136:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7137:          respectively.</p>
                   7138: </dd>
1.75      rillig   7139: <dt><span class="term">deinstall</span></dt>
                   7140: <dd>
1.88      wiz      7141: <p>This target does a <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
                   7142:          current directory, effectively de-installing the
                   7143:          package. The following variables can be used to tune the
                   7144:          behaviour:</p>
1.75      rillig   7145: <div class="variablelist"><dl>
                   7146: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   7147: <dd><p>Add a "-v" to the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
                   7148: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7149: <dd><p>Remove all packages that require (depend on)
                   7150:                the given package.  This can be used to remove any
                   7151:                packages that may have been pulled in by a given
                   7152:                package, e.g. if <span><strong class="command">make deinstall
1.87      wiz      7153:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7154:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7155:                likely to remove whole KDE. Works by adding
                   7156:                &#8220;<span class="quote">-R</span>&#8221; to the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   7157:                command line.</p></dd>
1.75      rillig   7158: </dl></div>
                   7159: </dd>
1.88      wiz      7160: <dt><span class="term">bin-install</span></dt>
                   7161: <dd><p>Install a binary package from local disk and via FTP
                   7162:          from a list of sites (see the
                   7163:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   7164:          <span><strong class="command">make package</strong></span> if no binary package is
                   7165:          available anywhere.  The arguments given to
                   7166:          <span><strong class="command">pkg_add</strong></span> can be set via
                   7167:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7168:          operation, etc.</p></dd>
1.75      rillig   7169: <dt><span class="term">update</span></dt>
                   7170: <dd>
1.88      wiz      7171: <p>This target causes the current package to be
                   7172:          updated to the latest version.  The package and all
                   7173:          depending packages first get de-installed, then current
                   7174:          versions of the corresponding packages get compiled and
                   7175:          installed.  This is similar to manually noting which
                   7176:          packages are currently installed, then performing a
                   7177:          series of <span><strong class="command">make deinstall</strong></span> and
                   7178:          <span><strong class="command">make install</strong></span> (or whatever
                   7179:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7180:          packages.</p>
                   7181: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
                   7182:          resume package updating in case a previous <span><strong class="command">make
                   7183:          update</strong></span> was interrupted for some reason.
                   7184:          However, in this case, make sure you don't call
                   7185:          <span><strong class="command">make clean</strong></span> or otherwise remove the
                   7186:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7187:          Otherwise, you lose the ability to automatically update
                   7188:          the current package along with the dependent packages
                   7189:          you have installed.</p>
                   7190: <p>Resuming an interrupted <span><strong class="command">make
                   7191:          update</strong></span> will only work as long as the package
                   7192:          tree remains unchanged.  If the source code for one of
                   7193:          the packages to be updated has been changed, resuming
                   7194:          <span><strong class="command">make update</strong></span> will most certainly
                   7195:          fail!</p>
                   7196: <p>The following variables can be used either on the
                   7197:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7198:          alter the behaviour of <span><strong class="command">make
                   7199:          update</strong></span>:</p>
1.75      rillig   7200: <div class="variablelist"><dl>
                   7201: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7202: <dd><p>Install target to recursively use for the
                   7203:                updated package and the dependent packages.
                   7204:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7205:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
                   7206:                <span><strong class="command">make update</strong></span>.  Other good
                   7207:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7208:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7209:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7210:                endless loop!</p></dd>
1.75      rillig   7211: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7212: <dd><p>Don't clean up after updating.  Useful if
                   7213:                you want to leave the work sources of the updated
                   7214:                packages around for inspection or other purposes.
                   7215:                Be sure you eventually clean up the source tree
                   7216:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7217:                or you may run into troubles with old source code
                   7218:                still lying around on your next
                   7219:                <span><strong class="command">make</strong></span> or <span><strong class="command">make
                   7220:                update</strong></span>.</p></dd>
1.75      rillig   7221: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7222: <dd><p>Deinstall each package before installing
                   7223:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7224:                may be necessary if the
                   7225:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
                   7226:                called after interrupting a running <span><strong class="command">make
                   7227:                update</strong></span>.</p></dd>
1.75      rillig   7228: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7229: <dd><p>Allows you to disable recursion and hardcode
                   7230:                the target for packages.  The default is
                   7231:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7232:                facilitating a recursive update of prerequisite
                   7233:                packages.  Only set
                   7234:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7235:                disable recursive updates. Use
                   7236:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7237:                set a specific target for each package to be
                   7238:                installed during <span><strong class="command">make update</strong></span>
                   7239:                (see above).</p></dd>
1.75      rillig   7240: </dl></div>
                   7241: </dd>
                   7242: <dt><span class="term">clean-update</span></dt>
                   7243: <dd>
1.88      wiz      7244: <p>Clean the source tree for all packages that would
                   7245:          get updated if <span><strong class="command">make update</strong></span> was called
                   7246:          from the current directory.  This target should not be
                   7247:          used if the current package (or any of its depending
                   7248:          packages) have already been de-installed (e.g., after
                   7249:          calling <span><strong class="command">make update</strong></span>) or you may lose
                   7250:          some packages you intended to update. As a rule of
                   7251:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   7252:          the first time you run <span><strong class="command">make update</strong></span>
                   7253:          and only if you have a dirty package tree (e.g., if you
                   7254:          used <code class="varname">NOCLEAN</code>).</p>
                   7255: <p>If you are unsure about whether your tree is
                   7256:          clean, you can either perform a <span><strong class="command">make
                   7257:          clean</strong></span> at the top of the tree, or use the
                   7258:          following sequence of commands from the directory of the
                   7259:          package you want to update (<span class="emphasis"><em>before</em></span>
                   7260:          running <span><strong class="command">make update</strong></span> for the first
                   7261:          time, otherwise you lose all the packages you wanted to
                   7262:          update!):</p>
1.87      wiz      7263: <pre class="screen">
                   7264: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7265: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7266: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7267:          </pre>
1.88      wiz      7268: <p>The following variables can be used either on the
                   7269:          command line or in <code class="filename">/etc/mk.conf</code> to
                   7270:          alter the behaviour of <span><strong class="command">make
                   7271:          clean-update</strong></span>:</p>
1.75      rillig   7272: <div class="variablelist"><dl>
                   7273: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88      wiz      7274: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
                   7275:                reconstruct the list of directories to update for
                   7276:                this package.  Only use this if <span><strong class="command">make
                   7277:                update</strong></span> successfully installed all
                   7278:                packages you wanted to update.  Normally, this is
                   7279:                done automatically on <span><strong class="command">make
                   7280:                update</strong></span>, but may have been suppressed by
                   7281:                the <code class="varname">NOCLEAN</code> variable (see
                   7282:                above).</p></dd>
1.75      rillig   7283: </dl></div>
                   7284: </dd>
1.88      wiz      7285: <dt><span class="term">replace</span></dt>
                   7286: <dd>
                   7287: <p>Update the installation of the current package.  This
                   7288:          differs from update in that it does not replace dependent
1.93      rillig   7289:          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      7290:          target to work.</p>
                   7291: <p><span class="emphasis"><em>Be careful when using this
                   7292:          target!</em></span> There are no guarantees that dependent
                   7293:          packages will still work, in particular they will most
                   7294:          certainly break if you <span><strong class="command">make replace</strong></span> a
                   7295:          library package whose shared library major version changed
                   7296:          between your installed version and the new one.  For this
                   7297:          reason, this target is not officially supported and only
                   7298:          recommended for advanced users.</p>
                   7299: </dd>
1.75      rillig   7300: <dt><span class="term">info</span></dt>
                   7301: <dd><p>This target invokes <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7302:          package. You can use this to check which version of a
                   7303:          package is installed.</p></dd>
                   7304: <dt><span class="term">index</span></dt>
                   7305: <dd>
                   7306: <p>This is a top-level command, i.e. it should be used in
                   7307:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7308:          database of all packages in the local pkgsrc tree, including
                   7309:          dependencies, comment, maintainer, and some other useful
                   7310:          information.  Individual entries are created by running
                   7311:          <span><strong class="command">make describe</strong></span> in the packages'
                   7312:          directories.  This index file is saved as
                   7313:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   7314:          verbose format by running <span><strong class="command">make
                   7315:          print-index</strong></span>.  You can search in it with
                   7316:          <span><strong class="command">make search
                   7317:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7318:          extract a list of all packages that depend on a particular
                   7319:          one by running <span><strong class="command">make show-deps
                   7320:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7321: <p>Running this command takes a very long time, some
                   7322:          hours even on fast machines!</p>
                   7323: </dd>
1.75      rillig   7324: <dt><span class="term">readme</span></dt>
1.88      wiz      7325: <dd>
                   7326: <p>This target generates a
                   7327:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7328:          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      7329:          contain references to any packages which are in the
                   7330:          <code class="varname">PACKAGES</code> directory on the local
                   7331:          host. The generated files can be made to refer to URLs
                   7332:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7333:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7334:          wanted to generate <code class="filename">README.html</code>
                   7335:          files which pointed to binary packages on the local
                   7336:          machine, in the directory
                   7337:          <code class="filename">/usr/packages</code>, set
                   7338:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7339:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7340:          <code class="varname">${PACKAGES}</code> directory and its
                   7341:          subdirectories will be searched for all the binary
                   7342:          packages.</p>
                   7343: <p>The target can be run at the toplevel or in category
                   7344:          directories, in which case it descends recursively.</p>
                   7345: </dd>
1.75      rillig   7346: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7347: <dd><p>This is a top-level command, run it in
                   7348:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7349:          file <code class="filename">README-all.html</code> which contains a
                   7350:          list of all packages currently available in the NetBSD
                   7351:          Packages Collection, together with the category they belong
                   7352:          to and a short description. This file is compiled from the
                   7353:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   7354:          to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
                   7355:          readme</strong></span>.</p></dd>
1.75      rillig   7356: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7357: <dd><p>This is very much the same as the
                   7358:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7359:          used when generating a pkgsrc tree to be written to a
                   7360:          CD-ROM.  This target also produces
                   7361:          <code class="filename">README.html</code> files, and can be made
                   7362:          to refer to URLs based on
                   7363:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7364:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7365: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7366: <dd><p>This target shows which distfiles and patchfiles
                   7367:          are needed to build the package
                   7368:          (<code class="varname">ALLFILES</code>, which contains all
                   7369:          <code class="varname">DISTFILES</code> and
1.87      wiz      7370:          <code class="varname">PATCHFILES</code>, but not
                   7371:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7372: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7373: <dd><p>This target shows nothing if the package is not
                   7374:          installed. If a version of this package is installed,
                   7375:          but is not the version provided in this version of
                   7376:          pkgsrc, then a warning message is displayed. This target
                   7377:          can be used to show which of your installed packages are
                   7378:          downlevel, and so the old versions can be deleted, and
                   7379:          the current ones added.</p></dd>
1.75      rillig   7380: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7381: <dd><p>This target shows the directory in the pkgsrc
                   7382:          hierarchy from which the package can be built and
                   7383:          installed. This may not be the same directory as the one
                   7384:          from which the package was installed. This target is
                   7385:          intended to be used by people who may wish to upgrade
                   7386:          many packages on a single host, and can be invoked from
                   7387:          the top-level pkgsrc Makefile by using the
1.87      wiz      7388:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7389: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7390: <dd><p>This target shows which installed packages match
                   7391:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7392:          if out of date dependencies are causing build
                   7393:          problems.</p></dd>
1.75      rillig   7394: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7395: <dd><p>After a package is installed, check all its
                   7396:          binaries and (on ELF platforms) shared libraries to see
                   7397:          if they find the shared libs they need.  Run by default
                   7398:          if <code class="varname">PKG_DEVELOPER</code> is set in
1.87      wiz      7399:          <code class="filename">/etc/mk.conf</code>.</p></dd>
1.75      rillig   7400: <dt><span class="term">print-PLIST</span></dt>
                   7401: <dd>
                   7402: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7403:          upgraded pkg, this prints out an attempt to generate a
                   7404:          new <code class="filename">PLIST</code> from a <span><strong class="command">find
                   7405:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7406:          to care for shared libs etc., but it is
1.87      wiz      7407:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7408:          result before putting it into
                   7409:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7410:          diff the output of this command against an already
                   7411:          existing <code class="filename">PLIST</code> file.</p>
1.88      wiz      7412: <p>If the package installs files via <a href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
                   7413:          other methods that don't update file access times, be
                   7414:          sure to add these files manually to your
1.87      wiz      7415:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7416:          -newer</span>&#8221; command used by this target won't catch
                   7417:          them!</p>
1.90      rillig   7418: <p>See <a href="#print-PLIST" title="12.3. Tweaking output of make print-PLIST">Section 12.3, &#8220;Tweaking output of <span><strong class="command">make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      7419:          information on this target.</p>
1.75      rillig   7420: </dd>
                   7421: <dt><span class="term">bulk-package</span></dt>
                   7422: <dd>
1.88      wiz      7423: <p>Used to do bulk builds. If an appropriate binary
                   7424:          package already exists, no action is taken. If not, this
                   7425:          target will compile, install and package it (and its
                   7426:          depends, if <code class="varname">PKG_DEPENDS</code> is set
                   7427:          properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, &#8220;Configuration&#8221;</a>).
                   7428:          After creating the binary package, the sources, the
                   7429:          just-installed package and its required packages are
                   7430:          removed, preserving free disk space.</p>
                   7431: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7432:          all packages installed on a system!</em></span></p>
1.75      rillig   7433: </dd>
                   7434: <dt><span class="term">bulk-install</span></dt>
                   7435: <dd>
1.88      wiz      7436: <p>Used during bulk-installs to install required
                   7437:          packages. If an up-to-date binary package is available,
                   7438:          it will be installed via <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
                   7439:          <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87      wiz      7440:          but the installed binary won't be removed.</p>
1.88      wiz      7441: <p>A binary package is considered
                   7442:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
                   7443:          <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
                   7444: <div class="itemizedlist"><ul type="disc">
                   7445: <li><p>None of the package's files
                   7446:              (<code class="filename">Makefile</code>, ...) were modified
                   7447:              since it was built.</p></li>
                   7448: <li><p>None of the package's required (binary)
                   7449:              packages were modified since it was built.</p></li>
1.75      rillig   7450: </ul></div>
1.88      wiz      7451: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7452:          all packages installed on a system!</em></span></p>
1.75      rillig   7453: </dd>
                   7454: </dl></div>
                   7455: </div>
                   7456: </div>
                   7457: <div class="chapter" lang="en">
                   7458: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7459: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7460: <div class="toc">
                   7461: <p><b>Table of Contents</b></p>
                   7462: <dl>
1.90      rillig   7463: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   7464: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   7465: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97      rillig   7466: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7467: </dl>
                   7468: </div>
1.87      wiz      7469: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7470: by pkgsrc and also for individual packages to define what commands
                   7471: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7472: or for later run-time of an installed packaged (such as
                   7473: <code class="varname">DEPENDS</code>).
                   7474: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7475: package will not be used.</p>
                   7476: <p>When building a package, the replacement tools are
1.75      rillig   7477: made available in a directory (as symlinks or wrapper scripts)
                   7478: that is early in the executable search path. Just like the buildlink
1.87      wiz      7479: system, this helps with consistent builds.</p>
                   7480: <p>A tool may be needed to help build a specific package. For example,
                   7481: perl, GNU make (gmake) or yacc may be needed.</p>
                   7482: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7483: tool may be inefficient for building a package with pkgsrc.
                   7484: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7485: yacc) or a better sed.</p>
                   7486: <p>The tools used by a package can be listed by running
                   7487: <span><strong class="command">make show-tools</strong></span>.</p>
1.75      rillig   7488: <div class="sect1" lang="en">
                   7489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7490: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7491: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7492: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75      rillig   7493: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
                   7494: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
                   7495: These can be seen by running:
1.87      wiz      7496: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   7497: <p>If a package needs a specific program to build
1.75      rillig   7498: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7499: to define the tools needed.</p>
1.75      rillig   7500: </div>
                   7501: <div class="sect1" lang="en">
                   7502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7503: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7504: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7505: and not the native version for a build dependency.
                   7506: And the :run means that it is used for a
                   7507: run-time dependencies also (and becomes a DEPENDS).
                   7508: The default is a build dependency which can be set with
                   7509: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7510: and pkg-config:build.)</p>
1.75      rillig   7511: <pre class="programlisting">
                   7512: USE_TOOLS+=     mktemp:pkgsrc
                   7513: USE_TOOLS+=     gmake perl:run pkg-config
                   7514: </pre>
1.87      wiz      7515: <p>When using the tools framework, a
1.75      rillig   7516: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7517: which contains the full path to the appropriate tool. For example,
                   7518: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7519: on Linux systems.</p>
                   7520: <p>If you always need a pkgsrc version of the
1.75      rillig   7521: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7522: </p>
                   7523: </div>
                   7524: <div class="sect1" lang="en">
                   7525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7526: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7527: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7528: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7529: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7530: the name of the common tools. For example:</p>
                   7531: <pre class="programlisting">
                   7532: .if exists(/usr/bin/bzcat)
                   7533: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7534: .elif exists(/usr/bin/bzip2)
                   7535: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7536: .endif
1.69      rillig   7537: 
1.75      rillig   7538: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7539: </pre>
                   7540: </div>
1.97      rillig   7541: <div class="sect1" lang="en">
                   7542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7543: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
                   7544: <div class="qandaset">
                   7545: <dl>
                   7546: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
                   7547: </dt>
                   7548: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
                   7549:        tools?</a>
                   7550: </dt>
                   7551: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
                   7552:        package is using while being built? I want to know whether it
                   7553:        uses sed or not.</a>
                   7554: </dt>
                   7555: </dl>
                   7556: <table border="0" summary="Q and A Set">
                   7557: <col align="left" width="1%">
                   7558: <tbody>
                   7559: <tr class="question">
                   7560: <td align="left" valign="top">
1.103   ! wiz      7561: <a name="tools.new"></a><a name="id455178"></a><b>17.4.1.</b>
1.97      rillig   7562: </td>
                   7563: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7564: </tr>
                   7565: <tr class="answer">
                   7566: <td align="left" valign="top"></td>
                   7567: <td align="left" valign="top"><p>TODO</p></td>
                   7568: </tr>
                   7569: <tr class="question">
                   7570: <td align="left" valign="top">
1.103   ! wiz      7571: <a name="tools.listall"></a><a name="id455188"></a><b>17.4.2.</b>
1.97      rillig   7572: </td>
                   7573: <td align="left" valign="top"><p>How do I get a list of all available
                   7574:        tools?</p></td>
                   7575: </tr>
                   7576: <tr class="answer">
                   7577: <td align="left" valign="top"></td>
                   7578: <td align="left" valign="top"><p>TODO</p></td>
                   7579: </tr>
                   7580: <tr class="question">
                   7581: <td align="left" valign="top">
1.103   ! wiz      7582: <a name="tools.used"></a><a name="id455197"></a><b>17.4.3.</b>
1.97      rillig   7583: </td>
                   7584: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7585:        package is using while being built? I want to know whether it
                   7586:        uses sed or not.</p></td>
                   7587: </tr>
                   7588: <tr class="answer">
                   7589: <td align="left" valign="top"></td>
                   7590: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7591:        to do it.)</p></td>
                   7592: </tr>
                   7593: </tbody>
                   7594: </table>
                   7595: </div>
                   7596: </div>
1.75      rillig   7597: </div>
                   7598: <div class="chapter" lang="en">
                   7599: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   7600: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75      rillig   7601: <div class="toc">
                   7602: <p><b>Table of Contents</b></p>
                   7603: <dl>
1.90      rillig   7604: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75      rillig   7605: <dd><dl>
1.90      rillig   7606: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
                   7607: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   7608: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
                   7609: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
                   7610: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
                   7611: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
                   7612: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
                   7613: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
                   7614: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7615: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
                   7616: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7617: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7618: </dl></dd>
                   7619: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7620: <dd><dl>
                   7621: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7622: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   7623: </dl></dd>
                   7624: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7625: <dd><dl>
                   7626: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
                   7627: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7628: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
                   7629: </dl></dd>
                   7630: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
                   7631: <dd><dl>
                   7632: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
                   7633: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
                   7634: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
                   7635: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
                   7636: </dl></dd>
                   7637: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7638: <dd><dl>
                   7639: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7640: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
                   7641: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</a></span></dt>
                   7642: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
                   7643: </dl></dd>
                   7644: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7645: <dd><dl>
                   7646: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
                   7647: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100     rillig   7648: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103   ! wiz      7649: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
        !          7650: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
        !          7651: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
        !          7652: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
        !          7653: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
        !          7654: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
        !          7655: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
        !          7656: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
        !          7657: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
        !          7658: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
        !          7659: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
        !          7660: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
        !          7661: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
        !          7662: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
        !          7663: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87      wiz      7664:     emulation</a></span></dt>
1.103   ! wiz      7665: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
        !          7666: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7667: </dl></dd>
1.90      rillig   7668: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7669: </dl>
                   7670: </div>
                   7671: <div class="sect1" lang="en">
                   7672: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   7673: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75      rillig   7674: <div class="sect2" lang="en">
                   7675: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7676: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7677: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7678:     different platforms. As a result, it is important to ensure,
                   7679:     where possible, that packages in pkgsrc are portable. This
                   7680:     chapter mentions some particular details you should pay
                   7681:     attention to while working on pkgsrc.</p>
1.78      rillig   7682: </div>
                   7683: <div class="sect2" lang="en">
                   7684: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   7685: <a name="pulling-vars-from-etc-mk.conf"></a>18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code>
                   7686: </h3></div></div></div>
1.78      rillig   7687: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7688:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
                   7689:     which is <code class="filename">/etc/mk.conf</code> by default. When you
                   7690:     want to use those variables in the preprocessor directives of
                   7691:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
                   7692:     <code class="literal">.for</code>), you need to include the file
                   7693:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7694:     loads the user preferences.</p>
1.78      rillig   7695: <p>But note that some variables may not be completely defined
1.87      wiz      7696:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7697:     included, as they may contain references to variables that are
                   7698:     not yet defined. In shell commands this is no problem, since
                   7699:     variables are actually macros, which are only expanded when they
                   7700:     are used. But in the preprocessor directives mentioned above and
                   7701:     in dependency lines (of the form <code class="literal">target:
                   7702:     dependencies</code>) the variables are expanded at load
                   7703:     time.</p>
1.78      rillig   7704: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7705: <h3 class="title">Note</h3>
                   7706: <p>Currently there is no exhaustive list of all
1.87      wiz      7707:     variables that tells you whether they can be used at load time
                   7708:     or only at run time, but it is in preparation.</p>
1.78      rillig   7709: </div>
                   7710: </div>
                   7711: <div class="sect2" lang="en">
                   7712: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7713: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88      wiz      7714: <p>Occasionally, packages require interaction from the user,
                   7715:     and this can be in a number of ways:</p>
1.78      rillig   7716: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7717: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7718:        interaction such as entering username/password or accepting a
                   7719:        license on a web page.</p></li>
1.88      wiz      7720: <li><p>When extracting the distfiles, some packages may ask for
                   7721:        passwords.</p></li>
1.78      rillig   7722: <li><p>help to configure the package before it is built</p></li>
                   7723: <li><p>help during the build process</p></li>
                   7724: <li><p>help during the installation of a package</p></li>
                   7725: </ul></div>
1.88      wiz      7726: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7727:     provided to notify the pkgsrc mechanism of an interactive stage
                   7728:     which will be needed, and this should be set in the package's
                   7729:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7730: <pre class="programlisting">
1.100     rillig   7731: INTERACTIVE_STAGE=      build
1.87      wiz      7732:     </pre>
1.78      rillig   7733: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7734: <pre class="programlisting">
1.100     rillig   7735: INTERACTIVE_STAGE=      configure install
1.87      wiz      7736:     </pre>
1.88      wiz      7737: <p>The user can then decide to skip this package by setting the
                   7738:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7739: </div>
                   7740: <div class="sect2" lang="en">
                   7741: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7742: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7743: <p>Authors of software can choose the licence under which
                   7744:     software can be copied.  This is due to copyright law, and reasons
                   7745:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7746:     system recognizes that there are a number of licenses which some
                   7747:     users may find objectionable or difficult or impossible to comply
                   7748:     with.  The Free Software Foundation has declared some licenses
                   7749:     "Free", and the Open Source Initiative has a definition of "Open
                   7750:     Source".  The pkgsrc system, as a policy choice, does not label
                   7751:     packages which have licenses that are Free or Open Source.
                   7752:     However, packages without a license meeting either of those tests
                   7753:     are labeled with a license tag denoting the license.  Note that a
                   7754:     package with no license to copy trivially does not meet either the
                   7755:     Free or Open Source test.</p>
                   7756: <p>For packages which are not Free or Open Source, pkgsrc will
                   7757:     not build the package unless the user has indicated to pkgsrc that
                   7758:     packages with that particular license may be built.  Note that
                   7759:     this documentation avoids the term "accepted the license".  The
                   7760:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7761:     accidentally building a package with a non-free license;
1.98      wiz      7762:     judgement and responsibility remain with the user.  (Installation
                   7763:     of binary packages are not currently subject to this mechanism;
                   7764:     this is a bug.)</p>
                   7765: <p>One might want to only install packages with a BSD license,
                   7766:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7767:     does not provide a way to do this.  It might be possible to put in
                   7768:     tags for free licenses, and have a default
                   7769:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7770:     widely viewed as having a very poor ratio of benefit to
                   7771:     work.</p>
1.78      rillig   7772: <p>The license tag mechanism is intended to address
1.87      wiz      7773:     copyright-related issues surrounding building, installing and
                   7774:     using a package, and not to address redistribution issues (see
                   7775:     <code class="varname">RESTRICTED</code> and
                   7776:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7777:     definition of licenses for which tags are not needed implies
                   7778:     that packages with redistribution restrictions should have
1.98      wiz      7779:     tags, because Free or Open Source programs do not have
                   7780:     redistribution restrictions.</p>
                   7781: <p>Denoting that a package may be copied according to a
                   7782:     particular license is done by placing the license in
1.87      wiz      7783:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7784:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7785:     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      7786: <pre class="programlisting">
1.100     rillig   7787: LICENSE=        xv-license
1.87      wiz      7788:     </pre>
                   7789: <p>When trying to build, the user will get a notice that the
1.98      wiz      7790:     package is covered by a license which has not been placed in the
                   7791:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7792: <pre class="programlisting">
1.100     rillig   7793: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7794: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7795: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7796: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7797: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7798: *** Error code 1
1.87      wiz      7799:     </pre>
1.78      rillig   7800: <p>The license can be viewed with <span><strong class="command">make
1.98      wiz      7801:     show-license</strong></span>, and if the user so chooses, the line
                   7802:     printed above can be added to <code class="filename">/etc/mk.conf</code> to
                   7803:     convey to pkgsrc that it should not in the future fail because of
                   7804:     that license:</p>
1.78      rillig   7805: <pre class="programlisting">
1.100     rillig   7806: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7807:     </pre>
1.98      wiz      7808: <p>When adding a package with a new license, the license text
                   7809:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7810:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7811:     directory.</p>
1.98      wiz      7812: <p>When the license changes (in a way other than formatting),
                   7813:     please make sure that the new license has a different name (e.g.,
                   7814:     append the version number if it exists, or the date).  Just
                   7815:     because a user told pkgsrc to build programs under a previous
                   7816:     version of a license does not mean that pkgsrc should build
1.99      rillig   7817:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7818:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7819:     test is a mechanistic test of whether a particular text has been
                   7820:     approved by either of two bodies.</p>
1.78      rillig   7821: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7822:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7823:     is deprecated because it does not crisply refer to a particular
                   7824:     license text.  Another problem with such usage is that it does not
                   7825:     enable a user to tell pkgsrc to proceed for a single package
                   7826:     without also telling pkgsrc to proceed for all packages with that
                   7827:     tag.</p>
1.75      rillig   7828: </div>
                   7829: <div class="sect2" lang="en">
                   7830: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7831: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7832: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7833:     Because a license tag is required unless the package is Free or
                   7834:     Open Source, all packages with restrictions should have license
                   7835:     tags.  By declaring the restrictions, package tools can
                   7836:     automatically refrain from e.g. placing binary packages on FTP
                   7837:     sites.</p>
                   7838: <p>There are four restrictions that may be encoded, which are
                   7839:     the cross product of sources (distfiles) and binaries not being
                   7840:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7841:     language in any license, and because non-Free licenses tend to be
                   7842:     different from each other, pkgsrc adopts a definition of FTP and
                   7843:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7844:     should not be made available over the Internet at no charge.
                   7845:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7846:     made available on some kind of media, together with other source
                   7847:     and binary packages, and which is sold for a distribution charge.
                   7848:     </p>
                   7849: <p>In order to encode these restrictions, the package system
1.87      wiz      7850:     defines five make variables that can be set to note these
                   7851:     restrictions:</p>
1.75      rillig   7852: <div class="itemizedlist"><ul type="disc">
                   7853: <li>
                   7854: <p><code class="varname">RESTRICTED</code></p>
                   7855: <p>This variable should be set whenever a restriction
1.87      wiz      7856:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7857:        string containing the reason for the restriction.  It should
                   7858:        be understood that those wanting to understand the restriction
                   7859:        will have to read the license, and perhaps seek advice of
                   7860:        counsel.</p>
1.75      rillig   7861: </li>
                   7862: <li>
                   7863: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7864: <p>Binaries may not be placed on CD-ROM containing other
                   7865:        binary packages, for which a distribution charge may be made.
                   7866:        In this case, set this variable to
                   7867:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7868: </li>
                   7869: <li>
                   7870: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7871: <p>Binaries may not made available on the Internet without
                   7872:        charge.  In this case, set this variable to
                   7873:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7874:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7875: </li>
                   7876: <li>
                   7877: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7878: <p>Distfiles may not be placed on CD-ROM, together with
                   7879:        other distfiles, for which a fee may be charged.  In this
                   7880:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7881:        </p>
1.75      rillig   7882: </li>
                   7883: <li>
                   7884: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7885: <p>Distfiles may not made available via FTP at no charge.
                   7886:        In this case, set this variable to
                   7887:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7888:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7889: </li>
                   7890: </ul></div>
                   7891: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7892:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7893:     generic make variables to denote restrictions is deprecated,
                   7894:     because they unconditionally prevent users from generating
                   7895:     binary packages!</p>
1.75      rillig   7896: </div>
                   7897: <div class="sect2" lang="en">
                   7898: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   7899: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7900: <p>Your package may depend on some other package being present
1.88      wiz      7901:     - and there are various ways of expressing this dependency.
                   7902:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7903:     <code class="varname">DEPENDS</code> definitions, the
                   7904:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7905:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7906:     to handle dependencies, and which uses the variables named above.
1.90      rillig   7907:     See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7908: <p>The basic difference between the two variables is as
1.87      wiz      7909:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7910:     that pre-requisite in the binary package so it will be pulled in
                   7911:     when the binary package is later installed, whilst the
                   7912:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7913:     dependency that is only needed for building the package.</p>
1.75      rillig   7914: <p>This means that if you only need a package present whilst
1.87      wiz      7915:     you are building, it should be noted as a
                   7916:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7917: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7918:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7919: <pre class="programlisting">
1.100     rillig   7920: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7921:     </pre>
1.75      rillig   7922: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7923:     may include any of the wildcard version numbers recognized by
                   7924:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75      rillig   7925: <div class="orderedlist"><ol type="1">
                   7926: <li>
                   7927: <p>If your package needs another package's binaries or
1.87      wiz      7928:        libraries to build or run, and if that package has a
                   7929:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7930: <pre class="programlisting">
1.100     rillig   7931: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7932:        </pre>
1.75      rillig   7933: </li>
                   7934: <li>
                   7935: <p>If your package needs to use another package to build
1.87      wiz      7936:        itself and there is no <code class="filename">buildlink3.mk</code>
                   7937:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   7938:        definition:</p>
1.75      rillig   7939: <pre class="programlisting">
1.100     rillig   7940: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      7941:        </pre>
1.75      rillig   7942: </li>
                   7943: <li>
                   7944: <p>If your package needs a library with which to link and
1.76      rillig   7945:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      7946:        available, this is specified using the
                   7947:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   7948: <pre class="programlisting">
1.100     rillig   7949: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      7950:        </pre>
1.75      rillig   7951: <p>You can also use wildcards in package dependences:</p>
                   7952: <pre class="programlisting">
1.100     rillig   7953: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      7954:        </pre>
1.75      rillig   7955: <p>Note that such wildcard dependencies are retained when
1.87      wiz      7956:        creating binary packages.  The dependency is checked when
                   7957:        installing the binary package and any package which matches
                   7958:        the pattern will be used.  Wildcard dependencies should be
                   7959:        used with care.</p>
1.75      rillig   7960: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      7961:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   7962:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   7963:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7964: <p>Wildcards can also be used to specify that a package
1.87      wiz      7965:        will only build against a certain minimum version of a
                   7966:        pre-requisite:</p>
1.75      rillig   7967: <pre class="programlisting">
1.100     rillig   7968: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      7969:        </pre>
1.75      rillig   7970: <p>This means that the package will build against version
1.87      wiz      7971:        3.5.4 of the tiff library or newer.  Such a dependency may
                   7972:        be warranted if, for example, the API of the library has
                   7973:        changed with version 3.5.4 and a package would not compile
                   7974:        against an earlier version of tiff.</p>
1.75      rillig   7975: <p>Please note that such dependencies should only be
1.87      wiz      7976:        updated if a package requires a newer pre-requisite, but
1.93      rillig   7977:        not to denote recommendations such as
1.87      wiz      7978:        ABI changes that do not prevent a package from building
                   7979:        correctly.  Such recommendations can be expressed using
                   7980:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   7981: <pre class="programlisting">
1.100     rillig   7982: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      7983:        </pre>
1.75      rillig   7984: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      7985:        line, this denotes that while a package will build against
                   7986:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   7987:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   7988:        dependencies unless explicitly ignored (in which case a
                   7989:        warning will be printed).</p>
1.75      rillig   7990: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      7991:        use the required <code class="varname">DEPENDS</code>, set
                   7992:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   7993:        it easier and faster to update packages built using pkgsrc,
                   7994:        since older compatible dependencies can continue to be
                   7995:        used. This is useful for people who watch their rebuilds
                   7996:        very carefully; it is not very good as a general-purpose
                   7997:        hammer.  If you use it, you need to be mindful of possible
                   7998:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   7999: <p>Packages that are built with recommendations ignored
1.87      wiz      8000:        may not be uploaded to ftp.NetBSD.org by developers and
                   8001:        should not be used across different systems that may have
                   8002:        different versions of binary packages installed.</p>
1.75      rillig   8003: <p>For security fixes, please update the package
1.90      rillig   8004:        vulnerabilities file. See <a href="#security-handling" title="18.1.10. Handling packages with security problems">Section 18.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      8005:        information.</p>
1.75      rillig   8006: </li>
                   8007: <li>
                   8008: <p>If your package needs some executable to be able to run
1.87      wiz      8009:        correctly and if there's no
                   8010:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8011:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   8012:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87      wiz      8013:        be able to execute the latex binary from the teTeX package
                   8014:        when it runs, and that is specified:</p>
1.75      rillig   8015: <pre class="programlisting">
1.100     rillig   8016: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      8017:        </pre>
1.75      rillig   8018: <p>The comment about wildcard dependencies from previous
1.87      wiz      8019:        paragraph applies here, too.</p>
1.75      rillig   8020: </li>
                   8021: </ol></div>
                   8022: <p>If your package needs files from another package to build,
1.87      wiz      8023:     add the relevant distribution files to
                   8024:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   8025:     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      8026:     (It relies on the jpeg sources being present in source form
                   8027:     during the build.)</p>
1.75      rillig   8028: </div>
                   8029: <div class="sect2" lang="en">
                   8030: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8031: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8032: <p>Your package may conflict with other packages a user might
1.87      wiz      8033:     already have installed on his system, e.g. if your package
1.88      wiz      8034:     installs the same set of files as another package in the pkgsrc
                   8035:     tree.</p>
1.75      rillig   8036: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8037:     space-separated list of packages (including version string) your
                   8038:     package conflicts with.</p>
1.91      rillig   8039: <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>
                   8040:     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      8041:     install the same shared library, thus you set in
                   8042:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8043: <pre class="programlisting">
1.100     rillig   8044: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8045:     </pre>
                   8046: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8047: <pre class="programlisting">
1.100     rillig   8048: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8049:     </pre>
1.75      rillig   8050: <p>Packages will automatically conflict with other packages
1.87      wiz      8051:     with the name prefix and a different version
                   8052:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8053:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8054: </div>
                   8055: <div class="sect2" lang="en">
                   8056: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8057: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8058: <p>There are several reasons why a package might be
1.88      wiz      8059:     instructed to not build under certain circumstances.  If the
1.87      wiz      8060:     package builds and runs on most platforms, the exceptions
                   8061:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8062:     the package builds and runs on a small handful of platforms,
                   8063:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8064:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8065:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8066:     (OS-version-platform) that can use glob-style
                   8067:     wildcards.</p>
1.88      wiz      8068: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8069:     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      8070:     backwards compatible with other versions of the OS, and should be
                   8071:     uploaded to a version specific directory on the FTP server.  Mark
                   8072:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8073:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8074:     the package system internals, but may be used in the
                   8075:     future.</p>
1.75      rillig   8076: <p>If the package should be skipped (for example, because it
1.87      wiz      8077:     provides functionality already provided by the system), set
1.88      wiz      8078:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8079:     the package should fail because some preconditions are not met,
                   8080:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8081:     message.</p>
1.75      rillig   8082: </div>
                   8083: <div class="sect2" lang="en">
                   8084: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8085: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8086: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8087:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8088:     be set in the package Makefile. This will be carried into any
                   8089:     binary package that is made from this pkgsrc entry. A
                   8090:     &#8220;<span class="quote">preserved</span>&#8221; package will
                   8091:     not be deleted using <a href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
                   8092:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8093: </div>
                   8094: <div class="sect2" lang="en">
                   8095: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8096: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8097: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8098:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
                   8099:     and after committing that file, use <span><strong class="command">make upload</strong></span>
                   8100:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8101: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8102:     <code class="varname">PKGREVISION</code> should be increased (this
                   8103:     is of course not necessary if the problem is fixed by using
                   8104:     a newer release of the software).</p>
1.75      rillig   8105: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8106:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8107: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8108:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8109: </div>
                   8110: <div class="sect2" lang="en">
                   8111: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8112: <a name="bumping-pkgrevision"></a>18.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   8113: <p>When making fixes to an existing package it can be useful
1.87      wiz      8114:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8115:     avoid conflicting with future versions by the original author, a
                   8116:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8117:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8118:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8119:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8120: <pre class="programlisting">
1.100     rillig   8121: DISTNAME=       foo-17.42
                   8122: PKGREVISION=    9
1.87      wiz      8123:     </pre>
1.75      rillig   8124: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8125:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8126:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8127:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8128:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8129: <p>When a new release of the package is released, the
1.87      wiz      8130:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8131:     minor release of the above package, things should be like:</p>
1.75      rillig   8132: <pre class="programlisting">
1.100     rillig   8133: DISTNAME=       foo-17.43
1.87      wiz      8134:     </pre>
                   8135: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8136:     non-trivial change in the resulting binary package.  Without a
                   8137:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8138:     version installed has no way of knowing that their package is out
                   8139:     of date.  Thus, changes without increasing
                   8140:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8141:     trivial that no reasonable person would want to upgrade", and this
                   8142:     is the rough test for when increasing
                   8143:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8144:     changes that do not merit increasing
                   8145:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8146: <div class="itemizedlist"><ul type="disc">
                   8147: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
                   8148:       or comments in Makefile.</p></li>
                   8149: <li><p>
                   8150:       Changing build variables if the resulting binary package is the same.</p></li>
                   8151: <li><p>
                   8152:       Changing <code class="filename">DESCR</code>.</p></li>
                   8153: <li><p>
                   8154:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8155: </ul></div>
1.87      wiz      8156: <p>Examples of changes that do merit an increase to
                   8157:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8158: <div class="itemizedlist"><ul type="disc">
                   8159: <li><p>
                   8160:       Security fixes</p></li>
                   8161: <li><p>
                   8162:       Changes or additions to a patch file</p></li>
                   8163: <li><p>
                   8164:       Changes to the <code class="filename">PLIST</code></p></li>
                   8165: </ul></div>
1.78      rillig   8166: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8167:     changes.</p>
1.75      rillig   8168: </div>
1.79      rillig   8169: <div class="sect2" lang="en">
                   8170: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8171: <a name="fixes.subst"></a>18.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8172: <p>When you want to replace the same text in multiple files
1.87      wiz      8173:     or when the replacement text varies, patches alone cannot help.
                   8174:     This is where the SUBST framework comes in. It provides an
                   8175:     easy-to-use interface for replacing text in files.
                   8176:     Example:</p>
                   8177: <pre class="programlisting">
1.100     rillig   8178: SUBST_CLASSES+=                 fix-paths
                   8179: SUBST_STAGE.fix-paths=          pre-configure
                   8180: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8181: SUBST_FILES.fix-paths=          src/*.c
                   8182: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8183: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8184: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8185:     </pre>
1.79      rillig   8186: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8187:     that are used to identify the different SUBST blocks that are
                   8188:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8189:     important to always use the <code class="literal">+=</code> operator with
                   8190:     this variable. Otherwise some substitutions may be
                   8191:     skipped.</p>
1.79      rillig   8192: <p>The remaining variables of each SUBST block are
1.87      wiz      8193:     parameterized with the identifier from the first line
                   8194:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8195:     parameters to a function call.</p>
1.79      rillig   8196: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8197:     which the replacement will take place. All combinations of
                   8198:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8199:     <code class="literal">post-</code> together with a phase name are
                   8200:     possible, though only few are actually used. Most commonly used
                   8201:     are <code class="literal">post-patch</code> and
                   8202:     <code class="literal">pre-configure</code>. Of these two,
                   8203:     <code class="literal">pre-configure</code> should be preferred because
                   8204:     then it is possible to run <span><strong class="command">bmake patch</strong></span> and
                   8205:     have the state after applying the patches but before making any
                   8206:     other changes. This is especially useful when you are debugging
                   8207:     a package in order to create new patches for it. Similarly,
                   8208:     <code class="literal">post-build</code> is preferred over
                   8209:     <code class="literal">pre-install</code>, because the install phase should
                   8210:     generally be kept as simple as possible. When you use
                   8211:     <code class="literal">post-build</code>, you have the same files in the
                   8212:     working directory that will be installed later, so you can check
                   8213:     if the substitution has succeeded.</p>
1.79      rillig   8214: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8215:     that is printed just before the substitution is done.</p>
1.79      rillig   8216: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8217:     globbing patterns that specifies the files in which the
                   8218:     substitution will take place. The patterns are interpreted
                   8219:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8220: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87      wiz      8221:     <a href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
                   8222:     command should be prefixed with <code class="literal">-e</code>, so that
                   8223:     all SUBST blocks look uniform.</p>
1.79      rillig   8224: <p>There are some more variables, but they are so seldomly
1.87      wiz      8225:     used that they are only documented in the
                   8226:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8227: </div>
1.75      rillig   8228: </div>
                   8229: <div class="sect1" lang="en">
                   8230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8231: <a name="fixes.fetch"></a>18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8232: <div class="sect2" lang="en">
                   8233: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8234: <a name="no-plain-download"></a>18.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8235: <p>If you need to download from a dynamic URL you can set
1.87      wiz      8236:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
                   8237:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8238:     with the name of each file to download as an argument, expecting
                   8239:     it to output the URL of the directory from which to download
1.91      rillig   8240:     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      8241:     example of this usage.</p>
1.75      rillig   8242: <p>If the download can't be automated, because the user must
1.87      wiz      8243:     submit personal information to apply for a password, or must pay
                   8244:     for the source, or whatever, you can set
                   8245:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8246:     displayed to the user before aborting the build. Example:</p>
                   8247: <pre class="programlisting">
1.100     rillig   8248: FETCH_MESSAGE=  "Please download the files"
                   8249: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8250: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8251:     </pre>
1.75      rillig   8252: </div>
                   8253: <div class="sect2" lang="en">
                   8254: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8255: <a name="modified-distfiles-same-name"></a>18.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8256: <p>Sometimes authors of a software package make some
1.87      wiz      8257:     modifications after the software was released, and they put up a
                   8258:     new distfile without changing the package's version number. If a
                   8259:     package is already in pkgsrc at that time, the checksum will
                   8260:     no longer match. The contents of the new distfile should be
                   8261:     compared against the old one before changing anything, to make
                   8262:     sure the distfile was really updated on purpose, and that
                   8263:     no trojan horse or so crept in.
1.97      rillig   8264:     Please mention that the distfiles were compared and what was found
                   8265:     in your commit message.
1.87      wiz      8266:     Then, the correct way to work around this is to
                   8267:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8268:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8269:     <code class="varname">DISTFILES</code> and
1.93      rillig   8270:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8271:     subdirectory of the local distfiles directory.
                   8272:     (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
                   8273:     In case this
1.87      wiz      8274:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8275:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8276:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8277:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8278:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8279:     path in the filenames.
1.97      rillig   8280:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8281:     Furthermore, a mail to the package's authors seems appropriate
                   8282:     telling them that changing distfiles after releases without
                   8283:     changing the file names is not good practice.</p>
1.75      rillig   8284: </div>
                   8285: </div>
                   8286: <div class="sect1" lang="en">
                   8287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8288: <a name="fixes.configure"></a>18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8289: <div class="sect2" lang="en">
                   8290: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8291: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8292: <p>pkgsrc supports many different machines, with different
1.87      wiz      8293:     object formats like a.out and ELF, and varying abilities to do
                   8294:     shared library and dynamic loading at all. To accompany this,
                   8295:     varying commands and options have to be passed to the
                   8296:     compiler, linker, etc. to get the Right Thing, which can be
                   8297:     pretty annoying especially if you don't have all the machines
                   8298:     at your hand to test things.  The
1.91      rillig   8299:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87      wiz      8300:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8301:     both static and dynamic libraries from a set of source files,
                   8302:     thus being platform-independent.</p>
                   8303: <p>Here's how to use libtool in a package in seven simple
                   8304:     steps:</p>
1.75      rillig   8305: <div class="orderedlist"><ol type="1">
                   8306: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8307:        Makefile.</p></li>
1.75      rillig   8308: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8309:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8310:        add it to the definition of <code class="varname">CC</code>, if only
                   8311:        libraries are being built in a given Makefile. This one command
                   8312:        will build both PIC and non-PIC library objects, so you need not
                   8313:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8314: <li>
                   8315: <p>For the linking of the library, remove any
1.87      wiz      8316:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8317:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8318: <pre class="programlisting">
1.100     rillig   8319: ${LIBTOOL} --mode=link \
                   8320:     ${CC} -o ${.TARGET:.a=.la} \
                   8321:         ${OBJS:.o=.lo} \
                   8322:         -rpath ${PREFIX}/lib \
                   8323:         -version-info major:minor
1.87      wiz      8324:        </pre>
1.75      rillig   8325: <p>Note that the library is changed to have a
1.87      wiz      8326:        <code class="filename">.la</code> extension, and the objects are
                   8327:        changed to have a <code class="filename">.lo</code>
                   8328:        extension. Change <code class="varname">OBJS</code> as
                   8329:        necessary. This automatically creates all of the
                   8330:        <code class="filename">.a</code>,
                   8331:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8332:        necessary) in the build directory. Be sure to include
                   8333:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8334:        minor are zero, as libtool will otherwise strip off the
                   8335:        shared library version.</p>
1.75      rillig   8336: <p>From the libtool manual:</p>
                   8337: <pre class="programlisting">
1.100     rillig   8338: So, libtool library versions are described by three integers:
1.69      rillig   8339: 
1.100     rillig   8340: CURRENT
                   8341: The most recent interface number that this library implements.
1.69      rillig   8342: 
1.100     rillig   8343: REVISION
                   8344: The implementation number of the CURRENT interface.
1.69      rillig   8345: 
1.100     rillig   8346: AGE
                   8347: The difference between the newest and oldest interfaces that
                   8348: this library implements.  In other words, the library implements
                   8349: all the interface numbers in the range from number `CURRENT -
                   8350: AGE' to `CURRENT'.
1.1       grant    8351: 
1.100     rillig   8352: If two libraries have identical CURRENT and AGE numbers, then the
                   8353: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8354:        </pre>
1.75      rillig   8355: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8356:        different results for a.out and ELF (excluding symlinks)
                   8357:        in only one case. An ELF library of the form
                   8358:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8359:        will have a symlink of
                   8360:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8361:        on an a.out platform. This is handled
                   8362:        automatically.</p>
1.75      rillig   8363: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8364:        directory of the library being built.</p>
1.76      rillig   8365: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8366:        <code class="filename">.la</code> file, the other files will be
                   8367:        added automatically.</p>
1.75      rillig   8368: </li>
                   8369: <li>
1.76      rillig   8370: <p>When linking shared object (<code class="filename">.so</code>)
1.87      wiz      8371:        files, i.e. files that are loaded via <a href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
                   8372:        shared libraries, use &#8220;<span class="quote">-module
                   8373:        -avoid-version</span>&#8221; to prevent them getting version
                   8374:        tacked on.</p>
1.76      rillig   8375: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8376:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8377: </li>
                   8378: <li>
                   8379: <p>When linking programs that depend on these libraries
1.87      wiz      8380:        <span class="emphasis"><em>before</em></span> they are installed, preface
                   8381:        the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with &#8220;<span class="quote">${LIBTOOL}
                   8382:        --mode=link</span>&#8221;, and it will find the correct
                   8383:        libraries (static or shared), but please be aware that
                   8384:        libtool will not allow you to specify a relative path in
                   8385:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8386:        expects you to change that argument to be the
                   8387:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8388: <pre class="programlisting">
1.100     rillig   8389: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8390:        </pre>
1.75      rillig   8391: <p>should be changed to:</p>
                   8392: <pre class="programlisting">
1.100     rillig   8393: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8394:        </pre>
1.75      rillig   8395: <p>and it will do the right thing with the libraries.</p>
                   8396: </li>
                   8397: <li>
                   8398: <p>When installing libraries, preface the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
1.87      wiz      8399:        or <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with &#8220;<span class="quote">${LIBTOOL}
                   8400:        --mode=install</span>&#8221;, and change the library name to
                   8401:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8402: <pre class="programlisting">
1.100     rillig   8403: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8404:        </pre>
1.76      rillig   8405: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8406:        shared library, any needed symlinks, and run
                   8407:        <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8408: </li>
1.76      rillig   8409: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8410:        the <code class="filename">.la</code>
                   8411:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8412: </ol></div>
                   8413: </div>
                   8414: <div class="sect2" lang="en">
                   8415: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8416: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8417: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8418:     package Makefile. This will override the package's own libtool
                   8419:     in most cases.  For older libtool using packages,  libtool is
                   8420:     made by ltconfig script during the do-configure step; you can
                   8421:     check the libtool script location by doing <span><strong class="command">make
                   8422:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8423: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8424:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8425:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8426:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8427:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8428: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8429:     libraries built and installed, then use
                   8430:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8431: <p>If your package makes use of the platform-independent library
1.87      wiz      8432:     for loading dynamic shared objects, that comes with libtool
                   8433:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8434: <p>Some packages use libtool incorrectly so that the package
                   8435:     may not work or build in some circumstances. Some of the more
                   8436:     common errors are:</p>
1.75      rillig   8437: <div class="itemizedlist"><ul type="disc">
                   8438: <li>
                   8439: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8440:        executable or library. This in itself isn't a problem if one of two things
                   8441:        has been done:</p>
1.75      rillig   8442: <div class="orderedlist"><ol type="1">
                   8443: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8444:            <code class="filename">libfoo.la</code>, not
                   8445:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8446: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8447: </ol></div>
                   8448: </li>
                   8449: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8450:        The function lt_dlinit() should be called and the macro
                   8451:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8452:        executables.</p></li>
1.75      rillig   8453: </ul></div>
                   8454: </div>
                   8455: <div class="sect2" lang="en">
                   8456: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8457: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8458: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8459:     to regenerate the configure script and Makefile.in makefile
                   8460:     templates, then they should be executed in a pre-configure
                   8461:     target.</p>
1.75      rillig   8462: <p>For packages that need only autoconf:</p>
                   8463: <pre class="programlisting">
1.100     rillig   8464: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8465: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8466: ...
1.1       grant    8467: 
1.100     rillig   8468: pre-configure:
                   8469:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8470: 
1.100     rillig   8471: ...
1.87      wiz      8472:     </pre>
1.75      rillig   8473: <p>and for packages that need automake and autoconf:</p>
                   8474: <pre class="programlisting">
1.100     rillig   8475: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8476: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8477: ...
                   8478: 
                   8479: pre-configure:
                   8480:         set -e; cd ${WRKSRC}; \
                   8481:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8482: 
1.100     rillig   8483: ...
1.87      wiz      8484:     </pre>
1.75      rillig   8485: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8486:     require GNU Make.</p>
1.75      rillig   8487: <p>There are times when the configure process makes
1.87      wiz      8488:     additional changes to the generated files, which then causes
                   8489:     the build process to try to re-execute the automake sequence.
                   8490:     This is prevented by touching various files in the configure
                   8491:     stage. If this causes problems with your package you can set
                   8492:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8493:     Makefile.</p>
1.75      rillig   8494: </div>
                   8495: </div>
                   8496: <div class="sect1" lang="en">
                   8497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8498: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87      wiz      8499: <div class="sect2" lang="en">
                   8500: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8501: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8502: <p>Compilers for the C, C++, and Fortran languages comes with
                   8503:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8504:     is written in C and will hide all other compilers (via the wrapper
1.90      rillig   8505:     framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8506: <p>To declare which language's compiler a package needs, set
                   8507:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8508:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8509:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8510:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8511:     written in C++, usually need a C compiler for the configure
                   8512:     phase.</p>
                   8513: </div>
                   8514: <div class="sect2" lang="en">
                   8515: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8516: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87      wiz      8517: <p>If a program is written in Java, use the Java framework in
                   8518:     pkgsrc.  The package must include
                   8519:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8520:     provides the following variables:</p>
                   8521: <div class="itemizedlist"><ul type="disc">
                   8522: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8523:       dependency on the JDK is added.  If
                   8524:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8525:       there is only a runtime dependency on the JDK.  The default is
                   8526:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8527:       JDK.</p></li>
                   8528: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8529:       a package needs a Java2 implementation.  The supported values
                   8530:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8531:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8532:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8533:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8534:       above. This variable is not set by default.</p></li>
                   8535: </ul></div>
                   8536: </div>
                   8537: <div class="sect2" lang="en">
                   8538: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8539: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8540: <p>If your package contains interpreted perl scripts, add
                   8541:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8542:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8543:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8544:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8545:     that you want adjusted.  Every occurrence of
                   8546:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8547:     path to the perl executable.</p>
                   8548: <p>If a particular version of perl is needed, set the
                   8549:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8550:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.103   ! wiz      8551: <p>See <a href="#perl-modules" title="18.6.6. Packages installing perl modules">Section 18.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8552:     about handling perl modules.</p>
                   8553: </div>
                   8554: <div class="sect2" lang="en">
                   8555: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8556: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8557: <p>Currently, there is no special handling for other languages
                   8558:     in pkgsrc.  If a compiler package provides a
                   8559:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8560:     just add a (build) dependency on the appropriate compiler
                   8561:     package.</p>
                   8562: </div>
                   8563: </div>
                   8564: <div class="sect1" lang="en">
                   8565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8566: <a name="fixes.build"></a>18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8567: <p>The most common failures when building a package are that
                   8568:        some platforms do not provide certain header files, functions or
                   8569:        libraries, or they provide the functions in a library that the
                   8570:        original package author didn't know. To work around this, you
                   8571:        can rewrite the source code in most cases so that it does not
                   8572:        use the missing functions or provides a replacement function.</p>
                   8573: <div class="sect2" lang="en">
                   8574: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8575: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8576: <p>If a package already comes with a GNU configure script, the
                   8577:        preferred way to fix the build failure is to change the
                   8578:        configure script, not the code. In the other cases, you can
                   8579:        utilize the C preprocessor, which defines certain macros
                   8580:        depending on the operating system and hardware architecture it
                   8581:        compiles for. These macros can be queried using for example
                   8582:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8583:        system, hardware architecture and compiler has its own macro.
                   8584:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8585:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8586:        are all defined, you know that you are using NetBSD on an i386
                   8587:        compatible CPU, and your compiler is GCC.</p>
                   8588: <p>The list of the following macros for hardware and
                   8589:        operating system depends on the compiler that is used. For
                   8590:        example, if you want to conditionally compile code on Solaris,
                   8591:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8592:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8593: <div class="sect3" lang="en">
                   8594: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8595: <a name="fixes.build.cpp.os"></a>18.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8596: <p>To distinguish between 4.4 BSD-derived systems and the
                   8597:         rest of the world, you should use the following code.</p>
                   8598: <pre class="programlisting">
1.100     rillig   8599: #include &lt;sys/param.h&gt;
                   8600: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8601: /* BSD-specific code goes here */
                   8602: #else
                   8603: /* non-BSD-specific code goes here */
                   8604: #endif
1.75      rillig   8605: </pre>
1.77      rillig   8606: <p>If this distinction is not fine enough, you can also test
                   8607:        for the following macros.</p>
1.75      rillig   8608: <pre class="programlisting">
1.100     rillig   8609: FreeBSD     __FreeBSD__
                   8610: DragonFly   __DragonFly__
                   8611: Interix     __INTERIX
                   8612: IRIX        __sgi (TODO: get a definite source for this)
                   8613: Linux       linux, __linux, __linux__
                   8614: NetBSD      __NetBSD__
                   8615: OpenBSD     __OpenBSD__
                   8616: Solaris     sun, __sun
1.75      rillig   8617: </pre>
                   8618: </div>
                   8619: <div class="sect3" lang="en">
                   8620: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8621: <a name="fixes.build.cpp.arch"></a>18.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8622: <pre class="programlisting">
1.100     rillig   8623: i386        i386, __i386, __i386__
                   8624: MIPS        __mips
                   8625: SPARC       sparc, __sparc
1.75      rillig   8626: </pre>
                   8627: </div>
                   8628: <div class="sect3" lang="en">
                   8629: <div class="titlepage"><div><div><h4 class="title">
1.90      rillig   8630: <a name="fixes.build.cpp.compiler"></a>18.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8631: <pre class="programlisting">
1.100     rillig   8632: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8633: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8634: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8635: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8636: </pre>
                   8637: </div>
                   8638: </div>
1.78      rillig   8639: <div class="sect2" lang="en">
                   8640: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8641: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8642: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8643:         combinations of compiler version and architecture and almost
                   8644:         always relation to optimisation being enabled.  Common symptoms
                   8645:         are gcc internal errors or never finishing compiling a
1.78      rillig   8646:        file.</p>
                   8647: <p>Typically, a workaround involves testing the
                   8648:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8649:         optimisation for that combination of file,
                   8650:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8651:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8652:        number of examples.</p>
                   8653: </div>
                   8654: <div class="sect2" lang="en">
                   8655: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8656: <a name="undefined-reference"></a>18.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8657: <p>This error message often means that a package did not
1.78      rillig   8658:        link to a shared library it needs. The following functions are
                   8659:        known to cause this error message over and over.</p>
                   8660: <div class="informaltable">
                   8661: <a name="undefined-reference-functions"></a><table border="1">
                   8662: <colgroup>
                   8663: <col>
                   8664: <col>
                   8665: <col>
                   8666: </colgroup>
                   8667: <thead><tr>
                   8668: <th>Function</th>
                   8669: <th>Library</th>
                   8670: <th>Affected platforms</th>
                   8671: </tr></thead>
                   8672: <tbody>
                   8673: <tr>
                   8674: <td>accept, bind, connect</td>
                   8675: <td>-lsocket</td>
                   8676: <td>Solaris</td>
                   8677: </tr>
                   8678: <tr>
                   8679: <td>crypt</td>
                   8680: <td>-lcrypt</td>
                   8681: <td>DragonFly, NetBSD</td>
                   8682: </tr>
                   8683: <tr>
                   8684: <td>dlopen, dlsym</td>
                   8685: <td>-ldl</td>
                   8686: <td>Linux</td>
                   8687: </tr>
                   8688: <tr>
                   8689: <td>gethost*</td>
                   8690: <td>-lnsl</td>
                   8691: <td>Solaris</td>
                   8692: </tr>
                   8693: <tr>
                   8694: <td>inet_aton</td>
                   8695: <td>-lresolv</td>
                   8696: <td>Solaris</td>
                   8697: </tr>
                   8698: <tr>
                   8699: <td>nanosleep, sem_*, timer_*</td>
                   8700: <td>-lrt</td>
                   8701: <td>Solaris</td>
                   8702: </tr>
                   8703: <tr>
                   8704: <td>openpty</td>
                   8705: <td>-lutil</td>
                   8706: <td>Linux</td>
                   8707: </tr>
                   8708: </tbody>
                   8709: </table>
                   8710: </div>
                   8711: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8712:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8713:     -l<em class="replaceable"><code>foo</code></em></code> to the package
                   8714:     <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
                   8715:     bmake</strong></span>.</p>
1.92      rillig   8716: <div class="sect3" lang="en">
                   8717: <div class="titlepage"><div><div><h4 class="title">
                   8718: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
                   8719: <p>When you are using the SunPro compiler, there is another
                   8720: possibility. That compiler cannot handle the following code:</p>
                   8721: <pre class="programlisting">
1.100     rillig   8722: extern int extern_func(int);
1.93      rillig   8723: 
1.100     rillig   8724: static inline int
                   8725: inline_func(int x)
                   8726: {
1.92      rillig   8727:         return extern_func(x);
1.100     rillig   8728: }
1.93      rillig   8729: 
1.100     rillig   8730: int main(void)
                   8731: {
1.92      rillig   8732:         return 0;
1.100     rillig   8733: }
1.92      rillig   8734: </pre>
                   8735: <p>It generates the code for <code class="function">inline_func</code> even if
                   8736: that function is never used. This code then refers to
                   8737: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8738: solve this problem you can try to tell the package to disable inlining
                   8739: of functions.</p>
                   8740: </div>
1.87      wiz      8741: </div>
                   8742: <div class="sect2" lang="en">
                   8743: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8744: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8745: <p>Sometimes packages fail to build because the compiler runs
                   8746:     into an operating system specific soft limit.  With the
                   8747:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8748:     to unlimit the resources.  Currently, the allowed values are
                   8749:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8750:     Setting this variable is similar to running the shell builtin
                   8751:     <span><strong class="command">ulimit</strong></span> command to raise the maximum data
                   8752:     segment size or maximum stack size of a process, respectively, to
                   8753:     their hard limits.</p>
1.78      rillig   8754: </div>
1.75      rillig   8755: </div>
                   8756: <div class="sect1" lang="en">
                   8757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   8758: <a name="fixes.install"></a>18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8759: <div class="sect2" lang="en">
                   8760: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8761: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78      rillig   8762: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87      wiz      8763:     with some operating systems cannot create more than one
                   8764:     directory at a time. As such, you should call
                   8765:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8766: <pre class="programlisting">
1.100     rillig   8767: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8768: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8769:     </pre>
1.78      rillig   8770: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8771:     dir2</code></span>&#8221; to the
                   8772:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8773:     automatically do the right thing.</p>
1.75      rillig   8774: </div>
                   8775: <div class="sect2" lang="en">
                   8776: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   8777: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8778: <p>In general, documentation should be installed into
1.87      wiz      8779:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8780:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8781:     includes the version number of the package).</p>
1.84      wiz      8782: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8783:     directory where HTML documentation is installed with the
                   8784:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8785:     is needed because otherwise the documentation ends up in
                   8786:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8787:     places.</p>
                   8788: <p>An exception to the above is that library API documentation
1.91      rillig   8789:     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      8790:     browsers (devhelp) should be left at their default location, which
                   8791:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8792:     documentation can be recognized from files ending in
                   8793:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8794:     (It is also acceptable to install such files in
                   8795:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8796:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8797:     <code class="filename">.devhelp*</code> file must be directly in that
                   8798:     directory then, no additional subdirectory level is allowed in
                   8799:     this case. This is usually achieved by using
                   8800:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8801:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8802:     though.)</p>
1.75      rillig   8803: </div>
                   8804: <div class="sect2" lang="en">
                   8805: <div class="titlepage"><div><div><h3 class="title">
1.100     rillig   8806: <a name="installing-score-files"></a>18.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8807: <p>Certain packages, most of them in the games category, install
1.87      wiz      8808:     a score file that allows all users on the system to record their
                   8809:     highscores.  In order for this to work, the binaries need to be
                   8810:     installed setgid and the score files owned by the appropriate
                   8811:     group and/or owner (traditionally the "games" user/group).  The
                   8812:     following variables, documented in more detail in
                   8813:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8814:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8815:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8816:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8817: <p>Note that per default, setgid installation of games is
1.87      wiz      8818:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8819:     the other variables accordingly.</p>
1.75      rillig   8820: <p>A package should therefor never hard code file ownership or
1.87      wiz      8821:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8822:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8823:     correctly.</p>
1.75      rillig   8824: </div>
                   8825: <div class="sect2" lang="en">
                   8826: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      8827: <a name="destdir-support"></a>18.6.4. Adding DESTDIR support to packages</h3></div></div></div>
        !          8828: <div class="itemizedlist"><ul type="disc">
        !          8829: <li><p>All installation operations have to be prefixed with
        !          8830:       <code class="filename">${DESTDIR}</code>.</p></li>
        !          8831: <li><p>automake gets this DESTDIR mostly right
        !          8832:       automatically. Many manual rules and pre/post-install often are
        !          8833:       incorrect; fix them.</p></li>
        !          8834: <li><p>If files are installed with special owner/group
        !          8835:       either use @owner/@group in the <code class="filename">PLIST</code>
        !          8836:       (preferred) or use <code class="varname">SPECIAL_PERMS</code>
        !          8837:       (discouraged). Note that @owner/@group are sticky during
        !          8838:       install, keep this in mind.</p></li>
        !          8839: <li><p>In general, packages should support
        !          8840:       <code class="varname">UNPRIVILEGED</code> to be able to use
        !          8841:       DESTDIR.</p></li>
        !          8842: </ul></div>
        !          8843: </div>
        !          8844: <div class="sect2" lang="en">
        !          8845: <div class="titlepage"><div><div><h3 class="title">
        !          8846: <a name="hardcoded-paths"></a>18.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8847: <p>Your package may also contain scripts with hardcoded paths to
                   8848:       other interpreters besides (or as well as) perl.  To correct the
                   8849:       full pathname to the script interpreter, you need to set the
                   8850:       following definitions in your <code class="filename">Makefile</code> (we
                   8851:     shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
                   8852: <pre class="programlisting">
1.100     rillig   8853: REPLACE_INTERPRETER+=   tcl
                   8854: REPLACE.tcl.old=        .*/bin/tclsh
                   8855: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8856: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8857: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8858:     </pre>
1.75      rillig   8859: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8860: <h3 class="title">Note</h3>
                   8861: <p>Before March 2006, these variables were called
1.87      wiz      8862:     <code class="varname">_REPLACE.*</code> and
                   8863:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8864: </div>
                   8865: </div>
                   8866: <div class="sect2" lang="en">
                   8867: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      8868: <a name="perl-modules"></a>18.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8869: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8870:     the Makefile fragment
                   8871:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
                   8872:     <span><strong class="command">do-configure</strong></span> target for the standard perl
                   8873:     configuration for such modules as well as various hooks to tune
                   8874:     this configuration.  See comments in this file for
                   8875:     details.</p>
1.75      rillig   8876: <p>Perl5 modules will install into different places depending
1.87      wiz      8877:     on the version of perl used during the build process.  To
                   8878:     address this, pkgsrc will append lines to the
                   8879:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8880:     the installed <code class="filename">.packlist</code> file generated by
                   8881:     most perl5 modules.  This is invoked by defining
                   8882:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8883:     paths to packlist files, e.g.:</p>
1.75      rillig   8884: <pre class="programlisting">
1.100     rillig   8885: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8886:     </pre>
1.75      rillig   8887: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8888:     <code class="varname">PERL5_SITEARCH</code>, and
                   8889:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8890:     in which perl5 modules may be installed, and may be used by
                   8891:     perl5 packages that don't have a packlist.  These three
                   8892:     variables are also substituted for in the
                   8893:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8894: </div>
                   8895: <div class="sect2" lang="en">
                   8896: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      8897: <a name="faq.info-files"></a>18.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8898: <p>Some packages install info files or use the
1.87      wiz      8899:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8900:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8901:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8902:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8903:     handle registration of the info files in the Info directory
                   8904:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8905:     files registration is either provided by the system, or by a
                   8906:     special purpose package automatically added as dependency if
                   8907:     needed.</p>
1.75      rillig   8908: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8909:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8910:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8911:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8912: <p>The info files for the package should be listed in the
1.87      wiz      8913:     package <code class="filename">PLIST</code>; however any split info files
                   8914:     need not be listed.</p>
1.75      rillig   8915: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      8916:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   8917:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   8918:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   8919:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8920:     variable in the package <code class="filename">Makefile</code>. By
                   8921:     default, a minimum version of 3.12 is required. If the system
                   8922:     does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
                   8923:     does not match the required minimum, a build dependency on the
1.91      rillig   8924:     <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      8925:     be added automatically.</p>
1.75      rillig   8926: <p>The build and installation process of the software provided
1.87      wiz      8927:     by the package should not use the
                   8928:     <span><strong class="command">install-info</strong></span> command as the registration of
                   8929:     info files is the task of the package
                   8930:     <code class="filename">INSTALL</code> script, and it must use the
                   8931:     appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75      rillig   8932: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87      wiz      8933:     overriding scripts for the <span><strong class="command">install-info</strong></span> and
                   8934:     <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
                   8935:     in <code class="varname">PATH</code>.</p>
1.75      rillig   8936: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87      wiz      8937:     no effect except the logging of a message. The script overriding
                   8938:     <span><strong class="command">makeinfo</strong></span> logs a message and according to the
                   8939:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
                   8940:     <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8941: </div>
                   8942: <div class="sect2" lang="en">
                   8943: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      8944: <a name="manpages"></a>18.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8945: <p>All packages that install manual pages should install them
1.87      wiz      8946:     into the same directory, so that there is one common place to look
                   8947:     for them. In pkgsrc, this place is
                   8948:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8949:     should be used in packages. The default for
                   8950:     <code class="varname">PKGMANDIR</code> is
                   8951:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   8952:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   8953: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8954: <h3 class="title">Note</h3>
1.87      wiz      8955: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8956:     is far from complete.</p>
1.75      rillig   8957: </div>
1.81      rillig   8958: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8959:     <code class="filename">man/</code> as the top level directory for the man
                   8960:     page file entries, and the pkgsrc framework will convert as
                   8961:     needed. In all other places, the correct
                   8962:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8963: <p>Packages that are
                   8964:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   8965:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   8966:     <code class="filename">./configure</code>
                   8967:     --mandir switch to set where the man pages should be installed.
                   8968:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8969:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8970: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8971:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   8972:     to &#8220;<span class="quote">no</span>&#8221;.
                   8973:     Or if the <code class="filename">./configure</code> script uses
                   8974:     a non-standard use of --mandir, you can set
                   8975:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90      rillig   8976: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8977:     information on installation of compressed manual pages.</p>
1.75      rillig   8978: </div>
                   8979: <div class="sect2" lang="en">
                   8980: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      8981: <a name="gconf2-data-files"></a>18.6.9. Packages installing GConf2 data files</h3></div></div></div>
1.87      wiz      8982: <p>If a package installs <code class="filename">.schemas</code> or
                   8983:     <code class="filename">.entries</code> files, used by GConf2,
                   8984:     you need to take some extra steps to make sure they get registered
                   8985:     in the database:</p>
1.75      rillig   8986: <div class="orderedlist"><ol type="1">
1.76      rillig   8987: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87      wiz      8988:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   8989:        takes care of rebuilding the GConf2 database at installation and
                   8990:        deinstallation time, and tells the package where to install
                   8991:        GConf2 data files using some standard configure arguments.  It
                   8992:        also disallows any access to the database directly from the
                   8993:        package.</p></li>
1.75      rillig   8994: <li><p>Ensure that the package installs its
1.87      wiz      8995:        <code class="filename">.schemas</code> files under
                   8996:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8997:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8998:        need to manually patch the package.</p></li>
1.75      rillig   8999: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9000:        directory, as they will be handled automatically.  See
1.103   ! wiz      9001:        <a href="#faq.conf" title="8.13. How do I change the location of configuration files?">Section 8.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.75      rillig   9002: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87      wiz      9003:        your <code class="filename">Makefile</code> with a list of all
                   9004:        <code class="filename">.schemas</code> files installed by the package, if
                   9005:        any.  Names must not contain any directories in them.</p></li>
1.75      rillig   9006: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87      wiz      9007:        your <code class="filename">Makefile</code> with a
                   9008:        list of all <code class="filename">.entries</code> files installed by the
                   9009:        package, if any. Names must not contain any directories in
                   9010:        them.</p></li>
1.75      rillig   9011: </ol></div>
                   9012: </div>
                   9013: <div class="sect2" lang="en">
                   9014: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9015: <a name="scrollkeeper-data-files"></a>18.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87      wiz      9016: <p>If a package installs <code class="filename">.omf</code> files, used by
                   9017:     scrollkeeper, you need to take some extra steps to make sure they
                   9018:     get registered in the database:</p>
1.75      rillig   9019: <div class="orderedlist"><ol type="1">
                   9020: <li><p>Include
1.87      wiz      9021:        <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
                   9022:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   9023:        takes care of rebuilding the scrollkeeper database at
                   9024:        installation and deinstallation time, and disallows any access
                   9025:        to it directly from the package.</p></li>
1.75      rillig   9026: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9027:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9028:        will be handled automatically.</p></li>
1.76      rillig   9029: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87      wiz      9030:        the PLIST.  It will be handled by scrollkeeper.</p></li>
1.75      rillig   9031: </ol></div>
                   9032: </div>
                   9033: <div class="sect2" lang="en">
                   9034: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9035: <a name="x11-fonts"></a>18.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9036: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9037:     the fonts database in the directory where they get installed at
                   9038:     installation and deinstallation time.  This can be automatically
                   9039:     done by using the pkginstall framework.</p>
1.75      rillig   9040: <p>You can list the directories where fonts are installed in the
1.87      wiz      9041:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9042:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9043:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9044:     Also make sure that the database file
                   9045:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9046: <p>Note that you should not create new directories for fonts;
1.87      wiz      9047:     instead use the standard ones to avoid that the user needs to
                   9048:     manually configure his X server to find them.</p>
1.75      rillig   9049: </div>
                   9050: <div class="sect2" lang="en">
                   9051: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9052: <a name="gtk2-modules"></a>18.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9053: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9054:     take some extra steps to get them registered in the GTK2 database
                   9055:     properly:</p>
1.75      rillig   9056: <div class="orderedlist"><ol type="1">
                   9057: <li><p>Include
1.87      wiz      9058:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9059:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9060:       rebuilding the database at installation and deinstallation time.</p></li>
                   9061: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9062:       your package installs GTK2 immodules.</p></li>
                   9063: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9064:       GTK2 loaders.</p></li>
1.75      rillig   9065: <li>
1.87      wiz      9066: <p>Patch the package to not touch any of the GTK2
                   9067:       databases directly.  These are:</p>
1.75      rillig   9068: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9069: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9070: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9071: </ul></div>
                   9072: </li>
1.87      wiz      9073: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9074:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9075:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9076: </ol></div>
                   9077: </div>
                   9078: <div class="sect2" lang="en">
                   9079: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9080: <a name="sgml-xml-data"></a>18.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9081: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9082:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9083:     etc.), you need to take some extra steps:</p>
1.75      rillig   9084: <div class="orderedlist"><ol type="1">
                   9085: <li><p>Include
1.87      wiz      9086:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9087:        your <code class="filename">Makefile</code>, which takes care of
                   9088:        registering those files in system-wide catalogs at
                   9089:        installation and deinstallation time.</p></li>
1.75      rillig   9090: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9091:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9092: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9093:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9094: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9095:        to be added to the SGML catalog.  These come in groups of
                   9096:        three strings; see xmlcatmgr(1) for more information
                   9097:        (specifically, arguments recognized by the 'add' action).
                   9098:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9099: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9100:        to be added to the XML catalog.  These come in groups of three
                   9101:        strings; see xmlcatmgr(1) for more information (specifically,
                   9102:        arguments recognized by the 'add' action).  Note that you will
                   9103:        normally not use this variable.</p></li>
1.75      rillig   9104: </ol></div>
                   9105: </div>
                   9106: <div class="sect2" lang="en">
                   9107: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9108: <a name="mime-database"></a>18.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9109: <p>If a package provides extensions to the MIME database by
1.87      wiz      9110:     installing <code class="filename">.xml</code> files inside
                   9111:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9112:     need to take some extra steps to ensure that the database is kept
                   9113:     consistent with respect to these new files:</p>
1.75      rillig   9114: <div class="orderedlist"><ol type="1">
                   9115: <li><p>Include
1.87      wiz      9116:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9117:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9118:        this same directory, which is reserved for inclusion from
                   9119:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9120:        care of rebuilding the MIME database at installation and
                   9121:        deinstallation time, and disallows any access to it directly
                   9122:        from the package.</p></li>
1.75      rillig   9123: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9124:        <code class="filename">share/mime</code> directory,
                   9125:        <span class="emphasis"><em>except</em></span> for files saved under
                   9126:        <code class="filename">share/mime/packages</code>.  The former are
                   9127:        handled automatically by
                   9128:        the update-mime-database program, but the latter are
                   9129:        package-dependent and must be removed by the package that
                   9130:        installed them in the first place.</p></li>
1.76      rillig   9131: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9132:        from the PLIST.  They will be handled by the shared-mime-info
                   9133:        package.</p></li>
1.75      rillig   9134: </ol></div>
                   9135: </div>
                   9136: <div class="sect2" lang="en">
                   9137: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9138: <a name="intltool"></a>18.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9139: <p>If a package uses intltool during its build, add
                   9140:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9141:     which forces it to use the intltool package provided by pkgsrc,
                   9142:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9143: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9144:     latest available version; this way, the package benefits of any
                   9145:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9146: </div>
                   9147: <div class="sect2" lang="en">
                   9148: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9149: <a name="startup-scripts"></a>18.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9150: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9151:     the startup directory by default, but you can enable it, by adding
                   9152:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
                   9153:     <code class="filename">/etc/mk.conf</code>. This option will copy the scripts
                   9154:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9155:     it will automatically remove the scripts when the package is
                   9156:     deinstalled.</p>
1.75      rillig   9157: </div>
                   9158: <div class="sect2" lang="en">
                   9159: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9160: <a name="tex-packages"></a>18.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9161: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9162:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9163:     updated.</p>
1.75      rillig   9164: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9165: <h3 class="title">Note</h3>
                   9166: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9167:     packages should install files
                   9168:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9169:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9170: </div>
                   9171: <div class="orderedlist"><ol type="1">
                   9172: <li><p>Include
1.87      wiz      9173:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9174:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9175:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9176:       database at installation and deinstallation time.</p></li>
1.75      rillig   9177: <li>
                   9178: <p>If your package installs files into a texmf
1.87      wiz      9179:       tree other than the one
                   9180:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9181:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9182:       trees that need database update.</p>
1.75      rillig   9183: <p>If your package also installs font map files that need
1.87      wiz      9184:       to be registered using <span><strong class="command">updmap</strong></span>,
                   9185:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
                   9186:       such font map files.  Then <span><strong class="command">updmap</strong></span> will
                   9187:       be run automatically at installation/deinstallation to
                   9188:       enable/disable font map files for TeX output
                   9189:       drivers.</p>
1.75      rillig   9190: </li>
1.76      rillig   9191: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9192:       databases are included in <code class="filename">PLIST</code>, as
                   9193:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9194: </ol></div>
                   9195: </div>
1.85      jmmv     9196: <div class="sect2" lang="en">
                   9197: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9198: <a name="emulation-packages"></a>18.6.18. Packages supporting running binaries in
1.87      wiz      9199:     emulation</h3></div></div></div>
                   9200: <p>There are some packages that provide libraries and
                   9201:     executables for running binaries from a one operating system
                   9202:     on a different one (if the latter supports it).  One example
                   9203:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9204: <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      9205:     helps in extracting and packaging Linux rpm packages.</p>
                   9206: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
                   9207:     avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
                   9208:     if all libraries for each installed executable can be found by
                   9209:     the dynamic linker.  Since the standard dynamic linker is run,
                   9210:     this fails for emulation packages, because the libraries used
                   9211:     by the emulation are not in the standard directories.</p>
                   9212: </div>
                   9213: <div class="sect2" lang="en">
                   9214: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9215: <a name="hicolor-theme"></a>18.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9216: <p>If a package installs images under the
1.87      wiz      9217:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9218:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9219:     database, you need to take some extra steps to make sure that the
                   9220:     shared theme directory is handled appropriately and that the cache
                   9221:     database is rebuilt:</p>
1.85      jmmv     9222: <div class="orderedlist"><ol type="1">
                   9223: <li><p>Include
1.87      wiz      9224:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9225: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9226:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9227: <li><p>Ensure that the PLIST does not remove the shared icon
                   9228:          directories from the <code class="filename">share/icons/hicolor</code>
                   9229:          hierarchy because they will be handled automatically.</p></li>
                   9230: </ol></div>
                   9231: <p>The best way to verify that the PLIST is correct with
                   9232:       respect to the last two points is to regenerate it using
                   9233:       <span><strong class="command">make print-PLIST</strong></span>.</p>
                   9234: </div>
                   9235: <div class="sect2" lang="en">
                   9236: <div class="titlepage"><div><div><h3 class="title">
1.103   ! wiz      9237: <a name="desktop-files"></a>18.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9238: <p>If a package installs <code class="filename">.desktop</code> files
                   9239:       under <code class="filename">share/applications</code> and these include
                   9240:       MIME information, you need to take extra steps to ensure that they
                   9241:       are registered into the MIME database:</p>
                   9242: <div class="orderedlist"><ol type="1">
                   9243: <li><p>Include
                   9244:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9245: <li><p>Check the PLIST and remove the entry that refers to the
                   9246:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9247:          It will be handled automatically.</p></li>
                   9248: </ol></div>
                   9249: <p>The best way to verify that the PLIST is correct with
                   9250:       respect to the last point is to regenerate it using <span><strong class="command">make
                   9251:       print-PLIST</strong></span>.</p>
1.75      rillig   9252: </div>
                   9253: </div>
1.87      wiz      9254: <div class="sect1" lang="en">
                   9255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9256: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9257: <p>In some cases one does not have the time to solve a problem
                   9258:   immediately.  There are currently two ways to declare that one knows
                   9259:   that a package has problems.</p>
                   9260: <div class="itemizedlist"><ul type="disc">
                   9261: <li><p>The first way is to plainly mark it as broken.  For
                   9262:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9263:     reason why the package is broken (similar to the
                   9264:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9265:     the package will immediately be shown this message, and the build
                   9266:     will not be even tried.</p></li>
                   9267: <li><p>After each pkgsrc freeze period (a time when the
                   9268:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9269:     that were not building in the official branch build on the latest
                   9270:     NetBSD release will be marked as broken on that branch.  This is
                   9271:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9272:     branch name (or appending the branch name to it).  If a user tries
                   9273:     to build such a package and the build fails, the user gets a
                   9274:     message that says that the package was broken on the respective
                   9275:     branch(es).</p></li>
                   9276: </ul></div>
                   9277: <p>Both types of packages are removed from pkgsrc in irregular
                   9278:   intervals.</p>
                   9279: </div>
1.75      rillig   9280: </div>
                   9281: <div class="chapter" lang="en">
                   9282: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9283: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88      wiz      9284: <p>To check out all the gotchas when building a package, here are
                   9285:   the steps that I do in order to get a package working.  Please note
                   9286:   this is basically the same as what was explained in the previous
                   9287:   sections, only with some debugging aids.</p>
1.75      rillig   9288: <div class="itemizedlist"><ul type="disc">
1.88      wiz      9289: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=1</code> in
                   9290:       <code class="filename">/etc/mk.conf</code></p></li>
1.75      rillig   9291: <li>
1.91      rillig   9292: <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      9293:       create a directory for a new package, change into it, then run
                   9294:       <span><strong class="command">url2pkg</strong></span>:</p>
1.75      rillig   9295: <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>
                   9296: <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>
                   9297: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9298: </li>
1.76      rillig   9299: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9300: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87      wiz      9301: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75      rillig   9302: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9303:       configure step to the package's
                   9304:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9305: <li>
                   9306: <p>Make the package compile, doing multiple rounds of</p>
                   9307: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9308: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9309: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9310: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9311: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9312: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9313: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9314: <p>Doing this step as non-root user will ensure that no files
                   9315:       are modified that shouldn't be, especially during the build
                   9316:       phase.  <span><strong class="command">mkpatches</strong></span>,
                   9317:       <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91      rillig   9318:       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      9319:       package.</p>
1.75      rillig   9320: </li>
1.88      wiz      9321: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90      rillig   9322:       necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.75      rillig   9323: <li>
1.76      rillig   9324: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9325: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9326: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9327: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9328: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9329: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9330: <p>You usually need to be <code class="username">root</code> to do
                   9331:       this.  Look if there are any files left:</p>
1.75      rillig   9332: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9333: <p>If this reveals any files that are missing in
1.88      wiz      9334:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9335: </li>
                   9336: <li>
1.88      wiz      9337: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9338:       package again and make a binary package:</p>
1.75      rillig   9339: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9340: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9341: </li>
                   9342: <li>
                   9343: <p>Delete the installed package:</p>
1.88      wiz      9344: <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   9345: </li>
                   9346: <li>
1.88      wiz      9347: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
                   9348:       command, which shouldn't find anything now:</p>
1.75      rillig   9349: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9350: </li>
                   9351: <li>
                   9352: <p>Reinstall the binary package:</p>
1.93      rillig   9353: <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   9354: </li>
1.88      wiz      9355: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9356: <li>
1.91      rillig   9357: <p>Run <span><strong class="command">pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9358:       reports:</p>
1.75      rillig   9359: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9360: </li>
1.90      rillig   9361: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   9362: </ul></div>
                   9363: </div>
                   9364: <div class="chapter" lang="en">
                   9365: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9366: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75      rillig   9367: <div class="toc">
                   9368: <p><b>Table of Contents</b></p>
                   9369: <dl>
1.90      rillig   9370: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
                   9371: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9372: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9373: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
                   9374: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
                   9375: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9376: </dl>
                   9377: </div>
                   9378: <div class="sect1" lang="en">
                   9379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9380: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9381: <p>Our policy is that we accept binaries only from pkgsrc
                   9382:        developers to guarantee that the packages don't contain any
                   9383:        trojan horses etc. This is not to annoy anyone but rather to
                   9384:        protect our users! You're still free to put up your home-made
                   9385:        binary packages and tell the world where to get them. NetBSD
                   9386:        developers doing bulk builds and wanting to upload them please
                   9387:        see <a href="#bulk-upload" title="6.3.8. Uploading results of a bulk build">Section 6.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
                   9388: </div>
                   9389: <div class="sect1" lang="en">
                   9390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9391: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9392: <p>First, check that your package is complete, compiles and
1.90      rillig   9393:        runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75      rillig   9394:        document. Next, generate an uuencoded gzipped <a href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9395:        archive that contains all files that make up the package.
1.87      wiz      9396:        Finally, send this package to the pkgsrc bug tracking system,
                   9397:        either with the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
                   9398:        that, go to the web page
1.103   ! wiz      9399:        <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87      wiz      9400:        which contains some instructions and a link to a form, where you
                   9401:        can submit packages.</p>
                   9402: <p>In the form of the problem report, the category should be
                   9403:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9404:        and version number, and the description field should contain a
                   9405:        short description of your package (contents of the COMMENT
                   9406:        variable or DESCR file are OK). The uuencoded package data should
                   9407:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9408: <p>If you want to submit several packages, please send a
                   9409:        separate PR for each one, it's easier for us to track things
                   9410:        that way.</p>
                   9411: <p>Alternatively, you can also import new packages into
                   9412:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
                   9413:        homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
                   9414:        for details.</p>
                   9415: </div>
                   9416: <div class="sect1" lang="en">
                   9417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9418: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9419: <p>Please note all package additions, updates, moves, and
1.93      rillig   9420:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9421:        important to keep this file up to date and conforming to the
                   9422:        existing format, because it will be used by scripts to
                   9423:        automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
                   9424:        sites. Additionally, check the
1.76      rillig   9425:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9426:        for the package you updated or removed, in case it was mentioned
                   9427:        there.</p>
                   9428: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9429:        bumped, the change should appear in
1.93      rillig   9430:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9431:        related or otherwise relevant. Mass bumps that result from a
                   9432:        dependency being updated should not be mentioned. In all other
                   9433:        cases it's the developer's decision.</p>
                   9434: <p>There is a make target that helps in creating proper
1.93      rillig   9435:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span><strong class="command">make
1.75      rillig   9436:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9437:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9438:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9439:   file is up-to-date (to avoid having to resolve conflicts later-on)
                   9440:   and then to <span><strong class="command">cd</strong></span> to the package directory.  For
                   9441:   package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
                   9442:   For new packages, or package moves or removals, set the
                   9443:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9444:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.76      rillig   9445:   in <code class="filename">/etc/mk.conf</code> if your local login name is
1.75      rillig   9446:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9447:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9448: </div>
                   9449: <div class="sect1" lang="en">
                   9450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9451: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9452: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9453:   access to the pkgsrc repository. Please remember that cvs
                   9454:   imports files relative to the current working directory, and that
                   9455:   the pathname that you
                   9456:   give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
                   9457:   to place the files in the repository.  Newly created packages should be
                   9458:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9459:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9460: <pre class="programlisting">
1.100     rillig   9461: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9462: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9463: </pre>
1.87      wiz      9464: <p>Remember to move the directory from which you imported out of
1.75      rillig   9465:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9466:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9467:   package to the category's <code class="filename">Makefile</code>.</p>
                   9468: <p>The commit message of the initial import should include part of the
1.76      rillig   9469:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9470:   what the package is/does.</p>
                   9471: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9472:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9473:   and provides a consistent tag.</p>
1.75      rillig   9474: </div>
                   9475: <div class="sect1" lang="en">
                   9476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9477: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9478: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9479:   changes between old and new versions into the commit log when updating
1.87      wiz      9480:   a package. There are various reasons for this:</p>
1.75      rillig   9481: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9482: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9483:   or its information may be overwritten by newer information.</p></li>
                   9484: <li><p>Having the change information between old and new versions in our CVS
                   9485:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9486: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9487:   repository is very useful for people who read the pkgsrc-changes mailing
                   9488:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9489:   the package.</p></li>
1.75      rillig   9490: </ul></div>
1.87      wiz      9491: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9492:   has been released, it should not automatically be upgraded in the CVS
                   9493:   repository.  We prefer to be conservative in the packages that are
                   9494:   included in pkgsrc - development or beta packages are not really the
                   9495:   best thing for most places in which pkgsrc is used. Please use your
                   9496:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9497:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9498: </div>
                   9499: <div class="sect1" lang="en">
                   9500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9501: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9502: <div class="orderedlist"><ol type="1">
                   9503: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9504: <li>
                   9505: <p>Remove all CVS dirs.</p>
1.87      wiz      9506: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9507: <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      9508: <p>and use that for further work.</p>
1.75      rillig   9509: </li>
                   9510: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9511: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9512: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
                   9513: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
                   9514: place.</p></li>
                   9515: <li>
                   9516: <p>Check if any package depends on it:
                   9517: </p>
                   9518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9519: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9520: </li>
                   9521: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9522: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9523: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9524: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9525: <li>
                   9526: <p>Commit the changed and removed files:</p>
                   9527: <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      9528: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9529: </li>
                   9530: </ol></div>
                   9531: </div>
                   9532: </div>
                   9533: <div class="chapter" lang="en">
                   9534: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9535: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9536: <p>This section contains the answers to questions that may
                   9537:        arise when you are writing a package. If you don't find your
                   9538:        question answered here, first have a look in the other chapters,
                   9539:        and if you still don't have the answer, ask on the
                   9540:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9541: <div class="qandaset">
                   9542: <dl>
1.93      rillig   9543: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9544:        MAKEFLAGS, .MAKEFLAGS and
                   9545:        MAKE_FLAGS?</a>
                   9546: </dt>
1.93      rillig   9547: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9548:        MAKE, GMAKE and
                   9549:        MAKE_PROGRAM?</a>
                   9550: </dt>
1.93      rillig   9551: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9552:        CC, PKG_CC and
                   9553:        PKGSRC_COMPILER?</a>
                   9554: </dt>
1.93      rillig   9555: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9556:        BUILDLINK_LDFLAGS,
                   9557:        BUILDLINK_LDADD and
                   9558:        BUILDLINK_LIBS?</a>
                   9559: </dt>
1.93      rillig   9560: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9561:        VARNAME=BUILDLINK_PREFIX.foo
                   9562:        say it's empty?</a>
                   9563: </dt>
1.93      rillig   9564: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9565:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9566:        don't understand the := inside
                   9567:        it.</a>
                   9568: </dt>
1.93      rillig   9569: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9570:        developers?</a>
                   9571: </dt>
1.93      rillig   9572: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9573:        documentation?</a>
                   9574: </dt>
1.92      rillig   9575: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
                   9576: do?</a>
                   9577: </dt>
1.75      rillig   9578: </dl>
                   9579: <table border="0" summary="Q and A Set">
                   9580: <col align="left" width="1%">
                   9581: <tbody>
                   9582: <tr class="question">
                   9583: <td align="left" valign="top">
1.103   ! wiz      9584: <a name="devfaq.makeflags"></a><a name="id460078"></a><b>21.1.</b>
1.75      rillig   9585: </td>
                   9586: <td align="left" valign="top"><p>What is the difference between
                   9587:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9588:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9589: </tr>
                   9590: <tr class="answer">
1.91      rillig   9591: <td align="left" valign="top"></td>
1.75      rillig   9592: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
                   9593:        to the pkgsrc-internal invocations of <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
                   9594:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9595:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9596:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9597: </tr>
                   9598: <tr class="question">
                   9599: <td align="left" valign="top">
1.103   ! wiz      9600: <a name="devfaq.make"></a><a name="id460113"></a><b>21.2.</b>
1.75      rillig   9601: </td>
                   9602: <td align="left" valign="top"><p>What is the difference between
                   9603:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9604:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9605: </tr>
                   9606: <tr class="answer">
1.91      rillig   9607: <td align="left" valign="top"></td>
1.75      rillig   9608: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
                   9609:        <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
                   9610:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9611:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9612:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9613:        Make program that is used for building the
                   9614:        package.</p></td>
                   9615: </tr>
                   9616: <tr class="question">
                   9617: <td align="left" valign="top">
1.103   ! wiz      9618: <a name="devfaq.cc"></a><a name="id460151"></a><b>21.3.</b>
1.75      rillig   9619: </td>
                   9620: <td align="left" valign="top"><p>What is the difference between
                   9621:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9622:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9623: </tr>
                   9624: <tr class="answer">
1.91      rillig   9625: <td align="left" valign="top"></td>
1.75      rillig   9626: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9627:        compiler, which can be configured by the pkgsrc user.
                   9628:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9629:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9630:        path to a compiler, but the type of compiler that should be
1.76      rillig   9631:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9632:        information about the latter variable.</p></td>
                   9633: </tr>
                   9634: <tr class="question">
                   9635: <td align="left" valign="top">
1.103   ! wiz      9636: <a name="devfaq.bl3flags"></a><a name="id460224"></a><b>21.4.</b>
1.75      rillig   9637: </td>
                   9638: <td align="left" valign="top"><p>What is the difference between
                   9639:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9640:        <code class="varname">BUILDLINK_LDADD</code> and
                   9641:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9642: </tr>
                   9643: <tr class="answer">
1.91      rillig   9644: <td align="left" valign="top"></td>
1.75      rillig   9645: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9646: </tr>
                   9647: <tr class="question">
                   9648: <td align="left" valign="top">
1.103   ! wiz      9649: <a name="devfaq.bl3prefix"></a><a name="id460243"></a><b>21.5.</b>
1.75      rillig   9650: </td>
                   9651: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
                   9652:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9653:        say it's empty?</p></td>
                   9654: </tr>
                   9655: <tr class="answer">
1.91      rillig   9656: <td align="left" valign="top"></td>
1.75      rillig   9657: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9658:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9659:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
                   9660:        <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
                   9661:        command.</p></td>
                   9662: </tr>
1.78      rillig   9663: <tr class="question">
                   9664: <td align="left" valign="top">
1.103   ! wiz      9665: <a name="devfaq.master_sites"></a><a name="id460273"></a><b>21.6.</b>
1.78      rillig   9666: </td>
                   9667: <td align="left" valign="top"><p>What does
                   9668:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9669:        don't understand the <code class="literal">:=</code> inside
                   9670:        it.</p></td>
                   9671: </tr>
                   9672: <tr class="answer">
1.91      rillig   9673: <td align="left" valign="top"></td>
1.78      rillig   9674: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9675:        assignment operator, like you might expect at first sight.
                   9676:        Instead, it is a degenerate form of
                   9677:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
                   9678:        which is documented in the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
                   9679:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9680:        case of <code class="varname">MASTER_SITE_*</code>,
                   9681:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9682:        <em class="replaceable"><code>new_string</code></em> is
                   9683:        <code class="literal">package/</code>. That's where the
                   9684:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9685:        together.</p></td>
                   9686: </tr>
                   9687: <tr class="question">
                   9688: <td align="left" valign="top">
1.103   ! wiz      9689: <a name="devfaq.mailinglists"></a><a name="id460348"></a><b>21.7.</b>
1.78      rillig   9690: </td>
                   9691: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9692:        developers?</p></td>
                   9693: </tr>
                   9694: <tr class="answer">
1.91      rillig   9695: <td align="left" valign="top"></td>
1.78      rillig   9696: <td align="left" valign="top"><div class="variablelist"><dl>
1.103   ! wiz      9697: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9698: <dd><p>This is a list for technical discussions related
                   9699:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9700:        pkgsrc infrastructure, proposed new features, questions related
                   9701:        to porting pkgsrc to a new platform, advice for maintaining a
                   9702:        package, patches that affect many packages, help requests moved
                   9703:        from pkgsrc-users when an infrastructure bug is found,
                   9704:        etc.</p></dd>
1.103   ! wiz      9705: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9706: <dd><p>All bug reports in category "pkg" sent with
                   9707:        <a href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
                   9708:        directly; use one of the other mailing
                   9709:        lists.</p></dd>
                   9710: </dl></div></td>
                   9711: </tr>
1.80      rillig   9712: <tr class="question">
                   9713: <td align="left" valign="top">
1.103   ! wiz      9714: <a name="devfaq.documentation"></a><a name="id460384"></a><b>21.8.</b>
1.80      rillig   9715: </td>
                   9716: <td align="left" valign="top"><p>Where is the pkgsrc
                   9717:        documentation?</p></td>
                   9718: </tr>
                   9719: <tr class="answer">
1.91      rillig   9720: <td align="left" valign="top"></td>
1.80      rillig   9721: <td align="left" valign="top">
                   9722: <p>There are many places where you can find
                   9723:        documentation about pkgsrc:</p>
                   9724: <div class="itemizedlist"><ul type="disc">
                   9725: <li><p>The pkgsrc guide (this document) is a collection
                   9726:        of chapters that explain large parts of pkgsrc, but some
                   9727:        chapters tend to be outdated. Which ones they are is hard to
                   9728:        say.</p></li>
                   9729: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
                   9730:        about certain features, announcements of new parts of the pkgsrc
                   9731:        infrastructure and sometimes even announcements that a certain
                   9732:        feature has been marked as obsolete. The benefit here is that
                   9733:        each message has a date appended to it.</p></li>
                   9734: <li><p>Many of the files in the
                   9735:        <code class="filename">mk/</code> directory start with a comment that
                   9736:        describes the purpose of the file and how it can be used by the
1.92      rillig   9737:        pkgsrc user and package authors. An easy way to find this
                   9738:        documentation is to run <span><strong class="command">bmake
                   9739:        help</strong></span>.</p></li>
1.80      rillig   9740: <li><p>The CVS log messages are a rich source of
                   9741:        information, but they tend to be highly abbreviated, especially
                   9742:        for actions that occur often. Some contain a detailed
                   9743:        description of what has changed, but they are geared towards the
                   9744:        other pkgsrc developers, not towards an average pkgsrc user.
                   9745:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9746:        don't know what has been before, these messages may not be worth
                   9747:        too much to you.</p></li>
                   9748: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9749:        documented</span>&#8221;, that is the documentation exists only in the
                   9750:        mind of the developer who wrote the code. To get this
1.93      rillig   9751:        information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80      rillig   9752:        to see who has written it and ask on the
                   9753:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9754:        find your questions later (see above). To be sure that the
                   9755:        developer in charge reads the mail, you may CC him or
                   9756:        her.</p></li>
                   9757: </ul></div>
                   9758: </td>
                   9759: </tr>
1.92      rillig   9760: <tr class="question">
                   9761: <td align="left" valign="top">
1.103   ! wiz      9762: <a name="devfaq.too-much-time"></a><a name="id460445"></a><b>21.9.</b>
1.92      rillig   9763: </td>
                   9764: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9765: do?</p></td>
                   9766: </tr>
                   9767: <tr class="answer">
                   9768: <td align="left" valign="top"></td>
                   9769: <td align="left" valign="top">
1.93      rillig   9770: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9771: anyway.</p>
                   9772: <div class="itemizedlist"><ul type="disc">
                   9773: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
                   9774:     <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
                   9775:     will tell you about newer versions of installed packages that are
                   9776:     available, but not yet updated in pkgsrc.</p></li>
                   9777: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.103   ! wiz      9778:     &#8212; it contains a list of suggested new packages and a list of
1.92      rillig   9779:     cleanups and enhancements for pkgsrc that would be nice to
                   9780:     have.</p></li>
                   9781: <li><p>Review packages for which review was requested on
                   9782:     the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
                   9783:     mailing list.</p></li>
                   9784: </ul></div>
                   9785: </td>
                   9786: </tr>
1.75      rillig   9787: </tbody>
                   9788: </table>
                   9789: </div>
                   9790: </div>
1.85      jmmv     9791: <div class="chapter" lang="en">
                   9792: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   9793: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9794: <div class="toc">
                   9795: <p><b>Table of Contents</b></p>
                   9796: <dl>
1.90      rillig   9797: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9798: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9799: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9800: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85      jmmv     9801: </dl>
                   9802: </div>
                   9803: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
                   9804: site</a>:</p>
                   9805: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9806:   environment, an intuitive and attractive desktop for users, and the
                   9807:   GNOME development platform, an extensive framework for building
                   9808:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9809: <p>pkgsrc provides a seamless way to automatically build and install
                   9810: a complete GNOME environment <span class="emphasis"><em>under many different
                   9811: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9812: the most advanced build and packaging systems for GNOME due to its
                   9813: included technologies buildlink3, the wrappers and tools framework and
                   9814: automatic configuration file management.  Lots of efforts are put into
                   9815: achieving a completely clean deinstallation of installed software
                   9816: components.</p>
                   9817: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9818: the above also means that great efforts are put into making GNOME work
                   9819: under this operating system.  Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9820: pkgsrc as its preferred packaging system, contributing lots of
                   9821: portability fixes to make GNOME build and install under it.</p>
                   9822: <p>This chapter is aimed at pkgsrc developers and other people
                   9823: interested in helping our GNOME porting and packaging efforts.  It
                   9824: provides instructions on how to manage the existing packages and some
                   9825: important information regarding their internals.</p>
                   9826: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9827: <h3 class="title">We need your help!</h3>
                   9828: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9829:   and GNOME and are willing to learn new exciting stuff, please jump
                   9830:   straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9831:   work</a> list!  There is still a long way to go to get a
                   9832:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9833:   achieve it!</p>
                   9834: </div>
                   9835: <div class="sect1" lang="en">
                   9836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9837: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85      jmmv     9838: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9839: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9840: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9841:     the core GNOME desktop environment.  It only includes the necessary
                   9842:     bits to get it to boot correctly, although it may lack important
                   9843:     functionality for daily operation.  The idea behind this package is
                   9844:     to let end users build their own configurations on top of this one,
                   9845:     first installing this meta package to achieve a functional setup and
                   9846:     then adding individual applications.</p></li>
1.91      rillig   9847: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9848:     complete installation of the GNOME platform and desktop as defined
                   9849:     by the GNOME project; this is based on the components distributed in
                   9850:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9851:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9852:     official FTP server.  Developer-only tools found in those
                   9853:     directories are not installed unless required by some other
                   9854:     component to work properly.  Similarly, packages from the bindings
                   9855:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9856:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9857:     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>
                   9858: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9859:     Installs all the tools required to build a GNOME component when
                   9860:     fetched from the CVS repository.  These are required to let the
                   9861:     <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9862: </ul></div>
                   9863: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9864: sorted in a way that eases updates: a package may depend on other
                   9865: packages listed before it but not on any listed after it.  It is very
                   9866: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9867: change it to alphabetical sorting!</em></span></p>
                   9868: </div>
                   9869: <div class="sect1" lang="en">
                   9870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9871: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9872: <p>Almost all GNOME applications are written in C and use a common
                   9873: set of tools as their build system.  Things get different with the new
                   9874: bindings to other languages (such as Python), but the following will
                   9875: give you a general idea on the minimum required tools:</p>
                   9876: <div class="itemizedlist"><ul type="disc">
                   9877: <li>
                   9878: <p>Almost all GNOME applications use the GNU Autotools as their
                   9879:     build system.  As a general rule you will need to tell this to your
                   9880:     package:</p>
1.100     rillig   9881: <pre class="programlisting">
                   9882: GNU_CONFIGURE=yes
1.85      jmmv     9883: USE_LIBTOOL=yes
1.100     rillig   9884: USE_TOOLS+=gmake
                   9885: </pre>
1.85      jmmv     9886: </li>
                   9887: <li>
                   9888: <p>If the package uses pkg-config to detect dependencies, add this
                   9889:     tool to the list of required utilities:</p>
                   9890: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   9891: <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     9892:     the end of the build process to ensure that you did not miss to
                   9893:     specify any dependency in your package and that the version
                   9894:     requirements are all correct.</p>
                   9895: </li>
1.93      rillig   9896: <li><p>If the package uses intltool, be sure to add
                   9897:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9898:     to handle dependencies and to force the package to use the latest
                   9899:     available version.</p></li>
                   9900: <li>
                   9901: <p>If the package uses gtk-doc (a documentation generation
                   9902:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9903:     tool is rather big and the distfile should come with pregenerated
                   9904:     documentation anyway; if it does not, it is a bug that you ought to
                   9905:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9906:     the default):</p>
                   9907: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9908: <p>The default location of installed HTML files
                   9909:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9910:     and should not be changed unless the package insists on installing
                   9911:     them somewhere else.  Otherwise programs as
                   9912:     <span><strong class="command">devhelp</strong></span> will not be able to open them.  You can
                   9913:     do that with an entry similar to:</p>
                   9914: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9915: </li>
                   9916: </ul></div>
                   9917: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9918: files under the installation prefix to maintain databases.  In this
                   9919: context, shared means that those exact same directories and files are
                   9920: used among several different packages, leading to conflicts in the
                   9921: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9922: handle the most common cases, so you have to forget about using
                   9923: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9924: omitting shared files from them.  If you find yourself doing those,
                   9925: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9926: <p>The following table lists the common situations that result in
                   9927: using shared directories or files.  For each of them, the appropriate
                   9928: solution is given.  After applying the solution be sure to
                   9929: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9930: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
                   9931: <div class="table">
1.90      rillig   9932: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   9933: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9934: <colgroup>
                   9935: <col>
                   9936: <col>
                   9937: </colgroup>
                   9938: <thead><tr>
                   9939: <th>If the package...</th>
                   9940: <th>Then...</th>
                   9941: </tr></thead>
                   9942: <tbody>
                   9943: <tr>
                   9944: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.103   ! wiz      9945: <td>See <a href="#scrollkeeper-data-files" title="18.6.10. Packages installing scrollkeeper data files">Section 18.6.10, &#8220;Packages installing scrollkeeper data files&#8221;</a>.</td>
1.85      jmmv     9946: </tr>
                   9947: <tr>
                   9948: <td>Installs icons under the
                   9949:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9950:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.103   ! wiz      9951: <td>See <a href="#hicolor-theme" title="18.6.19. Packages installing hicolor theme icons">Section 18.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9952: </tr>
                   9953: <tr>
                   9954: <td>Installs files under
                   9955:         <code class="filename">share/mime/packages</code>.</td>
1.103   ! wiz      9956: <td>See <a href="#mime-database" title="18.6.14. Packages installing extensions to the MIME database">Section 18.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9957: </tr>
                   9958: <tr>
                   9959: <td>Installs <code class="filename">.desktop</code> files under
                   9960:         <code class="filename">share/applications</code> and these include MIME
                   9961:         information.</td>
1.103   ! wiz      9962: <td>See <a href="#desktop-files" title="18.6.20. Packages installing desktop files">Section 18.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9963: </tr>
                   9964: </tbody>
1.91      rillig   9965: </table></div>
1.85      jmmv     9966: </div>
1.91      rillig   9967: <br class="table-break">
1.85      jmmv     9968: </div>
                   9969: <div class="sect1" lang="en">
                   9970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   9971: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9972: <p>When seeing GNOME as a whole, there are two kinds of
                   9973: updates:</p>
                   9974: <div class="variablelist"><dl>
                   9975: <dt><span class="term">Major update</span></dt>
                   9976: <dd>
                   9977: <p>Given that there is still a very long way for GNOME 3 (if it
                   9978:       ever appears), we consider a major update one that goes from a
                   9979:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9980:       where <code class="literal">Y</code> is even and greater than
                   9981:       <code class="literal">X</code>.  These are hard to achieve because they
                   9982:       introduce lots of changes in the components' code and almost all
                   9983:       GNOME distfiles are updated to newer versions.  Some of them can
                   9984:       even break API and ABI compatibility with the previous major
                   9985:       version series.  As a result, the update needs to be done all at
                   9986:       once to minimize breakage.</p>
                   9987: <p>A major update typically consists of around 80 package
                   9988:       updates and the addition of some new ones.</p>
                   9989: </dd>
                   9990: <dt><span class="term">Minor update</span></dt>
                   9991: <dd>
                   9992: <p>We consider a minor update one that goes from a
                   9993:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9994:       one where <code class="literal">Y</code> is greater than
                   9995:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9996:       not update all GNOME components, can be done in an incremental way
                   9997:       and do not break API nor ABI compatibility.</p>
                   9998: <p>A minor update typically consists of around 50 package
                   9999:       updates, although the numbers here may vary a lot.</p>
                   10000: </dd>
                   10001: </dl></div>
                   10002: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10003: release (either major or minor), the following steps should be
                   10004: followed:</p>
                   10005: <div class="orderedlist"><ol type="1">
                   10006: <li>
                   10007: <p>Get a list of all the tarballs that form the new release by
                   10008:     using the following commands.  These will leave the full list of the
                   10009:     components's distfiles into the <code class="filename">list.txt</code>
                   10010:     file:</p>
1.88      wiz      10011: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10012:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10013:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10014: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10015:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10016:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10017: </li>
                   10018: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10019:     bump their version to the release you are updating them to.  The
                   10020:     three meta packages should be always consistent with versioning.
                   10021:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10022:     in them.</p></li>
                   10023: <li>
                   10024: <p>For each meta package, update all its
                   10025:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10026:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10027:     newer version (even if found in the FTP) because the meta packages
                   10028:     are supposed to list the exact versions that form a specific GNOME
                   10029:     release.  Exceptions are permitted here if a newer version solves a
                   10030:     serious issue in the overall desktop experience; these typically
                   10031:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10032:     from the developers.</p>
                   10033: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10034:     should be updated to the latest version available (if found in
                   10035:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10036:     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     10037: </li>
                   10038: <li>
                   10039: <p>Generate a patch from the modified meta packages and extract the
                   10040:     list of "new" lines.  This will provide you an outline on what
                   10041:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10042: <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     10043: </li>
                   10044: <li><p>For major desktop updates it is recommended to zap all your
                   10045:     installed packages and start over from scratch at this point.</p></li>
                   10046: <li><p>Now comes the longest step by far: iterate over the contents
                   10047:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10048:     it in order.  For major desktop updates none of these should be
1.93      rillig   10049:     committed until the entire set is completed because there are chances
1.85      jmmv     10050:     of breaking not-yet-updated packages.</p></li>
                   10051: <li><p>Once the packages are up to date and working, commit them to
                   10052:     the tree one by one with appropriate log messages.  At the end,
                   10053:     commit the three meta package updates and all the corresponding
                   10054:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10055:     <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>
                   10056: </ol></div>
                   10057: </div>
                   10058: <div class="sect1" lang="en">
                   10059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10060: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10061: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10062: packages.  Please, it is very important that you always, always,
                   10063: <span class="strong"><strong>always</strong></span> feed back any portability
1.93      rillig   10064: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="10.3.5. Feedback to the author">Section 10.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     10065: their attention on portability issues and to ensure that future versions
                   10066: can be built out-of-the box on NetBSD.  The less custom patches in
                   10067: pkgsrc, the easier further updates are.  Those developers in charge of
                   10068: issuing major GNOME updates will be grateful if you do that.</p>
                   10069: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
                   10070: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10071: of them do.  Do not be short on your reports: always provide detailed
                   10072: explanations of the current failure, how it can be improved to achieve
                   10073: maximum portability and, if at all possible, provide a patch against CVS
                   10074: head.  The more verbose you are, the higher chances of your patch being
                   10075: accepted.</p>
                   10076: <p>Also, please avoid using preprocessor magic to fix portability
                   10077: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10078: GNOME to their operating system, the official GNOME sources are now
                   10079: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10080: and similar macros.  This hurts portability.  Please see our patching
1.93      rillig   10081: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     10082: details.</p>
                   10083: </div>
                   10084: </div>
1.75      rillig   10085: </div>
                   10086: <div class="part" lang="en">
                   10087: <div class="titlepage"><div><div><h1 class="title">
                   10088: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10089: <div class="partintro" lang="en">
                   10090: <div></div>
                   10091: <p>This part of the guide deals with everything
                   10092:        from the infrastructure that is behind the interfaces described
                   10093:        in the developer's guide. A casual package maintainer should not
                   10094:        need anything from this part.</p>
                   10095: <div class="toc">
                   10096: <p><b>Table of Contents</b></p>
                   10097: <dl>
1.90      rillig   10098: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10099: <dd><dl>
1.90      rillig   10100: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   10101: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   10102: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75      rillig   10103: <dd><dl>
1.90      rillig   10104: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   10105: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75      rillig   10106: </dl></dd>
1.90      rillig   10107: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   10108: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10109: <dd><dl>
1.90      rillig   10110: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   10111: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10112: </dl></dd>
1.90      rillig   10113: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10114: <dd><dl>
1.90      rillig   10115: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10116: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10117: </dl></dd>
                   10118: </dl></dd>
1.90      rillig   10119: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75      rillig   10120: <dd><dl>
1.90      rillig   10121: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10122: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10123: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10124: <dd><dl>
1.90      rillig   10125: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10126: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10127: </dl></dd>
                   10128: </dl></dd>
1.90      rillig   10129: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75      rillig   10130: <dd><dl>
1.90      rillig   10131: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10132: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10133: </dl></dd>
                   10134: </dl>
                   10135: </div>
                   10136: </div>
                   10137: <div class="chapter" lang="en">
                   10138: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10139: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10140: <div class="toc">
                   10141: <p><b>Table of Contents</b></p>
                   10142: <dl>
1.90      rillig   10143: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
                   10144: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
                   10145: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81      rillig   10146: <dd><dl>
1.90      rillig   10147: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
                   10148: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81      rillig   10149: </dl></dd>
1.90      rillig   10150: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
                   10151: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10152: <dd><dl>
1.90      rillig   10153: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
                   10154: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10155: </dl></dd>
1.90      rillig   10156: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10157: <dd><dl>
1.90      rillig   10158: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10159: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10160: </dl></dd>
                   10161: </dl>
                   10162: </div>
                   10163: <p>The pkgsrc infrastructure consists of many small Makefile
                   10164:        fragments. Each such fragment needs a properly specified
                   10165:        interface. This chapter explains how such an interface looks
                   10166:        like.</p>
                   10167: <div class="sect1" lang="en">
                   10168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10169: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10170: <p>Whenever a variable is defined in the pkgsrc
                   10171:        infrastructure, the location and the way of definition provide
                   10172:        much information about the intended use of that variable.
                   10173:        Additionally, more documentation may be found in a header
                   10174:        comment or in this pkgsrc guide.</p>
                   10175: <p>A special file is
                   10176:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10177:        variables that are intended to be user-defined. They are either
                   10178:        defined using the <code class="literal">?=</code> operator or they are
                   10179:        left undefined because defining them to anything would
                   10180:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10181:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10182:        file.</p>
                   10183: <p>Outside this file, the following conventions apply:
                   10184:        Variables that are defined using the <code class="literal">?=</code>
                   10185:        operator may be overridden by a package.</p>
                   10186: <p>Variables that are defined using the <code class="literal">=</code>
                   10187:        operator may be used read-only at run-time.</p>
                   10188: <p>Variables whose name starts with an underscore must not be
                   10189:        accessed outside the pkgsrc infrastructure at all. They may
                   10190:        change without further notice.</p>
                   10191: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10192: <h3 class="title">Note</h3>
                   10193: <p>These conventions are currently not applied
                   10194:        consistently to the complete pkgsrc
                   10195:        infrastructure.</p>
                   10196: </div>
                   10197: </div>
                   10198: <div class="sect1" lang="en">
                   10199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10200: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10201: <p>All variables that contain lists of things should default
                   10202:        to being empty. Two examples that do not follow this rule are
                   10203:        <code class="varname">USE_LANGUAGES</code> and
                   10204:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10205:        modified using the <code class="literal">+=</code> operator in package
                   10206:        <code class="filename">Makefile</code>s (or other files included by
                   10207:        them), since there is no guarantee whether the variable is
                   10208:        already set or not, and what its value is. In the case of
                   10209:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10210:        the default value and just define it as in the following
                   10211:        example.</p>
                   10212: <pre class="programlisting">
1.100     rillig   10213: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10214: </pre>
                   10215: <p>Because of the selection of this default value, the same
                   10216:        value appears in many package Makefiles. Similarly for
                   10217:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10218:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10219:        doesn't stand out. Nevertheless it is mentioned in many
                   10220:        files.</p>
                   10221: </div>
                   10222: <div class="sect1" lang="en">
                   10223: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10224: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10225: <div class="sect2" lang="en">
                   10226: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10227: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75      rillig   10228: <p>Variable evaluation takes place either at load time or at
                   10229:        runtime, depending on the context in which they occur. The
                   10230:        contexts where variables are evaluated at load time are:</p>
                   10231: <div class="itemizedlist"><ul type="disc">
                   10232: <li><p>The right hand side of the <code class="literal">:=</code>
                   10233:        and <code class="literal">!=</code> operators,</p></li>
                   10234: <li><p>Make directives like <code class="literal">.if</code> or
                   10235:        <code class="literal">.for</code>,</p></li>
                   10236: <li><p>Dependency lines.</p></li>
                   10237: </ul></div>
                   10238: <p>A special exception are references to the iteration
                   10239:        variables of <code class="literal">.for</code> loops, which are expanded
                   10240:        inline, no matter in which context they appear.</p>
                   10241: <p>As the values of variables may change during load time,
                   10242:        care must be taken not to evaluate them by accident. Typical
                   10243:        examples for variables that should not be evaluated at load time
                   10244:        are <code class="varname">DEPENDS</code> and
                   10245:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10246:        clear, here is an example:</p>
                   10247: <pre class="programlisting">
1.100     rillig   10248: CONFIGURE_ARGS=         # none
                   10249: CFLAGS=                 -O
                   10250: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10251: 
1.100     rillig   10252: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10253: 
1.100     rillig   10254: CFLAGS+=                -Wall
1.75      rillig   10255:        </pre>
                   10256: <p>This code shows how the use of the <code class="literal">:=</code>
                   10257:        operator can quickly lead to unexpected results. The first
                   10258:        paragraph is fairly common code. The second paragraph evaluates
                   10259:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10260:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10261:        <code class="literal">-Wall</code> is appended to the
                   10262:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10263:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10264:        paragraphs from above typically occur in completely unrelated
                   10265:        files.</p>
                   10266: </div>
                   10267: <div class="sect2" lang="en">
                   10268: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10269: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75      rillig   10270: <p>After all the files have been loaded, the values of the
                   10271:        variables cannot be changed anymore. Variables that are used in
                   10272:        the shell commands are expanded at this point.</p>
                   10273: </div>
                   10274: </div>
                   10275: <div class="sect1" lang="en">
                   10276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10277: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10278: <p>There are many ways in which the definition and use of a
                   10279:        variable can be restricted in order to detect bugs and
                   10280:        violations of the (mostly unwritten) policies. See the
                   10281:        <code class="literal">pkglint</code> developer's documentation for further
                   10282:        details.</p>
                   10283: </div>
                   10284: <div class="sect1" lang="en">
                   10285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10286: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10287: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10288:        of the following classes. Cases where a file falls into more
                   10289:        than one class should be avoided as it often leads to subtle
                   10290:        bugs.</p>
                   10291: <div class="sect2" lang="en">
                   10292: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10293: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10294: <p>In a traditional imperative programming language some of
1.76      rillig   10295:        the <code class="filename">.mk</code> files could be described as
1.103   ! wiz      10296:        procedures. They take some input parameters and&#8212;after
        !          10297:        inclusion&#8212;provide a result in output parameters. Since all
1.76      rillig   10298:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10299:        care must be taken not to use parameter names that have already
                   10300:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10301:        bad choice for a parameter name.</p>
                   10302: <p>Procedures are completely evaluated at preprocessing time.
                   10303:        That is, when calling a procedure all input parameters must be
                   10304:        completely resolvable. For example,
                   10305:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10306:        parameter since it is very likely that further text will be
                   10307:        added after calling the procedure, which would effectively apply
                   10308:        the procedure to only a part of the variable. Also, references
                   10309:        to other variables wit will be modified after calling the
                   10310:        procedure.</p>
                   10311: <p>A procedure can declare its output parameters either as
                   10312:        suitable for use in preprocessing directives or as only
                   10313:        available at runtime. The latter alternative is for variables
                   10314:        that contain references to other runtime variables.</p>
                   10315: <p>Procedures shall be written such that it is possible to
                   10316:        call the procedure more than once. That is, the file must not
                   10317:        contain multiple-inclusion guards.</p>
                   10318: <p>Examples for procedures are
1.76      rillig   10319:        <code class="filename">mk/bsd.options.mk</code> and
                   10320:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10321:        that the parameters are evaluated at load time, they should be
                   10322:        assigned using the <code class="literal">:=</code> operator, which should
                   10323:        be used only for this purpose.</p>
                   10324: </div>
                   10325: <div class="sect2" lang="en">
                   10326: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10327: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10328: <p>Action files take some input parameters and may define
                   10329:        runtime variables. They shall not define loadtime variables.
                   10330:        There are action files that are included implicitly by the
                   10331:        pkgsrc infrastructure, while other must be included
                   10332:        explicitly.</p>
                   10333: <p>An example for action files is
1.76      rillig   10334:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10335: </div>
                   10336: </div>
1.81      rillig   10337: <div class="sect1" lang="en">
                   10338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10339: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10340: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10341:        a set of variable definitions, and include the file
                   10342:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10343:        Before that, they may also include various other
                   10344:        <code class="filename">*.mk</code> files if they need to query the
                   10345:        availability of certain features like the type of compiler or
                   10346:        the X11 implementation. Due to the heavy use of preprocessor
                   10347:        directives like <code class="literal">.if</code> and
                   10348:        <code class="literal">.for</code>, the order in which the files are loaded
                   10349:        matters.</p>
                   10350: <p>This section describes at which point the various files
                   10351:        are loaded and gives reasons for that order.</p>
                   10352: <div class="sect2" lang="en">
                   10353: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10354: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
                   10355: </h3></div></div></div>
                   10356: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10357:        is to define some essential variables like
                   10358:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10359:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10360: <p>Then, the user settings are loaded from the file specified
                   10361:        in <code class="varname">MAKECONF</code>. If the bmake command from pkgsrc
                   10362:        is used, <code class="varname">MAKECONF</code> defaults to
                   10363:        <code class="filename"><em class="replaceable"><code>${prefix}</code></em>/etc/mk.conf</code>.
                   10364:        With the native <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command on NetBSD, it defaults to
                   10365:        <code class="filename">/etc/mk.conf</code>. After that, those variables
                   10366:        that have not been overridden by the user are loaded from
                   10367:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10368: <p>After the user settings, the system settings and platform
                   10369:        settings are loaded, which may override the user
                   10370:        settings.</p>
                   10371: <p>Then, the tool definitions are loaded. The tool wrappers
                   10372:        are not yet in effect. This only happens when building a
                   10373:        package, so the proper variables must be used instead of the
                   10374:        direct tool names.</p>
                   10375: <p>As the last steps, some essential variables from the
                   10376:        wrapper and the package system flavor are loaded, as well as the
                   10377:        variables that have been cached in earlier phases of a package
                   10378:        build.</p>
                   10379: </div>
                   10380: <div class="sect2" lang="en">
                   10381: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10382: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
                   10383: </h3></div></div></div>
1.81      rillig   10384: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10385: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10386:        loaded, which fill default values for those variables that have
1.93      rillig   10387:        not been defined by the package. These variables may later
1.81      rillig   10388:        be used even in unrelated files.</p>
                   10389: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10390:        provides the target <code class="literal">error-check</code> that is added
                   10391:        as a special dependency to all other targets that use
                   10392:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10393:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10394: <p>Then, the package-specific hacks from
                   10395:        <code class="filename">hacks.mk</code> are included.</p>
                   10396: <p>Then, various other files follow. Most of them don't have
                   10397:        any dependencies on what they need to have included before or
                   10398:        after them, though some do.</p>
                   10399: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10400:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10401:        restricts the use of these variables to all the files that have
                   10402:        been included before. Appearances in later files will be
                   10403:        silently ignored.</p>
                   10404: <p>Then, the files for the main targets are included, in the
                   10405:        order of later execution, though the actual order should not
                   10406:        matter.</p>
                   10407: <p>At last, some more files are included that don't set any
                   10408:        interesting variables but rather just define make targets to be
                   10409:        executed.</p>
                   10410: </div>
                   10411: </div>
1.75      rillig   10412: </div>
                   10413: <div class="chapter" lang="en">
                   10414: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10415: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75      rillig   10416: <div class="toc">
                   10417: <p><b>Table of Contents</b></p>
                   10418: <dl>
1.90      rillig   10419: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
                   10420: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
                   10421: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75      rillig   10422: <dd><dl>
1.90      rillig   10423: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
                   10424: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75      rillig   10425: </dl></dd>
                   10426: </dl>
                   10427: </div>
                   10428: <p>The pkgsrc infrastructure consists of a large codebase,
                   10429:        and there are many corners where every little bit of a file is
                   10430:        well thought out, making pkgsrc likely to fail as soon as
                   10431:        anything is changed near those parts. To prevent most changes
                   10432:        from breaking anything, a suite of regression tests should go
                   10433:        along with every important part of the pkgsrc infrastructure.
                   10434:        This chapter describes how regression tests work in pkgsrc and
                   10435:        how you can add new tests.</p>
                   10436: <div class="sect1" lang="en">
                   10437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10438: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10439: <p></p>
                   10440: </div>
                   10441: <div class="sect1" lang="en">
                   10442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10443: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10444: <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.75      rillig   10445:        provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
                   10446:        can simply run that command, which will run all tests in the
1.76      rillig   10447:        <code class="filename">regress</code> category.</p>
1.75      rillig   10448: </div>
                   10449: <div class="sect1" lang="en">
                   10450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10451: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10452: <p>Every directory in the <code class="filename">regress</code>
                   10453:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10454:        is considered a regression test. This file is a shell program
                   10455:        that is included by the <span><strong class="command">pkg_regress</strong></span> command.
                   10456:        The following functions can be overridden to suit your
                   10457:        needs.</p>
                   10458: <div class="sect2" lang="en">
                   10459: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10460: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10461: <p>These functions do not take any parameters. They are all
                   10462:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10463:        to check the exitcodes of any commands you run in the
                   10464:        test.</p>
                   10465: <div class="variablelist"><dl>
                   10466: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10467: <dd><p>This function prepares the environment for the
                   10468:        test. By default it does nothing.</p></dd>
                   10469: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10470: <dd><p>This function runs the actual test. By default,
                   10471:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10472:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10473:        error messages into the file
                   10474:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10475: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10476: <dd><p>This function is run after the test and is
                   10477:        typically used to compare the actual output from the one that is
                   10478:        expected. It can make use of the various helper functions from
                   10479:        the next section.</p></dd>
                   10480: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10481: <dd><p>This function cleans everything up after the
                   10482:        test has been run. By default it does nothing.</p></dd>
                   10483: </dl></div>
                   10484: </div>
                   10485: <div class="sect2" lang="en">
                   10486: <div class="titlepage"><div><div><h3 class="title">
1.90      rillig   10487: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10488: <div class="variablelist"><dl>
                   10489: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10490: <dd><p>This function compares the exitcode of the
                   10491:        <span><strong class="command">do_test()</strong></span> function with its first parameter.
                   10492:        If they differ, the test will fail.</p></dd>
                   10493: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10494: <dd><p>This function checks for each of its parameters
                   10495:        if the output from <span><strong class="command">do_test()</strong></span> matches the
                   10496:        extended regular expression. If it does not, the test will
                   10497:        fail.</p></dd>
                   10498: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10499: <dd><p>This function checks for each of its parameters
                   10500:        if the output from <span><strong class="command">do_test()</strong></span> does
                   10501:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10502:        If any of the regular expressions matches, the test will
                   10503:        fail.</p></dd>
                   10504: </dl></div>
                   10505: </div>
                   10506: </div>
                   10507: </div>
                   10508: <div class="chapter" lang="en">
                   10509: <div class="titlepage"><div><div><h2 class="title">
1.90      rillig   10510: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10511: <div class="toc">
                   10512: <p><b>Table of Contents</b></p>
                   10513: <dl>
1.90      rillig   10514: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10515: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10516: </dl>
                   10517: </div>
                   10518: <p>The pkgsrc system has already been ported to many
                   10519:        operating systems, hardware architectures and compilers. This
                   10520:        chapter explains the necessary steps to make pkgsrc even more
                   10521:        portable.</p>
                   10522: <div class="sect1" lang="en">
                   10523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10524: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10525: <p>To port pkgsrc to a new operating system (called
                   10526:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10527:        following files:</p>
                   10528: <div class="variablelist"><dl>
1.93      rillig   10529: <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   10530: <dd><p>This file contains some basic definitions, for
                   10531:        example the name of the C
                   10532:        compiler.</p></dd>
1.76      rillig   10533: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10534: <dd><p>Insert code that defines the variables
                   10535:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10536:        <code class="varname">LOWER_OS_VERSION</code>,
                   10537:        <code class="varname">LOWER_VENDOR</code>,
                   10538:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10539:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10540:        appear in this file.</p></dd>
1.93      rillig   10541: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10542: <dd><p>This file contains the platform-specific
                   10543:        definitions that are used by pkgsrc. Start by copying one of the
                   10544:        other files and edit it to your
                   10545:        needs.</p></dd>
1.93      rillig   10546: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10547: <dd><p>This file contains a list of directories,
                   10548:        together with their permission bits and ownership. These
                   10549:        directories will be created automatically with every package
1.98      wiz      10550:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10551:        be removed.</p></dd>
1.93      rillig   10552: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10553: <dd><p>Just copy one of the pre-existing x11.dist files
                   10554:        to your
1.76      rillig   10555:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10556: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10557: <dd><p>On some operating systems, the tools that are
                   10558:        provided with the base system are not good enough for pkgsrc.
                   10559:        For example, there are many versions of <a href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
                   10560:        narrow limit on the line length they can process. Therefore
                   10561:        pkgsrc brings its own tools, which can be enabled
                   10562:        here.</p></dd>
1.93      rillig   10563: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10564: <dd><p>This file defines the paths to all the tools
                   10565:        that are needed by one or the other package in pkgsrc, as well
                   10566:        as by pkgsrc itself. Find out where these tools are on your
                   10567:        platform and add them.</p></dd>
                   10568: </dl></div>
                   10569: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10570:        <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   10571: </div>
                   10572: <div class="sect1" lang="en">
                   10573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90      rillig   10574: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10575: <p>TODO</p>
                   10576: </div>
                   10577: </div>
                   10578: </div>
                   10579: <div class="appendix" lang="en">
                   10580: <div class="titlepage"><div><div><h2 class="title">
                   10581: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10582: <div class="toc">
                   10583: <p><b>Table of Contents</b></p>
                   10584: <dl>
                   10585: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10586: <dd><dl>
                   10587: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10588: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10589: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
                   10590: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
                   10591: </dl></dd>
                   10592: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10593: </dl>
                   10594: </div>
                   10595: <p>We checked to find a piece of software that wasn't in the packages
                   10596:     collection, and picked GNU bison. Quite why someone would want to have
                   10597:     <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
                   10598:     present in the tree is beyond us, but it's useful for the purposes of
                   10599:     this exercise.</p>
                   10600: <div class="sect1" lang="en">
                   10601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10602: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10603: <div class="sect2" lang="en">
                   10604: <div class="titlepage"><div><div><h3 class="title">
                   10605: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10606: <pre class="programlisting">
1.100     rillig   10607: # $NetBSD$
                   10608: #
1.1       grant    10609: 
1.100     rillig   10610: DISTNAME=       bison-1.25
                   10611: CATEGORIES=     devel
                   10612: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10613: 
1.100     rillig   10614: MAINTAINER=     thorpej@NetBSD.org
                   10615: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10616: COMMENT=        GNU yacc clone
1.1       grant    10617: 
1.100     rillig   10618: GNU_CONFIGURE=  yes
                   10619: INFO_FILES=     bison.info
1.1       grant    10620: 
1.100     rillig   10621: .include "../../mk/bsd.pkg.mk"
1.1       grant    10622: </pre>
1.75      rillig   10623: </div>
                   10624: <div class="sect2" lang="en">
                   10625: <div class="titlepage"><div><div><h3 class="title">
                   10626: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10627: <pre class="programlisting">
1.100     rillig   10628: GNU version of yacc.  Can make re-entrant parsers, and numerous other
                   10629: improvements.  Why you would want this when Berkeley <a href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
                   10630: of the NetBSD source tree is beyond me.
1.1       grant    10631: </pre>
1.75      rillig   10632: </div>
                   10633: <div class="sect2" lang="en">
                   10634: <div class="titlepage"><div><div><h3 class="title">
                   10635: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10636: <pre class="programlisting">
1.100     rillig   10637: @comment $NetBSD$
                   10638: bin/bison
                   10639: man/man1/bison.1.gz
                   10640: share/bison.simple
                   10641: share/bison.hairy
1.1       grant    10642: </pre>
1.75      rillig   10643: </div>
                   10644: <div class="sect2" lang="en">
                   10645: <div class="titlepage"><div><div><h3 class="title">
1.93      rillig   10646: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
                   10647: </h3></div></div></div>
1.75      rillig   10648: <p>The NetBSD package system comes with
1.91      rillig   10649:         <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   10650:        which helps to check the contents of these
                   10651:        files. After installation it is quite easy to use, just change to the
                   10652:        directory of the package you wish to examine and execute
                   10653:        <span><strong class="command">pkglint</strong></span>:</p>
                   10654: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10655: looks fine.</pre>
                   10656: <p>Depending on the supplied command line arguments (see pkglint(1)),
                   10657:        more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
                   10658:        -Wall</strong></span> for a very thorough check.</p>
                   10659: </div>
                   10660: </div>
                   10661: <div class="sect1" lang="en">
                   10662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10663: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10664: <p>Create the directory where the package lives,
                   10665:       plus any auxiliary directories:</p>
                   10666: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10667: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10668: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10669: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10670: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90      rillig   10671:       <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 10. Package components - files, directories and contents">Chapter 10, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10672:       then continue with fetching the distfile:</p>
                   10673: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10674: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10675: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10676: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10677: ftp: Error retrieving file: 500 Internal error
                   10678: 
                   10679: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10680: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10681: ftp: Error retrieving file: 500 Internal error
                   10682: 
                   10683: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10684: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10685: Successfully retrieved file.</pre>
                   10686: <p>Generate the checksum of the distfile into
1.76      rillig   10687:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10688: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10689: <p>Now compile:</p>
                   10690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10691: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10692: ===&gt;  Extracting for bison-1.25
                   10693: ===&gt;  Patching for bison-1.25
                   10694: ===&gt;   Ignoring empty patch directory
                   10695: ===&gt;  Configuring for bison-1.25
                   10696: creating cache ./config.cache
                   10697: checking for gcc... cc
                   10698: checking whether we are using GNU C... yes
                   10699: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10700: checking how to run the C preprocessor... cc -E
                   10701: checking for minix/config.h... no
                   10702: checking for POSIXized ISC... no
                   10703: checking whether cross-compiling... no
                   10704: checking for ANSI C header files... yes
                   10705: checking for string.h... yes
                   10706: checking for stdlib.h... yes
                   10707: checking for memory.h... yes
                   10708: checking for working const... yes
                   10709: checking for working alloca.h... no
                   10710: checking for alloca... yes
                   10711: checking for strerror... yes
                   10712: updating cache ./config.cache
                   10713: creating ./config.status
                   10714: creating Makefile
                   10715: ===&gt;  Building for bison-1.25
                   10716: 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
                   10717: 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
                   10718: 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
                   10719: 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
                   10720: 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   10721: 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    10722: 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
                   10723: 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
                   10724: 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
                   10725: 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
                   10726: 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
                   10727: 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
                   10728: 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
                   10729: 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
                   10730: 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
                   10731: 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
                   10732: 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
                   10733: 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
                   10734: 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
                   10735: 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
                   10736: 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
                   10737: 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
                   10738: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10739: rm -f bison.s1
1.75      rillig   10740: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10741: <p>Everything seems OK, so install the files:</p>
                   10742: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10743: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10744: ===&gt;  Installing for bison-1.25
                   10745: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10746: rm -f /usr/pkg/bin/bison
                   10747: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10748: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10749: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10750: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10751: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10752: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10753: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10754: ===&gt;  Registering installation for bison-1.25</pre>
                   10755: <p>You can now use bison, and also - if you decide so - remove it with
                   10756:       <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
                   10757:       binary package, do this now:</p>
                   10758: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10759: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10760: ===&gt;  Building package for bison-1.25
                   10761: Creating package bison-1.25.tgz
                   10762: Registering depends:.
1.75      rillig   10763: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10764: <p>Now that you don't need the source and object files
                   10765:       any more, clean up:</p>
                   10766: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10767: ===&gt;  Cleaning for bison-1.25</pre>
                   10768: </div>
                   10769: </div>
                   10770: <div class="appendix" lang="en">
                   10771: <div class="titlepage"><div><div><h2 class="title">
                   10772: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10773: <div class="toc">
                   10774: <p><b>Table of Contents</b></p>
                   10775: <dl>
                   10776: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10777: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10778: </dl>
                   10779: </div>
                   10780: <div class="sect1" lang="en">
                   10781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10782: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10784: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10785: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10786: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10787: =&gt; [172219 bytes]
                   10788: Connected to ftp.plig.net.
                   10789: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10790: 331 Guest login ok, send your complete e-mail address as password.
                   10791: 230-You are user #5 of 500 simultaneous users allowed.
                   10792: 230-
1.68      rillig   10793: 230-  ___ _             _ _
                   10794: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10795: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10796: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10797: 230-         |_|   |_|     |___|         |___|
                   10798: 230-
                   10799: 230-** Welcome to ftp.plig.org **
                   10800: 230-
                   10801: 230-Please note that all transfers from this FTP site are logged. If you
                   10802: 230-do not like this, please disconnect now.
                   10803: 230-
                   10804: 230-This arhive is available via
                   10805: 230-
                   10806: 230-HTTP:  http://ftp.plig.org/
                   10807: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10808: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10809: 230-
                   10810: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10811: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10812: 230-
                   10813: 230-
                   10814: 230 Logged in anonymously.
                   10815: Remote system type is UNIX.
                   10816: Using binary mode to transfer files.
                   10817: 200 Type okay.
                   10818: 250 "/pub" is new cwd.
                   10819: 250-"/pub/figlet" is new cwd.
                   10820: 250-
                   10821: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10822: 250-
1.75      rillig   10823: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10824: 250-
                   10825: 250-The official FIGlet web page is:
1.75      rillig   10826: 250-   http://www.figlet.org/
1.1       grant    10827: 250-
                   10828: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10829: 250-contribute a font or something else, you can email us.
1.68      rillig   10830: 250
1.1       grant    10831: 250 "/pub/figlet/program" is new cwd.
                   10832: 250 "/pub/figlet/program/unix" is new cwd.
                   10833: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10834: 502 Unimplemented command.
                   10835: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10836: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10837: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10838: 226 Transfer completed.
                   10839: 172219 bytes received in 00:02 (75.99 KB/s)
                   10840: 221 Goodbye.
                   10841: =&gt; Checksum OK for figlet221.tar.gz.
                   10842: ===&gt; Extracting for figlet-2.2.1nb2
                   10843: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10844: ===&gt; Patching for figlet-2.2.1nb2
                   10845: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10846: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10847: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10848: ===&gt; Configuring for figlet-2.2.1nb2
                   10849: ===&gt; Building for figlet-2.2.1nb2
                   10850: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10851: chmod a+x figlet
                   10852: gcc -O2 -o chkfont chkfont.c
                   10853: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10854: <code class="prompt">#</code>
1.75      rillig   10855: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10856: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10857: ===&gt; Installing for figlet-2.2.1nb2
                   10858: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10859: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10860: mkdir -p /usr/pkg/share/figlet
                   10861: cp figlet /usr/pkg/bin
                   10862: cp chkfont /usr/pkg/bin
                   10863: chmod 555 figlist showfigfonts
                   10864: cp figlist /usr/pkg/bin
                   10865: cp showfigfonts /usr/pkg/bin
                   10866: cp fonts/*.flf /usr/pkg/share/figlet
                   10867: cp fonts/*.flc /usr/pkg/share/figlet
                   10868: cp figlet.6 /usr/pkg/man/man6
                   10869: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10870: <code class="prompt">#</code></pre>
                   10871: </div>
                   10872: <div class="sect1" lang="en">
                   10873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10874: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10875: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10876: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10877: ===&gt; Packaging figlet-2.2.1nb2
                   10878: ===&gt; Building binary package for figlet-2.2.1nb2
                   10879: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10880: Using SrcDir value of /usr/pkg
1.68      rillig   10881: Registering depends:.
1.75      rillig   10882: <code class="prompt">#</code></pre>
                   10883: </div>
                   10884: </div>
                   10885: <div class="appendix" lang="en">
                   10886: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10887: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10888: <div class="toc">
                   10889: <p><b>Table of Contents</b></p>
                   10890: <dl>
                   10891: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
                   10892: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10893: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
                   10894: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102     rillig   10895: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.76      rillig   10896: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93      rillig   10897: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10898: source packages</a></span></dt>
                   10899: </dl>
                   10900: </div>
                   10901: <p>As in other big projects, the directory layout of pkgsrc
                   10902:        is quite complex for newbies. This chapter explains where you
                   10903:        find things on the FTP server. The base directory on
1.89      rillig   10904:        <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
                   10905:        On other servers it may be different, but inside this directory,
                   10906:        everything should look the same, no matter on which server you
                   10907:        are. This directory contains some subdirectories, which are
                   10908:        explained below.</p>
1.76      rillig   10909: <div class="sect1" lang="en">
                   10910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10911: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
                   10912: <p>For those who only want to manage binary packages on
                   10913:        systems other than NetBSD, we provide the package management
                   10914:        tools in a separate, small tar file.</p>
                   10915: </div>
                   10916: <div class="sect1" lang="en">
                   10917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10918: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   10919: <p>The directory <code class="filename">distfiles</code> contains lots
                   10920:        of archive files from all pkgsrc packages, which are mirrored
                   10921:        here. The subdirectories are called after their package names
                   10922:        and are used when the distributed files have names that don't
                   10923:        explicitly contain a version number or are otherwise too generic
                   10924:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10925: </div>
                   10926: <div class="sect1" lang="en">
                   10927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10928: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   10929: <p>This directory is currently not in use.</p>
                   10930: </div>
                   10931: <div class="sect1" lang="en">
                   10932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10933: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   10934: <p>This directory contains things that individual pkgsrc
                   10935:        developers find worth publishing.</p>
                   10936: </div>
                   10937: <div class="sect1" lang="en">
                   10938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   10939: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   10940: <p>This directory contains binary packages for the various
                   10941:        platforms that are supported by pkgsrc.
                   10942:        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>
                   10943: <div class="itemizedlist"><ul type="disc">
                   10944: <li><p><code class="varname">OPSYS</code> is the name of the operating system for which the packages have been built,</p></li>
                   10945: <li><p><code class="varname">ARCH</code> is the hardware architecture,</p></li>
                   10946: <li><p><code class="varname">OSVERSION</code> is the version of the operating system,</p></li>
                   10947: <li><p><code class="varname">TAG</code> is either <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code> for a stable branch, or <code class="literal">head</code> for packages built from the HEAD branch.</p></li>
                   10948: </ul></div>
                   10949: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10950:        can quickly click through the directories on the
                   10951:        server and find the best binary packages for their machines. Since they
                   10952:        usually know the operating system and the hardware architecture, OPSYS
                   10953:        and ARCH are placed first. After these choices, they can select the
                   10954:        best combination of OSVERSION and TAG together, since it is usually the
                   10955:        case that packages stay compatible between different version of the
                   10956:        operating system.</p>
                   10957: <p>In each of these directories, there is a
                   10958:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10959:        <code class="filename">All</code> which contains all binary packages.
                   10960:        Besides that, there are various category directories that
                   10961:        contain symbolic links to the real binary packages.</p>
                   10962: </div>
                   10963: <div class="sect1" lang="en">
                   10964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10965: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93      rillig   10966: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10967: source packages</h2></div></div></div>
                   10968: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   10969:        that is the files that define how to create binary packages from
                   10970:        source archives.</p>
                   10971: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10972:        snapshot of the CVS repository, which is updated regularly. The
                   10973:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10974:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10975: <p>In the directories for the quarterly branches, there is an
                   10976:        additional file called
                   10977:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   10978:        which contains the state of pkgsrc when it was branched.</p>
                   10979: </div>
1.75      rillig   10980: </div>
                   10981: <div class="appendix" lang="en">
                   10982: <div class="titlepage"><div><div><h2 class="title">
                   10983: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   10984: <div class="toc">
                   10985: <p><b>Table of Contents</b></p>
                   10986: <dl>
1.79      rillig   10987: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10988: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10989: </dl>
                   10990: </div>
1.79      rillig   10991: <p>This section contains information on editing the pkgsrc
                   10992:        guide itself.</p>
1.75      rillig   10993: <div class="sect1" lang="en">
                   10994: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10995: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10996: <p>The pkgsrc guide's source code is stored in
                   10997:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10998:        are created from it:</p>
                   10999: <div class="itemizedlist"><ul type="disc">
                   11000: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11001: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.101     rillig   11002: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11003: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   11004:        The PDF version of the pkgsrc guide.</p></li>
1.101     rillig   11005: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   11006:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11007: </ul></div>
                   11008: </div>
                   11009: <div class="sect1" lang="en">
                   11010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11011: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11012: <p>The procedure to edit the pkgsrc guide is:</p>
                   11013: <div class="procedure"><ol type="1">
                   11014: <li><p>Make sure you have the packages needed to
1.83      wiz      11015:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   11016:        documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
                   11017:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79      rillig   11018:        PostScript and PDF versions. You will need both packages
                   11019:        installed, to make sure documentation is consistent across all
                   11020:        formats.</p></li>
                   11021: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
                   11022:        right directory. All further steps will take place
                   11023:        here.</p></li>
                   11024: <li><p>Edit the XML file(s) in
                   11025:        <code class="filename">files/</code>.</p></li>
                   11026: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
                   11027:        guide for valid XML and to build the final output files. If you
                   11028:        get any errors at this stage, you can just edit the files, as
                   11029:        there are only symbolic links in the working directory, pointing
                   11030:        to the files in <code class="filename">files/</code>.</p></li>
                   11031: <li><p><span><strong class="command">(cd files &amp;&amp; cvs
                   11032:        commit)</strong></span></p></li>
                   11033: <li><p>Run <span><strong class="command">bmake clean &amp;&amp; bmake</strong></span> to
                   11034:        regenerate the output files with the proper RCS
                   11035:        Ids.</p></li>
1.91      rillig   11036: <li>
                   11037: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
                   11038:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11039:        <code class="filename">htdocs</code>.</p>
                   11040: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11041: <h3 class="title">Note</h3>
                   11042: <p>If you have added, removed or renamed some chapters,
1.83      wiz      11043:        you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
                   11044:        <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91      rillig   11045:        directory.</p>
                   11046: </div>
                   11047: </li>
1.79      rillig   11048: </ol></div>
1.75      rillig   11049: </div>
                   11050: </div>
                   11051: </div></body>
1.1       grant    11052: </html>

CVSweb <webmaster@jp.NetBSD.org>