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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
1.23      wiz        10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The pkgsrc guide">
1.1       dsieger    11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.10      hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.4       rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6       rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.23      wiz        35: <div><div class="abstract" title="Abstract">
1.1       dsieger    36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger    69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
                     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     81: <dd><dl>
                     82: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     83: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     84: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     85: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     86: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     87: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     88: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                     89: </dl></dd>
                     90: </dl></dd>
                     91: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     92: <dd><dl>
                     93: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     94: <dd><dl>
                     95: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     96: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     98: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    100: <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>
                    101: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    102: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    103: </dl></dd>
                    104: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    105: <dd><dl>
                    106: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    107: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    108: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    109: </dl></dd>
                    110: </dl></dd>
                    111: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    112: <dd><dl>
                    113: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    114: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    115: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    116: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   117: <dd><dl>
1.4       rillig    118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       119: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    120: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   121: </dl></dd>
1.4       rillig    122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    123: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   124: </dl></dd>
                    125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    126: <dd><dl>
                    127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    129: </dl></dd>
                    130: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    131: builds)</a></span></dt>
1.1       dsieger   132: <dd><dl>
1.6       rillig    133: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    134: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    136: <dd><dl>
                    137: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    138: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    139: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    140: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    141: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    142: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    143: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    144: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    145: </dl></dd>
                    146: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    147: <dd><dl>
                    148: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    150: </dl></dd>
1.6       rillig    151: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    152: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    153: </dl></dd>
                    154: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    155: <dd><dl>
1.23      wiz       156: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    157: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    158: </dl></dd>
                    159: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    160: <dd><dl>
                    161: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    162: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    164: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    165: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23      wiz       168: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6       rillig    169: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       170: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                    171: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    172: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.6       rillig    173: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    174: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    175: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       176: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6       rillig    177: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.23      wiz       178: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   179: </dl></dd>
                    180: </dl></dd>
                    181: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    182: <dd><dl>
1.6       rillig    183: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   184: <dd><dl>
1.6       rillig    185: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   186: <dd><dl>
1.6       rillig    187: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    188: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil      189: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger   190: </dl></dd>
1.6       rillig    191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    192: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    193: </dl></dd>
                    194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    195: <dd><dl>
1.23      wiz       196: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    197: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig    198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    199: <dd><dl>
                    200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    205: </dl></dd>
                    206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    208: <dd><dl>
                    209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    212: </dl></dd>
1.23      wiz       213: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    214: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig    215: </dl></dd>
1.23      wiz       216: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz       219: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig    220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    222: <dd><dl>
                    223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    228: </dl></dd>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz       233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6       rillig    235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz       237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6       rillig    238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    240: </dl></dd>
                    241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    242: <dd><dl>
                    243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz       244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    245: <dd><dl>
                    246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz       247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    248:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    249:       and
                    250:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    251:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    252: </dl></dd>
1.23      wiz       253: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig    254: <dd><dl>
1.23      wiz       255: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6       rillig    256: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    257: </dl></dd>
                    258: </dl></dd>
                    259: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    262: <dd><dl>
                    263: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    264: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    265: </dl></dd>
                    266: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    267: <dd><dl>
1.23      wiz       268: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6       rillig    269: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    270: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    271: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    272: </dl></dd>
                    273: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    274: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    275: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    276: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    277: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    278: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    279: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    280: </dl></dd>
                    281: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    282: <dd><dl>
                    283: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz       284: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6       rillig    285: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    286: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    287: </dl></dd>
                    288: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    289: <dd><dl>
                    290: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz       294: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    295: <dd><dl>
                    296: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    297: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    298: </dl></dd>
1.23      wiz       299: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    306: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    308: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig    309: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    310: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    311: </dl></dd>
                    312: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    315: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    316: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    317: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    318: </dl></dd>
                    319: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    320: <dd><dl>
                    321: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    322: <dd><dl>
                    323: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz       324: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6       rillig    325: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    326: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    327: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    328: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    329: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    330: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    331: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    332: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    333: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    334: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    335: </dl></dd>
1.23      wiz       336: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    337: <dd><dl>
                    338: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    339: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    340: </dl></dd>
1.23      wiz       341: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig    342: <dd><dl>
                    343: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    344: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    345: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    346: </dl></dd>
                    347: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    348: <dd><dl>
                    349: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    350: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    351: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40    ! wiz       352: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
        !           353: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig    354: </dl></dd>
1.23      wiz       355: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig    356: <dd><dl>
                    357: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    358: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz       359: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.6       rillig    360: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    361: </dl></dd>
1.23      wiz       362: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig    363: <dd><dl>
                    364: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    365: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    366: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    367: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    368: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    369: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    370: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    371: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    372: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj       373: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig    374: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    375: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    376: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    377: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    378: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    379: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    380: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    381: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   382:     emulation</a></span></dt>
1.6       rillig    383: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    384: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   385: </dl></dd>
1.6       rillig    386: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   387: </dl></dd>
1.6       rillig    388: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    389: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   390: <dd><dl>
1.6       rillig    391: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    392: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    393: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz       394: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig    395: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj       396: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    397: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig    398: </dl></dd>
                    399: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    400: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    401: <dd><dl>
                    402: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    403: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    404: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    405: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   406: </dl></dd>
                    407: </dl></dd>
                    408: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    409: <dd><dl>
1.6       rillig    410: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   411: <dd><dl>
1.6       rillig    412: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    413: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    414: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   415: <dd><dl>
1.6       rillig    416: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    417: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   418: </dl></dd>
1.6       rillig    419: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    420: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   421: <dd><dl>
1.6       rillig    422: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    423: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   424: </dl></dd>
1.6       rillig    425: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   426: <dd><dl>
1.23      wiz       427: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    428: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1       dsieger   429: </dl></dd>
                    430: </dl></dd>
1.6       rillig    431: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   432: <dd><dl>
1.6       rillig    433: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    434: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    435: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   436: <dd><dl>
1.6       rillig    437: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    438: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   439: </dl></dd>
                    440: </dl></dd>
1.6       rillig    441: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   442: <dd><dl>
1.6       rillig    443: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    444: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   445: </dl></dd>
                    446: </dl></dd>
                    447: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    448: <dd><dl>
                    449: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    450: <dd><dl>
                    451: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    452: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    453: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       454: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1       dsieger   455: </dl></dd>
                    456: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    457: </dl></dd>
                    458: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    459: <dd><dl>
                    460: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    461: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    462: </dl></dd>
                    463: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    464: <dd><dl>
1.23      wiz       465: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    467: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    468: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    469: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    470: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   471: source packages</a></span></dt>
                    472: </dl></dd>
                    473: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    474: <dd><dl>
                    475: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    476: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    477: </dl></dd>
                    478: </dl>
                    479: </div>
                    480: <div class="list-of-tables">
                    481: <p><b>List of Tables</b></p>
                    482: <dl>
                    483: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    484: </dt>
1.6       rillig    485: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   486: </dt>
1.6       rillig    487: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   488: </dt>
                    489: </dl>
                    490: </div>
1.23      wiz       491: <div class="chapter" title="Chapter 1. What is pkgsrc?">
1.1       dsieger   492: <div class="titlepage"><div><div><h2 class="title">
                    493: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    494: <div class="toc">
                    495: <p><b>Table of Contents</b></p>
                    496: <dl>
                    497: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    498: <dd><dl>
                    499: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    500: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    501: </dl></dd>
                    502: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    503: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    504: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    505: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    506: </dl>
                    507: </div>
1.23      wiz       508: <div class="sect1" title="1.1. Introduction">
1.1       dsieger   509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    510: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    511: <p>There is a lot of software freely available for Unix-based
                    512: systems, which is usually available in form of the source code. Before
                    513: such software can be used, it needs to be configured to the local
                    514: system, compiled and installed, and this is exactly what The NetBSD
                    515: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    516: to handle binary packages, so that not every user has to build the
                    517: packages for himself, which is a time-costly task.</p>
                    518: <p>pkgsrc currently contains several thousand packages,
                    519:       including:</p>
1.23      wiz       520: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    521: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.1       dsieger   522:          web server</p></li>
1.23      wiz       523: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1       dsieger   524:          web browser</p></li>
1.23      wiz       525: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1       dsieger   526:          Desktop Environment</p></li>
1.23      wiz       527: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.1       dsieger   528:          Desktop Environment</p></li>
                    529: </ul></div>
                    530: <p>...just to name a few.</p>
                    531: <p>pkgsrc has built-in support for handling varying dependencies,
                    532:       such as pthreads and X11, and extended features such as IPv6 support on
                    533:       a range of platforms.</p>
1.23      wiz       534: <div class="sect2" title="1.1.1. Why pkgsrc?">
1.1       dsieger   535: <div class="titlepage"><div><div><h3 class="title">
                    536: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    537: <p>
                    538: pkgsrc provides the following key features:
                    539: </p>
1.23      wiz       540: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    541: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   542:   and installation of binary packages. The source and latest
                    543:   patches are retrieved from a master or mirror download site, checksum
                    544:   verified, then built on your system. Support for binary-only
                    545:   distributions is available for both native platforms and NetBSD
                    546:   emulated platforms.</p></li>
1.23      wiz       547: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   548:   including binaries, libraries, man pages and other
                    549:   documentation.</p></li>
1.23      wiz       550: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1       dsieger   551:   are handled automatically. The configuration files of various
                    552:   packages are handled automatically during updates, so local changes
                    553:   are preserved.</p></li>
1.23      wiz       554: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   555:   consists of highly portable code. This allows the greatest speed of
1.25      spz       556:   development when porting to a new platform. This portability also
1.1       dsieger   557:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    558:   platforms</em></span>.</p></li>
1.23      wiz       559: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   560:   international encryption requirements and build-time options for a
                    561:   large number of packages are all set in a simple, central
                    562:   configuration file.</p></li>
1.23      wiz       563: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   564:   freely available under a BSD license, so you may extend and adapt
                    565:   pkgsrc to your needs. Support for local packages and patches is
                    566:   available right out of the box, so you can configure it specifically
                    567:   for your environment.</p></li>
                    568: </ul></div>
                    569: <p>The following principles are basic to pkgsrc:</p>
1.23      wiz       570: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    571: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  572: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   573: them and to complain about them rather than to just install the package
                    574: and hope that it works. There are numerous checks in pkgsrc that try to
                    575: 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
                    576: of shell scripts), and post-installation checks (installed files,
                    577: references to shared libraries, script interpreters).</p></li>
1.23      wiz       578: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  579: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   580: pkgsrc has been ported to many operating systems. Care is taken that
                    581: packages behave the same on all platforms.</p></li>
                    582: </ul></div>
                    583: </div>
1.23      wiz       584: <div class="sect2" title="1.1.2. Supported platforms">
1.1       dsieger   585: <div class="titlepage"><div><div><h3 class="title">
                    586: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    587: <p>pkgsrc consists of both a source distribution and a binary
                    588: distribution for these operating systems. After retrieving the required
                    589: source or binaries, you can be up and running with pkgsrc in just
                    590: minutes!</p>
                    591: <p>pkgsrc was derived from FreeBSD's ports system, and
                    592:       initially developed for NetBSD only. Since then, pkgsrc has
                    593:       grown a lot, and now supports the following platforms:</p>
                    594: <div class="table">
                    595: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    596: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    597: <colgroup>
                    598: <col>
                    599: <col>
                    600: </colgroup>
                    601: <thead><tr>
                    602: <th>Platform</th>
                    603: <th>Date Support Added</th>
                    604: </tr></thead>
                    605: <tbody>
                    606: <tr>
1.10      hubertf   607: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   608: <td align="center">Aug 1997</td>
                    609: </tr>
                    610: <tr>
1.10      hubertf   611: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   612: <td align="center">Mar 1999</td>
                    613: </tr>
                    614: <tr>
1.10      hubertf   615: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   616: <td align="center">Jun 1999</td>
                    617: </tr>
                    618: <tr>
                    619: <td>
1.10      hubertf   620:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    621:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1       dsieger   622:         </td>
                    623: <td align="center">Oct 2001</td>
                    624: </tr>
                    625: <tr>
1.10      hubertf   626: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   627: <td align="center">Nov 2002</td>
                    628: </tr>
                    629: <tr>
1.10      hubertf   630: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   631: <td align="center">Nov 2002</td>
                    632: </tr>
                    633: <tr>
1.10      hubertf   634: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   635: <td align="center">Dec 2002</td>
                    636: </tr>
                    637: <tr>
                    638: <td>BSD/OS</td>
                    639: <td align="center">Dec 2003</td>
                    640: </tr>
                    641: <tr>
1.10      hubertf   642: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   643: <td align="center">Dec 2003</td>
                    644: </tr>
                    645: <tr>
                    646: <td>
1.10      hubertf   647:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   648:           (Microsoft Windows Services for Unix)
                    649:         </td>
                    650: <td align="center">Mar 2004</td>
                    651: </tr>
                    652: <tr>
1.10      hubertf   653: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   654: <td align="center">Oct 2004</td>
                    655: </tr>
                    656: <tr>
1.10      hubertf   657: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   658: <td align="center">Nov 2004</td>
                    659: </tr>
                    660: <tr>
1.10      hubertf   661: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   662: <td align="center">Apr 2007</td>
                    663: </tr>
1.23      wiz       664: <tr>
                    665: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    666: <td align="center">Sep 2010</td>
                    667: </tr>
1.1       dsieger   668: </tbody>
                    669: </table></div>
                    670: </div>
                    671: <br class="table-break">
                    672: </div>
                    673: </div>
1.23      wiz       674: <div class="sect1" title="1.2. Overview">
1.1       dsieger   675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    676: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    677: <p>This document is divided into three parts. The first,
1.10      hubertf   678:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   679:        describes how one can use one of the packages in the Package
                    680:        Collection, either by installing a precompiled binary package,
                    681:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   682:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1       dsieger   683:        package so it can be easily built by other NetBSD users without
                    684:        knowing about the package's building details. The third part,
1.10      hubertf   685:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   686:        is intended for those who want to understand how pkgsrc is
                    687:        implemented.</p>
                    688: <p>This document is available in various formats:
1.10      hubertf   689:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1       dsieger   690: </div>
1.23      wiz       691: <div class="sect1" title="1.3. Terminology">
1.1       dsieger   692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    693: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       694: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    695:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   696:       terminology used within this document.</p>
                    697: <div class="variablelist"><dl>
                    698: <dt><span class="term">Package</span></dt>
                    699: <dd><p>A set of files and building instructions
                    700:            that describe what's necessary
                    701:            to build a certain piece of software using
                    702:             pkgsrc. Packages are traditionally stored under
                    703:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    704: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       705: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   706:          is part of the NetBSD operating system and can be bootstrapped
                    707:          to run on non-NetBSD operating systems as well.  It handles
                    708:          building (compiling), installing, and removing of
                    709:          packages.</p></dd>
                    710: <dt><span class="term">Distfile</span></dt>
                    711: <dd><p>This term describes the file or files that are
                    712:            provided by the author of the piece of software to
                    713:            distribute his work. All the changes necessary to build on
                    714:            NetBSD are reflected in the corresponding package. Usually
                    715:            the distfile is in the form of a compressed tar-archive,
                    716:            but other types are possible, too. Distfiles are usually
                    717:            stored below
                    718:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    719: <dt><span class="term">Port</span></dt>
                    720: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    721:            for what we call a package.
1.23      wiz       722:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   723:            architecture.</p></dd>
                    724: <dt><span class="term">Precompiled/binary package</span></dt>
                    725: <dd>
                    726: <p>A set of binaries built with pkgsrc from a distfile
                    727:            and stuffed together in a single <code class="filename">.tgz</code>
                    728:            file so it can be installed on machines of the same
                    729:            machine architecture without the need to
                    730:            recompile. Packages are usually generated in
                    731:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       732:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       733: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   734:            especially in the context of precompiled packages.</p>
                    735: </dd>
                    736: <dt><span class="term">Program</span></dt>
                    737: <dd><p>The piece of software to be installed which will be
                    738:          constructed from all the files in the distfile by the
                    739:          actions defined in the corresponding package.</p></dd>
                    740: </dl></div>
1.23      wiz       741: <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
1.1       dsieger   742: <div class="titlepage"><div><div><h3 class="title">
                    743: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
                    744: <div class="variablelist"><dl>
                    745: <dt><span class="term">pkgsrc users</span></dt>
                    746: <dd>
                    747: <p>The
                    748:        pkgsrc users are people who use the packages provided by pkgsrc.
                    749:        Typically they are system administrators. The people using the
1.23      wiz       750:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    751:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   752: <p>There are two kinds of pkgsrc users: Some only want to
                    753:        install pre-built binary packages. Others build the pkgsrc
                    754:        packages from source, either for installing them directly or for
1.10      hubertf   755:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.1       dsieger   756:        documentation.</p>
                    757: </dd>
                    758: <dt><span class="term">package maintainers</span></dt>
                    759: <dd><p>A
1.10      hubertf   760:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.1       dsieger   761: <dt><span class="term">infrastructure developers</span></dt>
                    762: <dd><p>These people are involved in all those files
                    763:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   764:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.1       dsieger   765:        too.</p></dd>
                    766: </dl></div>
                    767: </div>
                    768: </div>
1.23      wiz       769: <div class="sect1" title="1.4. Typography">
1.1       dsieger   770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    771: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    772: <p>When giving examples for commands, shell prompts are used to
                    773:       show if the command should/can be issued as root, or if
1.23      wiz       774:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.1       dsieger   775:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    776:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    777: </div>
                    778: </div>
1.23      wiz       779: <div class="part" title="Part I. The pkgsrc user's guide">
1.1       dsieger   780: <div class="titlepage"><div><div><h1 class="title">
                    781: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    782: <div class="toc">
                    783: <p><b>Table of Contents</b></p>
                    784: <dl>
                    785: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    786: <dd><dl>
                    787: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    788: <dd><dl>
                    789: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       790: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   791: </dl></dd>
                    792: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    793: <dd><dl>
                    794: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    795: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    796: </dl></dd>
                    797: </dl></dd>
                    798: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    799: <dd><dl>
                    800: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    801: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    802: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    803: <dd><dl>
                    804: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    805: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    806: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    807: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    808: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    809: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    810: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                    811: </dl></dd>
                    812: </dl></dd>
                    813: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    814: <dd><dl>
                    815: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    816: <dd><dl>
                    817: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    818: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    819: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    820: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    821: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    822: <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>
                    823: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    824: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    825: </dl></dd>
                    826: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    827: <dd><dl>
                    828: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    829: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    830: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    831: </dl></dd>
                    832: </dl></dd>
                    833: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    834: <dd><dl>
                    835: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    836: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    837: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    838: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   839: <dd><dl>
1.4       rillig    840: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       841: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    842: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   843: </dl></dd>
1.4       rillig    844: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    845: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   846: </dl></dd>
                    847: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    848: <dd><dl>
                    849: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    850: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    851: </dl></dd>
                    852: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    853: builds)</a></span></dt>
1.1       dsieger   854: <dd><dl>
1.6       rillig    855: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    856: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    857: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    858: <dd><dl>
                    859: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    860: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    861: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    862: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    863: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    864: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    865: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    866: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    867: </dl></dd>
                    868: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    869: <dd><dl>
                    870: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    871: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    872: </dl></dd>
1.6       rillig    873: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    874: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    875: </dl></dd>
                    876: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    877: <dd><dl>
1.23      wiz       878: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    879: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    880: </dl></dd>
                    881: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    882: <dd><dl>
                    883: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    884: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    885: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    886: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    887: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    889: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23      wiz       890: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6       rillig    891: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       892: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                    893: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    894: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.6       rillig    895: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    896: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    897: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       898: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6       rillig    899: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.23      wiz       900: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   901: </dl></dd>
                    902: </dl>
                    903: </div>
1.23      wiz       904: <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
1.1       dsieger   905: <div class="titlepage"><div><div><h2 class="title">
                    906: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    907: <div class="toc">
                    908: <p><b>Table of Contents</b></p>
                    909: <dl>
                    910: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    911: <dd><dl>
                    912: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       913: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   914: </dl></dd>
                    915: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    916: <dd><dl>
                    917: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    918: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    919: </dl></dd>
                    920: </dl>
                    921: </div>
                    922: <p>Before you download and extract the files, you need to decide
                    923: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    924: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    925: free to install the sources and binary packages wherever you want in
                    926: your filesystem, provided that the pathname does not contain white-space
                    927: or other characters that are interpreted specially by the shell and some
                    928: other programs. A safe bet is to use only letters, digits, underscores
                    929: and dashes.</p>
1.23      wiz       930: <div class="sect1" title="2.1. Getting pkgsrc for the first time">
1.1       dsieger   931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    932: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    933: <p>Before you download any pkgsrc files, you should decide
                    934:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    935:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    936:        quarterly basis from the current branch and only gets modified
                    937:        for security updates. The names of the stable branches are built
                    938:        from the year and the quarter, for example
1.21      snj       939:        <code class="literal">2009Q1</code>.</p>
1.1       dsieger   940: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       941:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    942:        Both ways are described here.</p>
                    943: <div class="sect2" title="2.1.1. As tar file">
1.1       dsieger   944: <div class="titlepage"><div><div><h3 class="title">
                    945: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    946: <p>The primary download location for all pkgsrc files is
1.10      hubertf   947:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.1       dsieger   948:        number of subdirectories for different purposes, which are
1.10      hubertf   949:        described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.1       dsieger   950: <p>The tar file for the current branch is in the directory
1.10      hubertf   951:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1       dsieger   952:        It is autogenerated daily.</p>
1.21      snj       953: <p>The tar file for the stable branch 2009Q1 is in the
                    954:        directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.12      weinem    955: <p>To download a pkgsrc stable tarball, run:</p>
                    956: <pre class="screen">
1.22      jakllsch  957: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
                    958: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12      weinem    959:        stable branch to be downloaded, for example, 
1.23      wiz       960:        <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</p>
1.12      weinem    961: <p>Then, extract it with:</p>
1.22      jakllsch  962: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.12      weinem    963: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    964:        in <code class="filename">/usr/</code> and all the package source will be 
                    965:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    966: <p>To download pkgsrc-current, run:</p>
                    967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1       dsieger   968: </div>
1.23      wiz       969: <div class="sect2" title="2.1.2. Via anonymous CVS">
1.1       dsieger   970: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz       971: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    972: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39      wiz       973: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23      wiz       974: </pre>
                    975: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
                    976:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
                    977: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    978:        in your <code class="filename">/usr/</code> directory and all the package source 
                    979:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    980: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz       981: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger   982: </pre>
1.29      dholland  983: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23      wiz       984: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz       985: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23      wiz       986: </pre>
                    987: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    988:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    989:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    990: <pre class="programlisting">
                    991: # set CVS remote shell command
                    992: CVS_RSH=ssh
                    993: export CVS_RSH
                    994: </pre>
                    995: <p>By default, CVS doesn't do things like most people would expect it to do.
                    996:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                    997:        in your home directory and saving the following lines to it.
                    998:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                    999:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1000: <pre class="programlisting">
                   1001: # recommended CVS configuration file from the pkgsrc guide
1.39      wiz      1002: cvs -q -z2
1.2       rillig   1003: checkout -P
1.4       rillig   1004: update -dP
                   1005: diff -upN
1.2       rillig   1006: rdiff -u
1.23      wiz      1007: release -d
1.2       rillig   1008: </pre>
1.1       dsieger  1009: </div>
                   1010: </div>
1.23      wiz      1011: <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1.1       dsieger  1012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1013: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1014: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1015:        (which also works if you have first installed it via a tar
                   1016:        file). It saves bandwidth and hard disk activity, compared to
                   1017:        downloading the tar file again.</p>
1.23      wiz      1018: <div class="sect2" title="2.2.1. Via tar files">
1.1       dsieger  1019: <div class="titlepage"><div><div><h3 class="title">
                   1020: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.23      wiz      1021: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1022: <h3 class="title">Warning</h3>
                   1023: <p>When updating from a tar file, you first need to
                   1024:        completely remove the old pkgsrc directory. Otherwise those
                   1025:        files that have been removed from pkgsrc in the mean time will
                   1026:        not be removed on your local disk, resulting in inconsistencies.
                   1027:        When removing the old files, any changes that you have done to
                   1028:        the pkgsrc files will be lost after updating. Therefore updating
                   1029:        via CVS is strongly recommended.</p>
                   1030: </div>
                   1031: <p>Note that by default the distfiles and the binary packages
                   1032:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1033:        before updating. You can also configure pkgsrc to use other than
                   1034:        the default directories by setting the
                   1035:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1036:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1037: <p>To update pkgsrc from a tar file, download the tar file as
                   1038:        explained above. Then, make sure that you have not made any
                   1039:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1040:        directory and extract the new tar file. Done.</p>
                   1041: </div>
1.23      wiz      1042: <div class="sect2" title="2.2.2. Via CVS">
1.1       dsieger  1043: <div class="titlepage"><div><div><h3 class="title">
                   1044: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25      spz      1045: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1046: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1047: </pre>
                   1048: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
                   1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
                   1050: </pre>
1.23      wiz      1051: <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1.1       dsieger  1052: <div class="titlepage"><div><div><h4 class="title">
                   1053: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1054: <p>When updating pkgsrc, the CVS program keeps track of the
                   1055:        branch you selected. But if you, for whatever reason, want to
                   1056:        switch from the stable branch to the current one, you can do it
1.23      wiz      1057:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1058:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1059:        back to the stable branch, add the
1.23      wiz      1060:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1.1       dsieger  1061: </div>
1.23      wiz      1062: <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1.1       dsieger  1063: <div class="titlepage"><div><div><h4 class="title">
                   1064: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1065: <p>When you update pkgsrc, the CVS program will only touch
                   1066:        those files that are registered in the CVS repository. That
                   1067:        means that any packages that you created on your own will stay
                   1068:        unmodified. If you change files that are managed by CVS, later
                   1069:        updates will try to merge your changes with those that have been
                   1070:        done by others. See the CVS manual, chapter
1.23      wiz      1071:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1072: </div>
                   1073: </div>
                   1074: </div>
                   1075: </div>
1.23      wiz      1076: <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1.1       dsieger  1077: <div class="titlepage"><div><div><h2 class="title">
                   1078: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1079: <div class="toc">
                   1080: <p><b>Table of Contents</b></p>
                   1081: <dl>
                   1082: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1083: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1084: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1085: <dd><dl>
                   1086: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1087: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1088: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1089: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1090: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1091: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1092: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                   1093: </dl></dd>
                   1094: </dl>
                   1095: </div>
1.23      wiz      1096: <div class="sect1" title="3.1. Binary distribution">
1.1       dsieger  1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1098: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1099: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1100: </div>
1.23      wiz      1101: <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1.1       dsieger  1102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1103: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1104: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1105: <pre class="screen">
                   1106: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1107: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1108: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1109:     </pre>
1.10      hubertf  1110: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.1       dsieger  1111:     pkgsrc before bootstrapping. The given
1.10      hubertf  1112:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.1       dsieger  1113:     <code class="filename">/usr/pkg</code> for the
                   1114:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1115:     and <code class="filename">/var/db/pkg</code> for the package database
                   1116:     directory where pkgsrc will do its internal bookkeeping.
                   1117:     However, these can also be set using command-line
                   1118:     arguments.</p>
1.23      wiz      1119: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1120: <h3 class="title">Note</h3>
1.10      hubertf  1121: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1122:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1123:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1124:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1125: </div>
                   1126: </div>
1.23      wiz      1127: <div class="sect1" title="3.3. Platform-specific notes">
1.1       dsieger  1128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1129: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1130: <p>Here are some platform-specific notes you should be aware of.</p>
1.23      wiz      1131: <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1.1       dsieger  1132: <div class="titlepage"><div><div><h3 class="title">
                   1133: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.22      jakllsch 1134: <p>Darwin 5.x and up are supported. Before you start, you
                   1135:       will need to download and install the Mac OS X Developer Tools
                   1136:       from Apple's Developer Connection. See
                   1137:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1138:       for details.  Also, make sure you install X11 (an optional
                   1139:       package included with the Developer Tools) if you intend to
                   1140:       build packages that use the X11 Window System.</p>
1.1       dsieger  1141: </div>
1.23      wiz      1142: <div class="sect2" title="3.3.2. FreeBSD">
1.1       dsieger  1143: <div class="titlepage"><div><div><h3 class="title">
                   1144: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.29      dholland 1145: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1       dsieger  1146:       other versions may work.</p>
                   1147: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1148:       with the FreeBSD userland tools. There are several steps:</p>
1.23      wiz      1149: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1150: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1       dsieger  1151:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1152:          recommended that you choose a different location (e.g.
                   1153:          <code class="filename">/usr/pkgdb</code>) by
                   1154:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1155: <li class="listitem">
1.1       dsieger  1156: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1157:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1158: <pre class="screen">
                   1159: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1160: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1161: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1162: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1163: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1164:          </pre>
                   1165: </li>
1.23      wiz      1166: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1167:          <code class="filename">/etc/mk.conf.example</code> file
                   1168:          when you use the bootstrap script.</p></li>
                   1169: </ol></div>
                   1170: </div>
1.23      wiz      1171: <div class="sect2" title="3.3.3. Interix">
1.1       dsieger  1172: <div class="titlepage"><div><div><h3 class="title">
                   1173: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
                   1174: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1175:       providing a Unix-like environment with a tighter kernel integration than
                   1176:       available with Cygwin.  It is part of the Windows Services for Unix
                   1177:       package, available for free for any licensed copy of Windows 2000, XP
1.10      hubertf  1178:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1       dsieger  1179: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1180:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1181:       of pthreads, but other parts of libc may also be lacking.)</p>
1.24      wiz      1182: <p>Services for Unix Applications (aka SUA) is an integrated
                   1183:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1184:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1185:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1186:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1187:       work as well. The Interix 5.x subsystem has not yet been tested
                   1188:       with pkgsrc.</p>
1.23      wiz      1189: <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1.1       dsieger  1190: <div class="titlepage"><div><div><h4 class="title">
                   1191: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
                   1192: <p>At an absolute minimum, the following packages must be installed from
                   1193:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.23      wiz      1194: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1195: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1196: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1197: <li class="listitem"><p>Remote Connectivity</p></li>
                   1198: <li class="listitem"><p>Interix SDK</p></li>
1.1       dsieger  1199: </ul></div>
                   1200: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1201:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1202:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1203:        pkgsrc (or from a binary package).</p>
                   1204: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1205:        not need to be installed, but Remote Connectivity itself should be
                   1206:        installed in order to have a working inetd.</p>
                   1207: <p>During installation you may be asked whether to enable setuid
                   1208:        behavior for Interix programs, and whether to make pathnames default to
                   1209:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1210:        enabled.  (Without case-sensitivity, a large number of packages including
                   1211:        perl will not build.)</p>
                   1212: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1213:        works (via the Data Execution Prevention feature).  In order to use
                   1214:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1215:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1216:        must be installed.  Hotfixes are available from Microsoft through a
1.14      jmcneill 1217:        support contract; however, Debian Interix Port has made most Interix
                   1218:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1       dsieger  1219: <p>In addition to the hotfix noted above, it may be necessary to
                   1220:        disable Data Execution Prevention entirely to make Interix functional.
                   1221:        This may happen only with certain types of CPUs; the cause is not fully
                   1222:        understood at this time.  If gcc or other applications still segfault
                   1223:        repeatedly after installing one of the hotfixes note above, the
                   1224:        following option can be added to the appropriate "boot.ini" line on the
                   1225:        Windows boot drive:  /NoExecute=AlwaysOff
                   1226:        (WARNING, this will disable DEP completely, which may be a security
                   1227:        risk if applications are often run as a user in the Administrators
                   1228:        group!)</p>
                   1229: </div>
1.23      wiz      1230: <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1.1       dsieger  1231: <div class="titlepage"><div><div><h4 class="title">
                   1232: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
                   1233: <p>If SFU is already installed and you wish to alter these settings to work
                   1234:        with pkgsrc, note the following things.</p>
1.23      wiz      1235: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1236: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1       dsieger  1237:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1238:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.23      wiz      1239: <li class="listitem">
1.1       dsieger  1240: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1241:            change the following registry key:</p>
                   1242: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1243: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1244: </li>
1.23      wiz      1245: <li class="listitem">
1.1       dsieger  1246: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1247:            following registry key:</p>
                   1248: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1249: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1250: </li>
                   1251: </ul></div>
                   1252: </div>
1.23      wiz      1253: <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1.1       dsieger  1254: <div class="titlepage"><div><div><h4 class="title">
                   1255: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
                   1256: <p>The package manager (either the pkgsrc "su" user, or the user
                   1257:        running "pkg_add") must be a member of the local Administrators
                   1258:        group.  Such a user must also be used to run the bootstrap.  This is
                   1259:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1260: <p>The package manager should use a umask of 002.  "make install" will
                   1261:        automatically complain if this is not the case.  This ensures that
                   1262:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1263: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1264:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1265:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1266:        the same time as the pkgsrc packages, ensure that you use the proper
                   1267:        pkg_* tools for each type of binary package.</p>
                   1268: <p>The TERM setting used for DOS-type console windows (including those
                   1269:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1270:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1271:        entry provides adequate emulation in most cases:</p>
                   1272: <pre class="programlisting">
                   1273: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1274:        </pre>
                   1275: </div>
1.23      wiz      1276: <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1.1       dsieger  1277: <div class="titlepage"><div><div><h4 class="title">
                   1278: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
                   1279: <p>Though Interix suffices as a familiar and flexible substitute
                   1280:        for a full Unix-like platform, it has some drawbacks that should
                   1281:        be noted for those desiring to make the most of Interix.</p>
1.23      wiz      1282: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1283: <li class="listitem">
1.1       dsieger  1284: <p><span class="strong"><strong>X11:</strong></span></p>
                   1285: <p>Interix comes with the standard set of X11R6 client libraries,
                   1286:          and can run X11 based applications, but it does
                   1287:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.10      hubertf  1288:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1289:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1       dsieger  1290:          (available in a trimmed version for Interix from Interop Systems as the
1.10      hubertf  1291:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1       dsieger  1292:          and the free X11 server included with
1.10      hubertf  1293:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1       dsieger  1294: </li>
1.23      wiz      1295: <li class="listitem">
1.1       dsieger  1296: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1297: <p>Because Interix runs in a completely different NT subsystem from
                   1298:          Win32 applications, it does not currently support various X11
                   1299:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1300:          Most interactive applications to a local X server will run
                   1301:          reasonably fast, but full motion video and other graphics
                   1302:          intensive applications may require a faster-than-expected CPU.</p>
                   1303: </li>
1.23      wiz      1304: <li class="listitem">
1.1       dsieger  1305: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1306: <p>Interix has no native support for audio output.  For audio
1.10      hubertf  1307:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1       dsieger  1308:          audio system on Interix.  Unlike on most platforms, the
                   1309:          <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.10      hubertf  1310:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1       dsieger  1311:          server component.  To output audio via an Interix host, the
                   1312:          <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
                   1313:          must also be installed.</p>
                   1314: </li>
1.23      wiz      1315: <li class="listitem">
1.1       dsieger  1316: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1317: <p>Direct device access is not currently supported in Interix, so it
                   1318:          is not currently possible to access CD/DVD drives, USB devices,
                   1319:          or SCSI devices through non-filesystem means.  Among other things,
                   1320:          this makes it impossible to use Interix directly for CD/DVD
                   1321:          burning.</p>
                   1322: </li>
1.23      wiz      1323: <li class="listitem">
1.1       dsieger  1324: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1325: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1326:          drives are also not directly accessible in Interix.  However,
                   1327:          support is in work to make tape drive access possible by using
                   1328:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1329:          esound server).</p>
                   1330: </li>
                   1331: </ul></div>
                   1332: </div>
1.23      wiz      1333: <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1.1       dsieger  1334: <div class="titlepage"><div><div><h4 class="title">
                   1335: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
                   1336: <p>It is not necessary, in general, to have a "root" user on the
                   1337:        Windows system; any member of the local Administrators group will
                   1338:        suffice.  However, some packages currently assume that the user
                   1339:        named "root" is the privileged user.  To accommodate these, you
                   1340:        may create such a user; make sure it is in the local group
                   1341:        Administrators (or your language equivalent).</p>
1.10      hubertf  1342: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1       dsieger  1343:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1344:        time being, install packages as the local Administrator (or
                   1345:        your language equivalent), or run the following command after
                   1346:        installing a package to work around the issue:</p>
                   1347: <pre class="screen">
                   1348: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1349:        </pre>
                   1350: </div>
                   1351: </div>
1.23      wiz      1352: <div class="sect2" title="3.3.4. IRIX">
1.1       dsieger  1353: <div class="titlepage"><div><div><h3 class="title">
                   1354: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
                   1355: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1356:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1357:       according to your preference.  If you do not have a license for the MIPSpro
1.10      hubertf  1358:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1       dsieger  1359: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29      dholland 1360:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1       dsieger  1361:       etc.</p>
                   1362: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1363:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1364:        you start out using "abi=n32", that's what all your packages will be built
                   1365:        with.</p>
                   1366: <p>Therefore, please make sure that you have no conflicting
                   1367:       <code class="varname">CFLAGS</code> in your environment or the
1.10      hubertf  1368:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1369:       try to link n32 object files with lib64 or vice versa.  Check your
                   1370:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1371: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1372:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1373:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1374:       link over a network-mounted file system.</p>
                   1375: <p>The bootstrapping process should set all the right options for programs such
                   1376:       as imake(1), but you may want to set some options depending on your local
                   1377:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1378:       course, your compiler's man pages for details.</p>
                   1379: <p>If you are using SGI's MIPSPro compiler, please set
                   1380: 
                   1381:       </p>
                   1382: <pre class="programlisting">
                   1383: PKGSRC_COMPILER=        mipspro
                   1384:       </pre>
                   1385: <p>
                   1386: 
1.10      hubertf  1387:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1388:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1389:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1390:       default.</p>
                   1391: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1392:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1393:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1394:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1395:       '--preserve-path' flag.</p>
                   1396: </div>
1.23      wiz      1397: <div class="sect2" title="3.3.5. Linux">
1.1       dsieger  1398: <div class="titlepage"><div><div><h3 class="title">
                   1399: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
                   1400: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1401:       either libtermcap or libcurses (libncurses).  Installing the
                   1402:       distributions libncurses-dev package (or equivalent) should fix
                   1403:       the problem.</p>
                   1404: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1405:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1406:       i386 have been tested.</p>
                   1407: <p>To bootstrap using icc, assuming the default icc installation
                   1408:       directory:</p>
                   1409: <pre class="programlisting">
1.31      wiz      1410: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1       dsieger  1411:       </pre>
1.23      wiz      1412: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1413: <h3 class="title">Note</h3>
1.31      wiz      1414: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1415: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1416: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1417: </div>
                   1418: <p>Use a value for ICCBASE that corresponds to the directory
                   1419:       where icc is installed. After bootstrapping, set
                   1420:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30      wiz      1421: <pre class="programlisting">
1.31      wiz      1422: ICCBASE=                /opt/intel/cc/10.1.008
1.1       dsieger  1423:       </pre>
1.31      wiz      1424: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1425:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1426:       install directory for icc 8.0. If you are using a more recent
                   1427:       version, be sure to set the correct path explicitly.
                   1428:       </p>
1.1       dsieger  1429: <p>pkgsrc uses the static linking method of the runtime libraries
                   1430:       provided by icc, so binaries can be run on other systems which do not
                   1431:       have the shared libraries installed.</p>
                   1432: <p>Libtool, however, extracts a list of libraries from the
1.29      dholland 1433:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1       dsieger  1434:       records it, throwing away the -Bstatic and -Bdynamic options
                   1435:       interspersed between the libraries.  This means that
                   1436:       libtool-linked C++ shared libraries will have a runtime
                   1437:       dependency on the icc libraries until this is fixed in
                   1438:       libtool.</p>
                   1439: </div>
1.23      wiz      1440: <div class="sect2" title="3.3.6. OpenBSD">
1.1       dsieger  1441: <div class="titlepage"><div><div><h3 class="title">
                   1442: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.29      dholland 1443: <p>OpenBSD 5.1 has been tested and supported,
                   1444:       other versions may work.</p>
1.1       dsieger  1445: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1446:       with the OpenBSD userland tools. There are several steps:</p>
1.23      wiz      1447: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1448: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1       dsieger  1449:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1450:          recommended that you choose a different location (e.g.
                   1451:          <code class="filename">/usr/pkgdb</code>) by
                   1452:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1453: <li class="listitem">
1.1       dsieger  1454: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1455:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1456: <pre class="screen">
                   1457: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1458: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1459: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1460: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1461: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1462:          </pre>
                   1463: </li>
1.23      wiz      1464: <li class="listitem">
1.10      hubertf  1465: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1466:          <code class="filename">/etc/mk.conf.example</code> file
                   1467:          when you use the bootstrap script. OpenBSD's make program uses
1.10      hubertf  1468:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1469:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1470:          of the file with:</p>
                   1471: <pre class="programlisting">
                   1472: .ifdef BSD_PKG_MK
                   1473: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1474: .else
                   1475: # OpenBSD stuff
                   1476: .endif
                   1477:          </pre>
                   1478: </li>
                   1479: </ol></div>
                   1480: </div>
1.23      wiz      1481: <div class="sect2" title="3.3.7. Solaris">
1.1       dsieger  1482: <div class="titlepage"><div><div><h3 class="title">
                   1483: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.35      wiz      1484: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
                   1485:       You will need a working C compiler. Both gcc 4.5.3 and
1.1       dsieger  1486:       Sun WorkShop 5 have been tested.</p>
                   1487: <p>The following packages are required on Solaris 8 for the bootstrap
                   1488:       process and to build packages.</p>
1.23      wiz      1489: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1490: <li class="listitem"><p>SUNWsprot</p></li>
                   1491: <li class="listitem"><p>SUNWarc</p></li>
                   1492: <li class="listitem"><p>SUNWbtool</p></li>
                   1493: <li class="listitem"><p>SUNWtoo</p></li>
                   1494: <li class="listitem"><p>SUNWlibm</p></li>
1.1       dsieger  1495: </ul></div>
                   1496: <p>Please note that the use of GNU binutils on Solaris is
                   1497:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1498: <p>Whichever compiler you use, please ensure the compiler tools and
                   1499:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1500:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1501:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.23      wiz      1502: <div class="sect3" title="3.3.7.1. If you are using gcc">
1.1       dsieger  1503: <div class="titlepage"><div><div><h4 class="title">
                   1504: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
                   1505: <p>It makes life much simpler if you only use the same gcc consistently
                   1506:        for building all packages.</p>
                   1507: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1508:        then either build gcc from
1.35      wiz      1509:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1       dsieger  1510:        package, then remove gcc used during bootstrapping.</p>
1.10      hubertf  1511: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.1       dsieger  1512: </div>
1.23      wiz      1513: <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1.1       dsieger  1514: <div class="titlepage"><div><div><h4 class="title">
                   1515: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
                   1516: <p>You will need at least the following packages installed (from WorkShop
                   1517:        5.0)</p>
1.23      wiz      1518: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1519: <li class="listitem"><p>SPROcc
1.1       dsieger  1520:          - Sun WorkShop Compiler C 5.0</p></li>
1.23      wiz      1521: <li class="listitem"><p>SPROcpl
1.1       dsieger  1522:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.23      wiz      1523: <li class="listitem"><p>SPROild
1.1       dsieger  1524:          - Sun WorkShop Incremental Linker</p></li>
1.23      wiz      1525: <li class="listitem"><p>SPROlang
1.1       dsieger  1526:          - Sun WorkShop Compilers common components</p></li>
                   1527: </ul></div>
                   1528: <p>You should set the following variables in your
1.10      hubertf  1529:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1530: <pre class="programlisting">
                   1531: CC=     cc
                   1532: CXX=    CC
                   1533: CPP=    cc -E
                   1534: CXXCPP= CC -E
                   1535: </pre>
1.23      wiz      1536: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1537: <h3 class="title">Note</h3>
                   1538: <p>The <code class="varname">CPP</code> setting might break some
                   1539:        packages that use the C preprocessor for processing things other
                   1540:        than C source code.</p>
                   1541: </div>
                   1542: </div>
1.23      wiz      1543: <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1.1       dsieger  1544: <div class="titlepage"><div><div><h4 class="title">
                   1545: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
                   1546: <p>To build 64-bit packages, you just need to have the
1.10      hubertf  1547:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1548: <pre class="programlisting">
                   1549: PKGSRC_COMPILER=        sunpro
                   1550: ABI=                    64
                   1551: </pre>
1.23      wiz      1552: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1553: <h3 class="title">Note</h3>
                   1554: <p>This setting has been tested for the SPARC
                   1555:        architecture. Intel and AMD machines need some more
                   1556:        work.</p>
                   1557: </div>
                   1558: </div>
1.23      wiz      1559: <div class="sect3" title="3.3.7.4. Common problems">
1.1       dsieger  1560: <div class="titlepage"><div><div><h4 class="title">
                   1561: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10      hubertf  1562: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1       dsieger  1563:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1564:       The workaround is to use another shell for the configure
                   1565:       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.10      hubertf  1566:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1567: <pre class="programlisting">
                   1568: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1569: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1570:       </pre>
                   1571: <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>
                   1572: </div>
                   1573: </div>
                   1574: </div>
                   1575: </div>
1.23      wiz      1576: <div class="chapter" title="Chapter 4. Using pkgsrc">
1.1       dsieger  1577: <div class="titlepage"><div><div><h2 class="title">
                   1578: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1579: <div class="toc">
                   1580: <p><b>Table of Contents</b></p>
                   1581: <dl>
                   1582: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1583: <dd><dl>
                   1584: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1585: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1586: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1587: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1588: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1589: <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>
                   1590: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1591: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1592: </dl></dd>
                   1593: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1594: <dd><dl>
                   1595: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1596: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1597: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1598: </dl></dd>
                   1599: </dl>
                   1600: </div>
                   1601: <p>Basically, there are two ways of using pkgsrc. The first
                   1602: is to only install the package tools and to use binary packages
1.23      wiz      1603: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1604: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1605: of pkgsrc, too. Then you are able to build your own packages,
                   1606: and you can still use binary packages from someone else.</p>
1.23      wiz      1607: <div class="sect1" title="4.1. Using binary packages">
1.1       dsieger  1608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1609: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1610: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1611:   server and its mirrors, there are collections of binary packages,
                   1612:   ready to be installed. These binary packages have been built using the
                   1613:   default settings for the directories, that is:</p>
1.23      wiz      1614: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1615: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1616: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1617: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9       rillig   1618: </ul></div>
                   1619: <p>If you cannot use these directories for whatever reasons (maybe
                   1620:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1621:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.23      wiz      1622: <div class="sect2" title="4.1.1. Finding binary packages">
1.1       dsieger  1623: <div class="titlepage"><div><div><h3 class="title">
                   1624: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1625: <p>To install binary packages, you first need to know from where
                   1626:     to get them. The first place where you should look is on the main
1.10      hubertf  1627:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5       weinem   1628: <p>This directory contains binary packages for multiple
                   1629:     platforms. First, select your operating system. (Ignore the
                   1630:     directories with version numbers attached to it, they just exist for
                   1631:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1632:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1633: <p>In this directory, you often find a file called
                   1634:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1635:     management tools. If the file is missing, it is likely that your
                   1636:     operating system already provides those tools. Download the file and
                   1637:     extract it in the <code class="filename">/</code> directory. It will create
                   1638:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1639:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1640:     (the database of installed packages).</p>
1.1       dsieger  1641: </div>
1.23      wiz      1642: <div class="sect2" title="4.1.2. Installing binary packages">
1.1       dsieger  1643: <div class="titlepage"><div><div><h3 class="title">
                   1644: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1645: <p>In the directory from the last section, there is a
                   1646:     subdirectory called <code class="filename">All</code>, which contains all the
                   1647:     binary packages that are available for the platform, excluding those
                   1648:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1649:     medium you are using).</p>
1.9       rillig   1650: <p>To install packages directly from an FTP or HTTP server, run
                   1651:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1652:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1653: <pre class="screen">
                   1654: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1655: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
                   1656: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1657: </pre>
                   1658: <p>Instead of URLs, you can also use local paths, for example if
                   1659:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1660:     repository. If you want to install packages from multiple sources,
                   1661:     you can separate them by a semicolon in
                   1662:     <code class="varname">PKG_PATH</code>.</p>
                   1663: <p>After these preparations, installing a package is very
                   1664:     easy:</p>
                   1665: <pre class="screen">
                   1666: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1667: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1668: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1669: </pre>
1.1       dsieger  1670: <p>Note that any prerequisite packages needed to run the
                   1671:     package in question will be installed, too, assuming they are
                   1672:     present where you install from.</p>
1.23      wiz      1673: <p>Adding packages might install vulnerable packages.
                   1674:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1675:     regularly, especially after installing new packages, and verify
                   1676:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1677: <p>After you've installed packages, be sure to have
                   1678:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1679:     <code class="varname">PATH</code> so you can actually start the just
                   1680:     installed program.</p>
                   1681: </div>
1.23      wiz      1682: <div class="sect2" title="4.1.3. Deinstalling packages">
1.1       dsieger  1683: <div class="titlepage"><div><div><h3 class="title">
                   1684: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1685: <p>To deinstall a package, it does not matter whether it was
                   1686:     installed from source code or from a binary package. The
1.10      hubertf  1687:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1688:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1689:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1690:     name can be given with or without version number. Wildcards can
                   1691:     also be used to deinstall a set of packages, for example
                   1692:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1693:     so that the shell does not expand them before
                   1694:     <code class="literal">pkg_delete</code> sees them.</p>
                   1695: <p>The <code class="option">-r</code> option is very powerful: it
                   1696:     removes all the packages that require the package in question
                   1697:     and then removes the package itself. For example:
                   1698: 
                   1699:     </p>
                   1700: <pre class="screen">
                   1701: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1702:     </pre>
                   1703: <p>
                   1704: 
                   1705:     will remove jpeg and all the packages that used it; this allows
                   1706:     upgrading the jpeg package.</p>
                   1707: </div>
1.23      wiz      1708: <div class="sect2" title="4.1.4. Getting information about installed packages">
1.1       dsieger  1709: <div class="titlepage"><div><div><h3 class="title">
                   1710: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1711: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1712:     installed packages or binary package files.</p>
                   1713: </div>
1.23      wiz      1714: <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1.1       dsieger  1715: <div class="titlepage"><div><div><h3 class="title">
                   1716: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1717: <p>
                   1718:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1719:       known security vulnerabilities to packages which are (or have been)
                   1720:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1721:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1       dsieger  1722:     </p>
                   1723: <p>
1.22      jakllsch 1724:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1725:       this list can be downloaded
                   1726:       automatically, and a security audit of all packages installed on a system
                   1727:       can take place.
                   1728:     </p>
                   1729: <p>
1.22      jakllsch 1730:       There are two components to auditing.  The first
                   1731:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1732:       is for downloading
1.1       dsieger  1733:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1734:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1735:       installed packages are vulnerable.  If a package is vulnerable, you
                   1736:       will see output similar to the following:
                   1737:     </p>
                   1738: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1739:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1740: <p>
1.22      jakllsch 1741:       You may wish to have the
1.10      hubertf  1742:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1743:       file downloaded daily so that
                   1744:       it remains current.  This may be done by adding an appropriate entry
1.29      dholland 1745:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.22      jakllsch 1746:       </p>
                   1747: <pre class="screen">
                   1748: # download vulnerabilities file
                   1749: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1750:       </pre>
                   1751: <p>
                   1752:       will update the vulnerability list every day at 3AM. You may wish to do
                   1753:       this more often than once a day.
                   1754: 
                   1755:       In addition, you may wish to run the package audit from the daily
                   1756:       security script.  This may be accomplished by adding the following
                   1757:       line to <code class="filename">/etc/security.local</code>:
                   1758:       </p>
                   1759: <pre class="screen">
                   1760: /usr/sbin/pkg_admin audit
                   1761:       </pre>
                   1762: <p>
1.1       dsieger  1763:     </p>
                   1764: </div>
1.23      wiz      1765: <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1.1       dsieger  1766: <div class="titlepage"><div><div><h3 class="title">
                   1767: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1768: <p>
1.12      weinem   1769:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23      wiz      1770:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1771:       argument to check if your packages are up-to-date, e.g.
                   1772:     </p>
                   1773: <pre class="screen">
                   1774: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1775: ...
                   1776: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1777:     </pre>
1.10      hubertf  1778: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1779:     package on your system and rebuild any dependencies.
                   1780:     </p>
                   1781: </div>
1.23      wiz      1782: <div class="sect2" title="4.1.7. Other administrative functions">
1.1       dsieger  1783: <div class="titlepage"><div><div><h3 class="title">
                   1784: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1785: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1786:     administrative functions on the package system.</p>
                   1787: </div>
1.23      wiz      1788: <div class="sect2" title="4.1.8. A word of warning">
1.1       dsieger  1789: <div class="titlepage"><div><div><h3 class="title">
                   1790: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1791: <p>Please pay very careful attention to the warnings
1.29      dholland 1792:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1       dsieger  1793:     inherent dangers of installing binary packages which you did
                   1794:     not create yourself, and the security holes that can be
                   1795:     introduced onto your system by indiscriminate adding of such
                   1796:     files.</p>
                   1797: <p>The same warning of course applies to every package you
                   1798:     install from source when you haven't completely read and
                   1799:     understood the source code of the package, the compiler that
                   1800:     is used to build the package and all the other tools that are
                   1801:     involved.</p>
                   1802: </div>
                   1803: </div>
1.23      wiz      1804: <div class="sect1" title="4.2. Building packages from source">
1.1       dsieger  1805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1806: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1807: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1808:   directory now contains a set of packages, organized into
                   1809:   categories. You can browse the online index of packages, or run
1.10      hubertf  1810:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1811:   directory to build local <code class="filename">README.html</code> files for
                   1812:   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>
                   1813: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1814:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1815:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1816:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1817:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1818:   system (inside a chroot is an exception). </p>
                   1819: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1820:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.1       dsieger  1821:   instructions how to create your own packages.</p>
1.23      wiz      1822: <div class="sect2" title="4.2.1. Requirements">
1.1       dsieger  1823: <div class="titlepage"><div><div><h3 class="title">
                   1824: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1825: <p>To build packages from source, you need a working C
                   1826:     compiler. On NetBSD, you need to install the
1.23      wiz      1827:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.1       dsieger  1828:     sets. If you want to build X11-related packages, the
1.23      wiz      1829:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.1       dsieger  1830:     sets are required, too.</p>
                   1831: </div>
1.23      wiz      1832: <div class="sect2" title="4.2.2. Fetching distfiles">
1.1       dsieger  1833: <div class="titlepage"><div><div><h3 class="title">
                   1834: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1835: <p>The first step for building a package is downloading the
                   1836:     distfiles (i.e. the unmodified source). If they have not yet been
                   1837:     downloaded, pkgsrc will fetch them automatically.</p>
                   1838: <p>If you have all files that you need in the
                   1839:     <code class="filename">distfiles</code> directory,
                   1840:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1841:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1842:     </p>
                   1843: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1844: <p>
1.10      hubertf  1845:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1846: <p>By default a list of distribution sites will be randomly
                   1847:     intermixed to prevent huge load on servers which holding popular
                   1848:     packages (for example, SourceForge.net mirrors). Thus, every
                   1849:     time when you need to fetch yet another distfile all the mirrors
                   1850:     will be tried in new (random) order. You can turn this feature
                   1851:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1852:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1853: <p>You can overwrite some of the major distribution sites to
                   1854:     fit to sites that are close to your own.  By setting one or two
                   1855:     variables you can modify the order in which the master sites are
                   1856:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1857:     delimited list of domain suffixes.
                   1858:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1859:     contains a whitespace delimited list of regular expressions.  It
                   1860:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1861:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1862:     some examples.  This may save some of your bandwidth and
                   1863:     time.</p>
                   1864: <p>You can change these settings either in your shell's environment, or,
                   1865:     if you want to keep the settings, by editing the
1.10      hubertf  1866:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1867:     and adding the definitions there.</p>
                   1868: <p>
                   1869:       If a package depends on many other packages (such as
                   1870:       <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
                   1871:       alternate between periods of
                   1872:       downloading source, and compiling. To ensure you have all the source
                   1873:       downloaded initially you can run the command:
                   1874:       </p>
                   1875: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1876: <p>
                   1877:       which will output and run a set of shell commands to fetch the
                   1878:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1879:       also choose to download the files manually.
                   1880:     </p>
                   1881: </div>
1.23      wiz      1882: <div class="sect2" title="4.2.3. How to build and install">
1.1       dsieger  1883: <div class="titlepage"><div><div><h3 class="title">
                   1884: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1885: <p>
                   1886:       Once the software has downloaded, any patches will be applied, then it
                   1887:       will be compiled for you. This may take some time depending on your
                   1888:       computer, and how many other packages the software depends on and their
                   1889:       compile time.
                   1890:     </p>
1.23      wiz      1891: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1892: <h3 class="title">Note</h3>
                   1893: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1894:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1895:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1896: </div>
                   1897: <p>For example, type</p>
                   1898: <pre class="screen">
                   1899: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1900: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1901:     </pre>
                   1902: <p>at the shell prompt to build the various components of the
                   1903:     package.</p>
                   1904: <p>The next stage is to actually install the newly compiled
                   1905:     program onto your system. Do this by entering:
                   1906: 
                   1907:     </p>
                   1908: <pre class="screen">
                   1909: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1910:     </pre>
                   1911: <p>
                   1912: 
                   1913:     while you are still in the directory for whatever package you
                   1914:     are installing.</p>
                   1915: <p>Installing the package on your system may require you to
                   1916:     be root.  However, pkgsrc has a
                   1917:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1918:     to only become root for the actual installation step.</p>
                   1919: <p>That's it, the software should now be installed and setup for use.
                   1920:     You can now enter:
                   1921: 
                   1922:     </p>
                   1923: <pre class="screen">
                   1924: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1925:     </pre>
                   1926: <p>
                   1927: 
                   1928:     to remove the compiled files in the work directory, as you shouldn't need
                   1929:     them any more. If other packages were also added to your system
                   1930:     (dependencies) to allow your program to compile, you can tidy these up
                   1931:     also with the command:</p>
                   1932: <pre class="screen">
                   1933: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1934:     </pre>
                   1935: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1936:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1       dsieger  1937: <p>The program is installed under the default root of the
                   1938:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1939:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1940:     variable in your environment, and it will use that value as the
                   1941:     root of your packages tree. So, to use
                   1942:     <code class="filename">/usr/local</code>, set
                   1943:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1944:     Please note that you should use a directory which is dedicated to
                   1945:     packages and not shared with other programs (i.e., do not try and
                   1946:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1947:     to add any of your own files or directories (such as
                   1948:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1949:     <code class="filename">pkgsrc/</code>) below the
                   1950:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1951:     conflicts between programs and other files installed by the
                   1952:     package system and whatever else may have been installed
                   1953:     there.</p>
1.10      hubertf  1954: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1955:     alter some configuration options at build time.  Have a look at
                   1956:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1957:     of what will be set there by default.  Environment variables such
                   1958:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1959:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1960:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1961: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1962:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1963:     or being installed. This may be for debugging purposes, or out of
                   1964:     simple curiosity. A number of utility values have been added to
                   1965:     help with this.</p>
1.23      wiz      1966: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1967: <li class="listitem">
1.29      dholland 1968: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1       dsieger  1969:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1970:        information will be displayed. For example,</p>
                   1971: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1972: <p>will show all the commands that are invoked, up to and
1.23      wiz      1973:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1974: </li>
1.23      wiz      1975: <li class="listitem">
1.29      dholland 1976: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1977:        definition, then the <code class="varname">VARNAME</code> definition
                   1978:        should be used, in conjunction with the show-var
1.29      dholland 1979:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1980:        variable <code class="varname">LOCALBASE</code>:</p>
                   1981: <pre class="screen">
                   1982: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1983: /usr/pkg
                   1984: <code class="prompt">%</code>
                   1985:        </pre>
                   1986: </li>
                   1987: </ol></div>
                   1988: <p>If you want to install a binary package that you've either
                   1989:     created yourself (see next section), that you put into
                   1990:     pkgsrc/packages manually or that is located on a remote FTP
                   1991:     server, you can use the "bin-install" target. This target will
1.29      dholland 1992:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10      hubertf  1993:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1994:     sites searched is kept in the variable
                   1995:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.29      dholland 1996:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1       dsieger  1997:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1998:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1999:     details.</p>
                   2000: <p>A final word of warning: If you set up a system that has a
                   2001:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2002:     set that before any packages are installed, as you cannot use
                   2003:     several directories for the same purpose. Doing so will result in
                   2004:     pkgsrc not being able to properly detect your installed packages,
                   2005:     and fail miserably. Note also that precompiled binary packages are
                   2006:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2007:     <code class="filename">/usr/pkg</code>, and that you should
                   2008:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2009:     <code class="varname">LOCALBASE</code>.</p>
                   2010: </div>
                   2011: </div>
                   2012: </div>
1.23      wiz      2013: <div class="chapter" title="Chapter 5. Configuring pkgsrc">
1.1       dsieger  2014: <div class="titlepage"><div><div><h2 class="title">
                   2015: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2016: <div class="toc">
                   2017: <p><b>Table of Contents</b></p>
                   2018: <dl>
                   2019: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2020: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   2021: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2022: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2023: <dd><dl>
1.4       rillig   2024: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz      2025: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2026: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger  2027: </dl></dd>
1.4       rillig   2028: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2029: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2030: </dl>
                   2031: </div>
1.4       rillig   2032: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2033: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2034: that file depends on the installation. On NetBSD, when you use
1.29      dholland 2035: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1       dsieger  2036: <code class="filename">/etc/</code>. In all other cases the default location is
                   2037: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2038: bootstrap program to install the binary packages.</p>
                   2039: <p>During the bootstrap, an example configuration file is created. To
                   2040: use that, you have to create the directory
                   2041: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2042: there.</p>
                   2043: <p>The format of the configuration file is that of the usual
                   2044: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2045: is done by setting variables in this file. Note that you can define all
                   2046: kinds of variables, and no special error checking (for example for
                   2047: spelling mistakes) takes place, so you have to try it out to see if it
                   2048: works.</p>
1.23      wiz      2049: <div class="sect1" title="5.1. General configuration">
1.1       dsieger  2050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2051: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2052: <p>In this section, you can find some variables that apply to all
                   2053:     pkgsrc packages. A complete list of the variables that can be
                   2054:     configured by the user is available in
                   2055:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2056:     comments that describe each variable's intent.</p>
1.23      wiz      2057: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2058: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  2059:            packages will be installed. The default is
                   2060:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2061:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      2062: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2063:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  2064:            installed. The default is
                   2065:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      2066: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  2067:            X11 is installed on the system. The default is
                   2068:            <code class="filename">/usr/X11R6</code>.</p></li>
1.23      wiz      2069: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  2070:            downloaded copies of the original source distributions used
                   2071:            for building pkgsrc packages. The default is
                   2072:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      2073: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  2074:            database about installed packages is stored.  The default is
                   2075:            <code class="filename">/var/db/pkg</code>.</p></li>
1.23      wiz      2076: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  2077:            If set, override the packages'
                   2078:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      2079: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  2080:            Backup location(s) for distribution files and patch files
                   2081:            if not found locally or in
                   2082:            <code class="filename">${MASTER_SITES}</code> or
                   2083:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2084:            The defaults are
1.25      spz      2085:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1       dsieger  2086:            and
                   2087:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      2088: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  2089:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2090:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      2091:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2092:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2093: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 2094:            List of acceptable licenses. License names are case-sensitive.
                   2095:            Whenever you try to build a package whose license is not in this
                   2096:            list, you will get an error message. If the license condition is
                   2097:            simple enough, the error message will include specific
                   2098:            instructions on how to change this variable.</p></li>
1.1       dsieger  2099: </ul></div>
                   2100: </div>
1.23      wiz      2101: <div class="sect1" title="5.2. Variables affecting the build process">
1.1       dsieger  2102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2103: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2104: <p>XXX
                   2105:       </p>
1.23      wiz      2106: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2107: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  2108:            directory for the binary packages. The default is
                   2109:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      2110: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  2111:            The top level directory where, if defined, the separate
                   2112:            working directories will get created, and symbolically
                   2113:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2114:            This is useful for building packages on several
                   2115:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2116:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2117:            is local to every architecture. (It should be noted that
                   2118:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 2119:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2120:            root of the pkgsrc tree. It is possible to have many
                   2121:            pkgsrc tree instances.)</p></li>
1.23      wiz      2122: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  2123:            Directory for local patches that aren't part of pkgsrc.
1.10      hubertf  2124:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2125:            information.</p></li>
1.23      wiz      2126: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  2127:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2128:            BSD-style Makefile. If this is not set,
                   2129:            <code class="varname">MAKECONF</code> is set to
                   2130:            <code class="filename">/dev/null</code> to avoid picking up
                   2131:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23      wiz      2132: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger  2133:            By default, dependencies are only installed, and no binary
                   2134:            package is created for them. You can set this variable to
                   2135:            <code class="literal">package</code> to automatically create binary
                   2136:            packages after installing dependencies.</p></li>
                   2137: </ul></div>
                   2138: </div>
1.23      wiz      2139: <div class="sect1" title="5.3. Variables affecting the installation process">
1.1       dsieger  2140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   2141: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24      wiz      2142: <p>Most packages support installation into a
1.4       rillig   2143:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2144:     to be built, before the actual filesystem is touched. DESTDIR
                   2145:     support exists in two variations:</p>
1.23      wiz      2146: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2147: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      2148:       installation and packaging is still run as root.</p></li>
                   2149: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2150:       build, installation and packaging as normal user. Root
                   2151:       privileges are only needed to add packages.</p></li>
                   2152: </ul></div>
                   2153: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                   2154:     you can set
                   2155:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                   2156:     so it's preferable to convert a package to DESTDIR instead.</p>
1.4       rillig   2157: <p>DESTDIR support changes the behaviour of various targets
                   2158:     slightly. To install a package after building it, use
                   2159:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2160:     <code class="literal">install</code> don't do that any
                   2161:     longer. <code class="literal">package-install</code> can be used as
                   2162:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2163:     will ask for the root password to install the package and fail,
                   2164:     <code class="literal">package-install</code> will ask again.</p>
                   2165: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2166:     clean</code></strong> needs to be run as root.</p>
1.17      imil     2167: <p>Considering the <code class="filename">foo/bar</code> package,
                   2168:     DESTDIR full support can be tested using the following commands
                   2169: 
                   2170: </p>
                   2171: <pre class="programlisting">
                   2172: <code class="prompt">$</code> id
                   2173: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2174: <code class="prompt">$</code> mkdir $HOME/packages
                   2175: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2176: </pre>
                   2177: <p>
                   2178: 
                   2179:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2180:     should be needed
                   2181: 
                   2182: </p>
                   2183: <pre class="programlisting">
1.20      snj      2184: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17      imil     2185: </pre>
                   2186: <p>
                   2187: 
                   2188:     Create a package without root privileges
                   2189: 
                   2190: </p>
                   2191: <pre class="programlisting">
1.20      snj      2192: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17      imil     2193: </pre>
                   2194: <p>
                   2195: 
                   2196:     For the following command, you must be able to gain root
1.29      dholland 2197:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17      imil     2198: 
                   2199: </p>
                   2200: <pre class="programlisting">
1.20      snj      2201: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17      imil     2202: </pre>
                   2203: <p>
                   2204: 
                   2205:     Then, as a simple user
                   2206: 
                   2207: </p>
                   2208: <pre class="programlisting">
                   2209: <code class="prompt">$</code> make clean
                   2210: </pre>
                   2211: <p>
                   2212: 
                   2213:     </p>
1.4       rillig   2214: </div>
1.23      wiz      2215: <div class="sect1" title="5.4. Selecting and configuring the compiler">
1.4       rillig   2216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2217: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.23      wiz      2218: <div class="sect2" title="5.4.1. Selecting the compiler">
1.1       dsieger  2219: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2220: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2221: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2222:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2223: <div class="variablelist"><dl>
                   2224: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2225: <dd>
                   2226: <p>This is a list of values specifying the chain of
                   2227:          compilers to invoke when building packages.  Valid values
                   2228:          are:</p>
1.23      wiz      2229: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2230: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  2231:            distributed C/C++ (chainable)</p></li>
1.23      wiz      2232: <li class="listitem"><p><code class="varname">ccache</code>:
1.1       dsieger  2233:            compiler cache (chainable)</p></li>
1.23      wiz      2234: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  2235:            GNU C/C++ Compiler</p></li>
1.23      wiz      2236: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2237:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23      wiz      2238: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2239:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      2240: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  2241:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2242: </ul></div>
                   2243: <p>The default is
1.23      wiz      2244:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  2245:          <code class="varname">ccache</code> and/or
                   2246:          <code class="varname">distcc</code> with an appropriate
                   2247:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      2248:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  2249:          variable should always be terminated with a value for
                   2250:          a real compiler.  Note that only one real compiler
1.23      wiz      2251:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  2252:          is not allowed).</p>
                   2253: </dd>
                   2254: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2255: <dd><p>This specifies the minimum version of GCC to use
                   2256:          when building packages.  If the system GCC doesn't
                   2257:          satisfy this requirement, then pkgsrc will build and
                   2258:          install one of the GCC packages to use instead.</p></dd>
                   2259: </dl></div>
                   2260: </div>
1.23      wiz      2261: <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
1.1       dsieger  2262: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2263: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2264: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2265:        please make sure to use the <code class="literal">+=</code> operator
                   2266:        instead of the <code class="literal">=</code> operator:</p>
                   2267: <pre class="programlisting">
                   2268: CFLAGS+=        -your -flags
                   2269: </pre>
                   2270: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      2271:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  2272:        need to add their own flags.  You may want to take a look
                   2273:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23      wiz      2274:        package if you're interested in optimization specifically
                   2275:        for the current CPU. </p>
1.1       dsieger  2276: </div>
1.23      wiz      2277: <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
1.1       dsieger  2278: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2279: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2280: <p>If you want to pass flags to the linker, both in the configure
                   2281: step and the build step, you can do this in two ways.  Either set
                   2282: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2283: between the two is that <code class="varname">LIBS</code> will be appended to
                   2284: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2285: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2286: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2287: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2288: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2289: settings, use the <code class="literal">+=</code> operator:</p>
                   2290: <pre class="programlisting">
                   2291: LDFLAGS+=        -your -linkerflags
                   2292: </pre>
                   2293: </div>
                   2294: </div>
1.23      wiz      2295: <div class="sect1" title="5.5. Developer/advanced settings">
1.1       dsieger  2296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2297: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2298: <p>XXX
                   2299:       </p>
1.23      wiz      2300: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2301: <li class="listitem">
1.1       dsieger  2302: <p><code class="varname">PKG_DEVELOPER</code>:
                   2303:            Run some sanity checks that package developers want:
                   2304:            </p>
1.23      wiz      2305: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2306: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  2307:              fuzz</p></li>
1.23      wiz      2308: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  2309:              binaries will find their shared libs.</p></li>
                   2310: </ul></div>
                   2311: <p>
                   2312:        </p>
                   2313: </li>
1.23      wiz      2314: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  2315:        of debugging output which is displayed whilst making and
                   2316:        installing the package.  The default value for this is 0,
                   2317:        which will not display the commands as they are executed
                   2318:        (normal, default, quiet operation); the value 1 will display
                   2319:        all shell commands before their invocation, and the value 2
                   2320:        will display both the shell commands before their invocation,
1.10      hubertf  2321:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger  2322:        -x</strong></span> will be displayed.</p></li>
                   2323: </ul></div>
                   2324: <p>
                   2325:     </p>
                   2326: </div>
1.23      wiz      2327: <div class="sect1" title="5.6. Selecting Build Options">
1.1       dsieger  2328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2329: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2330: <p>Some packages have build time options, usually to select
                   2331:     between different dependencies, enable optional support for big
                   2332:     dependencies or enable experimental features.</p>
                   2333: <p>To see which options, if any, a package supports, and which
1.10      hubertf  2334:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2335:     show-options</strong></span>, for example:</p>
                   2336: <pre class="programlisting">
                   2337:     The following options are supported by this package:
                   2338:         ssl      Enable SSL support.
                   2339:     Exactly one of the following gecko options is required:
                   2340:         firefox  Use firefox as gecko rendering engine.
                   2341:         mozilla  Use mozilla as gecko rendering engine.
                   2342:     At most one of the following database options may be selected:
                   2343:         mysql    Enable support for MySQL database.
                   2344:         pgsql    Enable support for PostgreSQL database.
                   2345: 
                   2346:     These options are enabled by default: firefox
                   2347:     These options are currently enabled: mozilla ssl
                   2348: </pre>
                   2349: <p>The following variables can be defined in
1.10      hubertf  2350:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2351:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2352:     which can be used to select or disable options for all packages
                   2353:     that support them, and
                   2354:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2355:     which can be used to select or disable options specifically for
                   2356:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      2357:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2358:     are disabled. A few examples:</p>
                   2359: <pre class="screen">
1.10      hubertf  2360: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger  2361: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2362: PKG_OPTIONS.kdebase=    debug -sasl
                   2363: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2364: <p>It is important to note that options that were specifically
1.18      snj      2365:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   2366:     you do not wish to include the option.  If you are unsure you can view
                   2367:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2368: <p>The following settings are consulted in the order given, and
                   2369:     the last setting that selects or disables an option is
                   2370:     used:</p>
1.23      wiz      2371: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2372: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2373:       maintainer</p></li>
1.23      wiz      2374: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2375:       variables (see below)</p></li>
1.23      wiz      2376: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2377: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  2378: </ol></div>
                   2379: <p>For groups of mutually exclusive options, the last option
                   2380:     selected is used, all others are automatically disabled.  If an
                   2381:     option of the group is explicitly disabled, the previously
                   2382:     selected option, if any, is used.  It is an error if no option
                   2383:     from a required group of options is selected, and building the
                   2384:     package will fail.</p>
                   2385: <p>Before the options framework was introduced, build options
                   2386:     were selected by setting a variable (often named
                   2387:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2388:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2389:     transition to the options framework for the user, these legacy
                   2390:     variables are converted to the appropriate options setting
                   2391:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2392:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2393:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2394:     directly.  Support for the legacy variables will be removed
                   2395:     eventually.</p>
                   2396: </div>
                   2397: </div>
1.23      wiz      2398: <div class="chapter" title="Chapter 6. Creating binary packages">
1.1       dsieger  2399: <div class="titlepage"><div><div><h2 class="title">
                   2400: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2401: <div class="toc">
                   2402: <p><b>Table of Contents</b></p>
                   2403: <dl>
                   2404: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2405: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2406: </dl>
                   2407: </div>
1.23      wiz      2408: <div class="sect1" title="6.1. Building a single binary package">
1.1       dsieger  2409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2410: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2411: <p>Once you have built and installed a package, you can create
                   2412:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29      dholland 2413:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1       dsieger  2414:     the same package on a group of hosts and wasting CPU time. It also
                   2415:     provides a simple means for others to install your package, should
                   2416:     you distribute it.</p>
                   2417: <p>To create a binary package, change into the appropriate
1.10      hubertf  2418:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2419:     package</strong></span>:</p>
                   2420: <pre class="screen">
                   2421: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2422: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2423:     </pre>
                   2424: <p>This will build and install your package (if not already done),
                   2425:     and then build a binary package from what was installed. You can
1.10      hubertf  2426:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2427:     it. Binary packages are created by default in
                   2428:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2429:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.1       dsieger  2430:     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.10      hubertf  2431: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1       dsieger  2432:     such a binary package.</p>
                   2433: </div>
1.23      wiz      2434: <div class="sect1" title="6.2. Settings for creation of binary packages">
1.1       dsieger  2435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2436: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2437: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.6       rillig   2438: </div>
                   2439: </div>
1.23      wiz      2440: <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
1.6       rillig   2441: <div class="titlepage"><div><div><h2 class="title">
                   2442: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2443: builds)</h2></div></div></div>
                   2444: <div class="toc">
                   2445: <p><b>Table of Contents</b></p>
                   2446: <dl>
                   2447: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2448: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2449: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2450: <dd><dl>
                   2451: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2452: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2453: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2454: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2455: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2456: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2457: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2458: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2459: </dl></dd>
                   2460: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig   2461: <dd><dl>
                   2462: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2463: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2464: </dl></dd>
1.6       rillig   2465: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2466: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2467: </dl>
                   2468: </div>
                   2469: <p>When you have multiple machines that should run the same packages,
                   2470: it is wasted time if they all build their packages themselves from
                   2471: source. There are two ways of getting a set of binary packages: The old
                   2472: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2473: system. This chapter describes how to set them up so that the packages
                   2474: are most likely to be usable later.</p>
1.23      wiz      2475: <div class="sect1" title="7.1. Think first, build later">
1.6       rillig   2476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2477: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2478: <p>Since a bulk build takes several days or even weeks to finish, you
                   2479: should think about the setup before you start everything. Pay attention
                   2480: to at least the following points:</p>
1.23      wiz      2481: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2482: <li class="listitem">
1.6       rillig   2483: <p>If you want to upload the binary packages to
                   2484: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2485: packages:</p>
1.23      wiz      2486: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2487: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6       rillig   2488: by a NetBSD developer on a trusted machine (that is, where you and only
                   2489: you have root access).</p></li>
1.23      wiz      2490: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21      snj      2491: the stable branches (like 2009Q1), so that users browsing the available
1.6       rillig   2492: collections can see at a glance how old the packages
                   2493: are.</p></li>
1.23      wiz      2494: <li class="listitem"><p>The packages must be built as root, since some packages
1.6       rillig   2495: require set-uid binaries at runtime, and creating those packages as
                   2496: unprivileged user doesn't work well at the moment.</p></li>
                   2497: </ul></div>
                   2498: </li>
1.23      wiz      2499: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6       rillig   2500: your system. Most bulk builds run as root, so they should be run at least
                   2501: in a chroot environment or something even more restrictive, depending on
                   2502: what the operating system provides. There have been numerous cases where
                   2503: certain packages tried to install files outside the
                   2504: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2505: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2506: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2507: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2508: that you don't need any package during the build.</p></li>
                   2509: </ul></div>
                   2510: </div>
1.23      wiz      2511: <div class="sect1" title="7.2. Requirements of a bulk build">
1.6       rillig   2512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2513: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2514: <p>A complete bulk build requires lots of disk space. Some of the
                   2515: disk space can be read-only, some other must be writable. Some can be on
                   2516: remote filesystems (such as NFS) and some should be local. Some can be
                   2517: temporary filesystems, others must survive a sudden reboot.</p>
1.23      wiz      2518: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2519: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2520: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2521: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2522: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2523: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2524: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6       rillig   2525: </ul></div>
1.1       dsieger  2526: </div>
1.23      wiz      2527: <div class="sect1" title="7.3. Running an old-style bulk build">
1.1       dsieger  2528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2529: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.23      wiz      2530: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15      rillig   2531: <h3 class="title">Note</h3>
                   2532: <p>There are two ways of doing a bulk build. The old-style
1.23      wiz      2533: one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
1.15      rillig   2534: way.</p>
1.6       rillig   2535: </div>
1.23      wiz      2536: <div class="sect2" title="7.3.1. Configuration">
1.1       dsieger  2537: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2538: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.23      wiz      2539: <div class="sect3" title="7.3.1.1. build.conf">
1.1       dsieger  2540: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2541: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2542: </h4></div></div></div>
                   2543: <p>The <code class="filename">build.conf</code> file is the main
                   2544:        configuration file for bulk builds. You can configure how your
                   2545:        copy of pkgsrc is kept up to date, how the distfiles are
                   2546:        downloaded, how the packages are built and how the report is
                   2547:        generated. You can find an annotated example file in
                   2548:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2549:        it, copy <code class="filename">build.conf-example</code> to
                   2550:        <code class="filename">build.conf</code> and edit it, following the
                   2551:        comments in that file.</p>
                   2552: </div>
1.23      wiz      2553: <div class="sect3" title="7.3.1.2. mk.conf">
1.1       dsieger  2554: <div class="titlepage"><div><div><h4 class="title">
1.10      hubertf  2555: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4       rillig   2556: </h4></div></div></div>
1.10      hubertf  2557: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2558:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2559:        details of the default settings. You will want to ensure that
                   2560:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22      jakllsch 2561:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4       rillig   2562:        completely bypasses the license check.</p>
1.1       dsieger  2563: <pre class="programlisting">
                   2564: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2565: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2566: BSDSRCDIR=      /usr/src
                   2567: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2568: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2569: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2570: PKG_DEVELOPER?= yes
1.22      jakllsch 2571: SKIP_LICENSE_CHECK=    yes
1.1       dsieger  2572: </pre>
                   2573: <p>Some options that are especially useful for bulk builds
                   2574:        can be found at the top lines of the file
                   2575:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2576:        options of these are briefly described here.</p>
1.23      wiz      2577: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2578: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1       dsieger  2579:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23      wiz      2580:          <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
                   2581: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1       dsieger  2582:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2583:          to the directory where all log files are created. Otherwise the
                   2584:          log files are created in the pkgsrc directory.</p></li>
1.23      wiz      2585: <li class="listitem"><p>Another important variable is
1.1       dsieger  2586:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2587:          should be always available while building other
                   2588:          packages.</p></li>
                   2589: </ul></div>
                   2590: <p>Some other options are scattered in the pkgsrc
                   2591:        infrastructure:</p>
1.23      wiz      2592: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2593: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2594:          should be set to <code class="literal">yes</code>. The purpose of the
                   2595:          bulk builds is creating binary packages, no matter if they
                   2596:          are vulnerable or not. Leaving this variable unset would
                   2597:          prevent the bulk build system from even trying to build
                   2598:          them, so possible building errors would not show
                   2599:          up.</p></li>
                   2600: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1       dsieger  2601:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23      wiz      2602:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
1.1       dsieger  2603:          matches the <code class="filename">PLIST</code>.</p></li>
1.23      wiz      2604: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1       dsieger  2605:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23      wiz      2606:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
                   2607:          <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
1.1       dsieger  2608:          interpreter.</p></li>
1.23      wiz      2609: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2610:          set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
1.1       dsieger  2611:          package's self-test before installing it. Note that some
1.23      wiz      2612:          packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
1.1       dsieger  2613:          numbers, so you need to assure that the machine on which you
                   2614:          are doing the bulk builds is not completely idle. Otherwise
                   2615:          some test programs will seem to hang, while they are just
                   2616:          waiting for new random data to be
                   2617:          available.</p></li>
                   2618: </ul></div>
                   2619: </div>
1.23      wiz      2620: <div class="sect3" title="7.3.1.3. pre-build.local">
1.1       dsieger  2621: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2622: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2623: </h4></div></div></div>
                   2624: <p>It is possible to configure the bulk build to perform
                   2625:        certain site-specific tasks at the end of the pre-build
                   2626:        stage.  If the file
                   2627:        <code class="filename">pre-build.local</code> exists in
                   2628:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29      dholland 2629:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.1       dsieger  2630:        stage.  An example use of
                   2631:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2632: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2633:        &gt; misc/openoffice/$BROKENF</pre>
                   2634: <p>to prevent the system from trying to build a particular package
                   2635:        which requires nearly 3 GB of disk space.</p>
                   2636: </div>
                   2637: </div>
1.23      wiz      2638: <div class="sect2" title="7.3.2. Other environmental considerations">
1.1       dsieger  2639: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2640: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2641: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2642:       deleted at the start of bulk builds, make sure your login
                   2643:       shell is placed somewhere else. Either drop it into
                   2644:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2645:       shell in the passwd file), or (re-)install it via
1.29      dholland 2646:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.1       dsieger  2647:       you can login after a reboot (remember that your current
                   2648:       process won't die if the package is removed, you just can't
                   2649:       start any new instances of the shell any more).  Also, if you
                   2650:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2651:       version of ssh for some reason, be sure to install ssh before
                   2652:       starting it from <code class="filename">rc.local</code>:</p>
                   2653: <pre class="programlisting">
                   2654: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2655: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2656:   /usr/pkg/etc/rc.d/sshd
                   2657: fi
                   2658: </pre>
                   2659: <p>Not doing so will result in you being not able to log in
                   2660:       via ssh after the bulk build is finished or if the machine
                   2661:       gets rebooted or crashes. You have been warned! :)</p>
                   2662: </div>
1.23      wiz      2663: <div class="sect2" title="7.3.3. Operation">
1.1       dsieger  2664: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2665: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2666: <p>Make sure you don't need any of the packages still
                   2667:       installed.</p>
1.23      wiz      2668: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  2669: <h3 class="title">Warning</h3>
                   2670: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2671:        configuration files and some more files from
                   2672:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2673:        possibly other locations will be removed! So don't run a bulk
                   2674:        build with privileges that might harm your
                   2675:        system.</em></span></p>
                   2676: </div>
                   2677: <p>Be sure to remove all other things that might
                   2678:       interfere with builds, like some libs installed in
                   2679:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2680: <pre class="screen">
                   2681: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2682: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2683:       </pre>
                   2684: <p>If for some reason your last build didn't complete (power
                   2685:       failure, system panic, ...), you can continue it by
                   2686:       running:</p>
                   2687: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2688: <p>At the end of the bulk build, you will get a summary via mail,
                   2689:       and find build logs in the directory specified by
                   2690:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2691:       file.</p>
                   2692: </div>
1.23      wiz      2693: <div class="sect2" title="7.3.4. What it does">
1.1       dsieger  2694: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2695: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2696: <p>The bulk builds consist of three steps:</p>
                   2697: <div class="variablelist"><dl>
                   2698: <dt><span class="term">1. pre-build</span></dt>
                   2699: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2700:            cleans out any broken distfiles, and removes all
                   2701:            packages installed.</p></dd>
                   2702: <dt><span class="term">2. the bulk build</span></dt>
1.23      wiz      2703: <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
1.1       dsieger  2704:            an optimised order in which packages will be
                   2705:            built. Packages that don't require other packages will
                   2706:            be built first, and packages with many dependencies will
                   2707:            be built later.</p></dd>
                   2708: <dt><span class="term">3. post-build</span></dt>
                   2709: <dd><p>Generates a report that's placed in the directory
                   2710:            specified in the <code class="filename">build.conf</code> file
                   2711:            named <code class="filename">broken.html</code>, a short version
                   2712:            of that report will also be mailed to the build's
                   2713:            admin.</p></dd>
                   2714: </dl></div>
                   2715: <p>During the build, a list of broken packages will be compiled
                   2716:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2717:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2718:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2719:       of broken builds can be found in the package's
                   2720:       directory. These files are used by the bulk-targets to mark
                   2721:       broken builds to not waste time trying to rebuild them, and
                   2722:       they can be used to debug these broken package builds
                   2723:       later.</p>
                   2724: </div>
1.23      wiz      2725: <div class="sect2" title="7.3.5. Disk space requirements">
1.1       dsieger  2726: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2727: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2728: <p>Currently, roughly the following requirements are valid for
                   2729:       NetBSD 2.0/i386:</p>
1.23      wiz      2730: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2731: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
                   2732: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2733: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1       dsieger  2734: </ul></div>
                   2735: <p>Note that all pkgs will be de-installed as soon as they are
                   2736:       turned into a binary package, and that sources are removed,
                   2737:       so there is no excessively huge demand to disk
                   2738:       space. Afterwards, if the package is needed again, it will
1.29      dholland 2739:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.1       dsieger  2740:       there are no cycles wasted by recompiling.</p>
                   2741: </div>
1.23      wiz      2742: <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
1.1       dsieger  2743: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2744: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2745: <p>If you don't want all the packages nuked from a machine
                   2746:       (rendering it useless for anything but pkg compiling), there
                   2747:       is the possibility of doing the package bulk build inside a
                   2748:       chroot environment.</p>
                   2749: <p>The first step is to set up a chroot sandbox,
                   2750:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2751:       using null mounts, or manually.</p>
                   2752: <p>There is a shell script called
1.36      wiz      2753:       <code class="filename">mksandbox</code> installed by the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mksandbox/README.html" target="_top"><code class="filename">pkgtools/mksandbox</code></a> package, which will set
1.1       dsieger  2754:       up the sandbox environment using null mounts. It will also
                   2755:       create a script called <code class="filename">sandbox</code> in the
                   2756:       root of the sandbox environment, which will allow the null
1.10      hubertf  2757:       mounts to be activated using the <span class="command"><strong>sandbox
1.1       dsieger  2758:       mount</strong></span> command and deactivated using the
1.10      hubertf  2759:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1       dsieger  2760: <p>To set up a sandbox environment by hand, after extracting all
1.10      hubertf  2761:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1       dsieger  2762:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2763:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2764:       are present and properly configured:</p>
1.23      wiz      2765: <div class="procedure"><ol class="procedure" type="1">
                   2766: <li class="step" title="Step 1">
1.1       dsieger  2767: <p>Kernel</p>
                   2768: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2769: </li>
1.23      wiz      2770: <li class="step" title="Step 2">
1.1       dsieger  2771: <p><code class="filename">/dev/*</code></p>
                   2772: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2773: </li>
1.23      wiz      2774: <li class="step" title="Step 3">
1.1       dsieger  2775: <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>
                   2776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2777: </li>
1.23      wiz      2778: <li class="step" title="Step 4">
1.1       dsieger  2779: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2780: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2781: </li>
1.23      wiz      2782: <li class="step" title="Step 5">
1.1       dsieger  2783: <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>
                   2784: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2785: </li>
1.23      wiz      2786: <li class="step" title="Step 6">
1.1       dsieger  2787: <p><code class="filename">/usr/src</code> (system sources,
1.14      jmcneill 2788:          e.&nbsp;g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.1       dsieger  2789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2790:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2791: </li>
1.23      wiz      2792: <li class="step" title="Step 7">
1.1       dsieger  2793: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2794: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2795: </li>
1.23      wiz      2796: <li class="step" title="Step 8">
1.1       dsieger  2797: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2799: </li>
1.23      wiz      2800: <li class="step" title="Step 9">
1.1       dsieger  2801: <p>Checkout pkgsrc via cvs into
                   2802:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2803: <pre class="screen">
                   2804: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2805: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2806:          </pre>
                   2807: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2808:          you do development in, as this will likely cause problems!</p>
                   2809: </li>
1.23      wiz      2810: <li class="step" title="Step 10"><p>Make
1.1       dsieger  2811:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2812:          <code class="filename">.../distfiles</code> point somewhere
                   2813:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.23      wiz      2814: <li class="step" title="Step 11"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
                   2815: <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.1       dsieger  2816: </ol></div>
                   2817: <p>When the chroot sandbox is set up, you can start
                   2818:       the build with the following steps:</p>
                   2819: <pre class="screen">
                   2820: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2821: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2822:       </pre>
                   2823: <p>This will just jump inside the sandbox and start building.  At
                   2824:        the end of the build, mail will be sent with the results of
                   2825:        the build. Created binary pkgs will be in
                   2826:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2827:       (wherever that points/mounts to/from).</p>
                   2828: </div>
1.23      wiz      2829: <div class="sect2" title="7.3.7. Building a partial set of packages">
1.1       dsieger  2830: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2831: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2832: <p>In addition to building a complete set of all packages in
                   2833:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2834:       may be used to build a subset of the packages contained in
                   2835:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.10      hubertf  2836:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.23      wiz      2837: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2838: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
                   2839: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
                   2840: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
                   2841: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1       dsieger  2842: </ul></div>
                   2843: <p>will define the set of packages which should be built.
                   2844:       The bulk build code will also include any packages which are
                   2845:       needed as dependencies for the explicitly listed packages.</p>
                   2846: <p>One use of this is to do a bulk build with
                   2847:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2848:       periodically to have a complete set of the binary packages
                   2849:       needed for your site available without the overhead of
                   2850:       building extra packages that are not needed.</p>
                   2851: </div>
1.23      wiz      2852: <div class="sect2" title="7.3.8. Uploading results of a bulk build">
1.1       dsieger  2853: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2854: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2855: <p>This section describes how pkgsrc developers can upload binary
                   2856:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2857: <p>If you would like to automatically create checksum files for the
                   2858:       binary packages you intend to upload, remember to set
                   2859:       <code class="varname">MKSUMS=yes</code> in your
                   2860:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2861: <p>If you would like to PGP sign the checksum files (highly
                   2862:       recommended!), remember to set
                   2863:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2864:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2865:       your GPG password to sign the files before uploading everything.</p>
                   2866: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2867:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2868:       file, i.e. adjust it to something like one of the following:</p>
1.25      spz      2869: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
                   2870: <p>Please use appropriate values for "20xxQy" (the branch),
                   2871:       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1       dsieger  2872:       is different from your local login, write your login directly
                   2873:       into the variable, e.g. my local account is "feyrer", but for my
                   2874:       login "hubertf", I use:</p>
1.25      spz      2875: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1       dsieger  2876: <p>A separate <code class="filename">upload</code> directory is used
                   2877:       here to allow "closing" the directory during upload. To do
                   2878:       so, run the following command on ftp.NetBSD.org next:</p>
1.25      spz      2879: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</code></strong></pre>
1.1       dsieger  2880: <p>Before uploading the binary pkgs, ssh authentication needs
                   2881:       to be set up. This example shows how to set up temporary keys
                   2882:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2883:       (assuming that no keys should be present there usually):</p>
                   2884: <pre class="screen">
                   2885: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2886: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25      spz      2887: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
                   2888: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1       dsieger  2889:       </pre>
1.25      spz      2890: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1       dsieger  2891:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25      spz      2892:       file on ftp.NetBSD.org. You should remove the key after the
1.1       dsieger  2893:       upload is done!</p>
                   2894: <p>Next, test if your ssh connection really works:</p>
                   2895: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2896: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2897: <p>Now after all this works, you can exit the sandbox and start
                   2898:       the upload:</p>
                   2899: <pre class="screen">
                   2900: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2901: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2902: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2903:       </pre>
1.29      dholland 2904: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2905:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.1       dsieger  2906:       upload. The upload script will take care of not uploading
1.23      wiz      2907:       restricted packages.</p>
1.1       dsieger  2908: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2909: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2910:       Gdd:x! </pre>
                   2911: <p>Use whatever is needed to remove the key you've entered
                   2912:       before! Last, move the uploaded packages out of the
                   2913:       <code class="filename">upload</code> directory to have them accessible
                   2914:       to everyone:</p>
                   2915: <pre class="screen">
1.25      spz      2916: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1       dsieger  2917: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2918: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25      spz      2919: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
                   2920: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1       dsieger  2921:       </pre>
                   2922: </div>
                   2923: </div>
1.23      wiz      2924: <div class="sect1" title="7.4. Running a pbulk-style bulk build">
1.1       dsieger  2925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2926: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2927: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.23      wiz      2928: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2929: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2930: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2931: </ul></div>
1.23      wiz      2932: <div class="sect2" title="7.4.1. Preparation">
1.15      rillig   2933: <div class="titlepage"><div><div><h3 class="title">
                   2934: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
                   2935: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
                   2936: <pre class="screen">
                   2937: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2938: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   2939: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   2940: </pre>
                   2941: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.23      wiz      2942: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2943: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   2944: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
                   2945: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
                   2946: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
                   2947: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.15      rillig   2948: </ul></div>
                   2949: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   2950: <pre class="screen">
                   2951: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   2952: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   2953: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   2954: </pre>
                   2955: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
                   2956: </div>
1.23      wiz      2957: <div class="sect2" title="7.4.2. Configuration">
1.6       rillig   2958: <div class="titlepage"><div><div><h3 class="title">
1.15      rillig   2959: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14      jmcneill 2960: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15      rillig   2961: <p>TODO: continue writing</p>
1.6       rillig   2962: </div>
                   2963: </div>
1.23      wiz      2964: <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
1.6       rillig   2965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2966: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2967: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2968:     create a CD-ROM set of the resulting binary packages to assist
                   2969:     in installing packages on other machines.  The
                   2970:     <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
                   2971:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2972:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2973:     way that keeps all the dependencies for a given package on the same
                   2974:     CD as that package.</p>
1.23      wiz      2975: <div class="sect2" title="7.5.1. Example of cdpack">
1.1       dsieger  2976: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2977: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2978: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2979:       man page. The following short example assumes that the binary
                   2980:       packages are left in
                   2981:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2982:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2983:       hold the ISO 9660 images.</p>
                   2984: <pre class="screen">
                   2985: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2986: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2987: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2988:       </pre>
                   2989: <p>If you wish to include a common set of files
                   2990:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2991:       etc.) on each CD in the collection, then you need to create a
                   2992:       directory which contains these files. e.g.</p>
                   2993: <pre class="screen">
                   2994: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2995: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2996: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2997: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2998: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2999: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   3000: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3001:       </pre>
                   3002: <p>Now create the images:</p>
                   3003: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   3004: <p>Each image will contain <code class="filename">README</code>,
                   3005:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3006:       in their root directories.</p>
                   3007: </div>
                   3008: </div>
                   3009: </div>
1.23      wiz      3010: <div class="chapter" title="Chapter 8. Directory layout of the installed files">
1.1       dsieger  3011: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3012: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  3013: <div class="toc">
                   3014: <p><b>Table of Contents</b></p>
                   3015: <dl>
1.23      wiz      3016: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3017: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1       dsieger  3018: </dl>
                   3019: </div>
                   3020: <p>The files that are installed by pkgsrc are organized in a way that
                   3021: is similar to what you find in the <code class="filename">/usr</code> directory
                   3022: of the base system. But some details are different. This is because
                   3023: pkgsrc initially came from FreeBSD and had adopted its file system
                   3024: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3025: which operating system you are using pkgsrc with, you can expect the
                   3026: same layout for pkgsrc.</p>
                   3027: <p>There are mainly four root directories for pkgsrc, which are all
                   3028: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3029: When pkgsrc has been installed as root, the default locations
                   3030: are:</p>
                   3031: <pre class="programlisting">
                   3032: LOCALBASE=              /usr/pkg
                   3033: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3034: VARBASE=                /var
                   3035: PKG_DBDIR=              /var/db/pkg
                   3036: </pre>
                   3037: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3038: user), the default locations are:</p>
                   3039: <pre class="programlisting">
                   3040: LOCALBASE=              ${HOME}/pkg
                   3041: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3042: VARBASE=                ${HOME}/pkg/var
                   3043: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3044: </pre>
                   3045: <p>What these four directories are for, and what they look like is
                   3046: explained below.</p>
1.23      wiz      3047: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3048: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  3049: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      3050: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  3051: the well-known subdirectories like <code class="filename">bin</code>,
                   3052: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3053: <code class="filename">share</code> and
                   3054: <code class="filename">sbin</code>.</p></li>
1.23      wiz      3055: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  3056: <code class="filename">/var</code> in the base system. Some programs (especially
                   3057: games, network daemons) need write access to it during normal
                   3058: operation.</p></li>
1.23      wiz      3059: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  3060: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  3061: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  3062: itself.</p></li>
                   3063: </ul></div>
1.23      wiz      3064: <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
1.1       dsieger  3065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3066: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3067: </h2></div></div></div>
                   3068: <p>The following directories exist in a typical pkgsrc installation
                   3069: in <code class="filename">${LOCALBASE}</code>.</p>
                   3070: <div class="variablelist"><dl>
                   3071: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3072: <dd><p>Contains executable programs that are intended to be
                   3073: directly used by the end user.</p></dd>
                   3074: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3075: <dd><p>Contains files for the emulation layers of various other
                   3076: operating systems, especially for
                   3077: NetBSD.</p></dd>
                   3078: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3079: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3080: <dd><p>Contains
                   3081: the configuration files.</p></dd>
                   3082: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3083: <dd><p>Contains headers for the C and C++ programming
                   3084: languages.</p></dd>
                   3085: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3086: <dd><p>Contains GNU info files of various
                   3087: packages.</p></dd>
                   3088: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3089: <dd><p>Contains shared and static
                   3090: libraries.</p></dd>
                   3091: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3092: <dd><p>Contains data files that don't change after
                   3093: installation. Other data files belong into
                   3094: <code class="filename">${VARBASE}</code>.</p></dd>
                   3095: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3096: <dd><p>Contains programs that are not intended to be used by
                   3097: end users, such as helper programs or network
                   3098: daemons.</p></dd>
                   3099: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3100: <dd><p>Contains programs that are intended to be executed as
                   3101: CGI scripts by a web server.</p></dd>
                   3102: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3103: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3104: <dd><p>Contains brief
                   3105: documentation in form of manual pages.</p></dd>
                   3106: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3107: <dd><p>Contains programs that are intended to be used only by
                   3108: the super-user.</p></dd>
                   3109: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3110: <dd><p>Contains platform-independent data files that don't
                   3111: change after installation.</p></dd>
                   3112: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3113: <dd><p>Contains documentation files provided by the
                   3114: packages.</p></dd>
                   3115: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3116: <dd><p>Contains example files provided by the packages. Among
                   3117: others, the original configuration files are saved here and copied to
                   3118: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3119: installation.</p></dd>
                   3120: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3121: <dd><p>Contains the original files for rc.d
                   3122: scripts.</p></dd>
                   3123: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3124: <code class="filename">${VARBASE}</code>)</span></dt>
                   3125: <dd><p>Contains files
                   3126: that may be modified after
                   3127: installation.</p></dd>
                   3128: </dl></div>
                   3129: </div>
1.23      wiz      3130: <div class="sect1" title="8.2. File system layout in ${VARBASE}">
1.1       dsieger  3131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3132: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3133: </h2></div></div></div>
                   3134: <div class="variablelist"><dl>
                   3135: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3136: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3137: <dd><p>Contains
                   3138: information about the currently installed
                   3139: packages.</p></dd>
                   3140: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3141: <dd><p>Contains highscore
                   3142: files.</p></dd>
                   3143: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3144: <dd><p>Contains log files.</p></dd>
                   3145: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3146: <dd><p>Contains informational files about daemons that are
                   3147: currently running.</p></dd>
                   3148: </dl></div>
                   3149: </div>
                   3150: </div>
1.23      wiz      3151: <div class="chapter" title="Chapter 9. Frequently Asked Questions">
1.1       dsieger  3152: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3153: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3154: <div class="toc">
                   3155: <p><b>Table of Contents</b></p>
                   3156: <dl>
1.6       rillig   3157: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3159: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3160: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3161: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3162: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   3163: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23      wiz      3164: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6       rillig   3165: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz      3166: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                   3167: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                   3168: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.6       rillig   3169: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3170: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3171: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz      3172: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6       rillig   3173: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.23      wiz      3174: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger  3175: </dl>
                   3176: </div>
                   3177: <p>This section contains hints, tips &amp; tricks on special things in
                   3178: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3179: it contains items for both pkgsrc users and developers.</p>
1.23      wiz      3180: <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
1.1       dsieger  3181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3182: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3183: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.23      wiz      3184: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3185: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  3186:          This is a general purpose list for most issues regarding
                   3187:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3188:          for pkgsrc configuration, unexpected build failures, using
                   3189:          particular packages, upgrading pkgsrc installations,
                   3190:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3191:          proposals for changes that impact the pkgsrc user community,
                   3192:          e.g. major infrastructure changes, new features, package
                   3193:          removals, etc., may also be posted.</p></li>
1.23      wiz      3194: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  3195:          A list where the results of pkgsrc bulk builds are sent and
                   3196:          discussed.</p></li>
1.23      wiz      3197: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  3198:          This list is for those who are interested in getting a
                   3199:          commit message for every change committed to pkgsrc. It is
                   3200:          also available in digest form, meaning one daily message
                   3201:          containing all commit messages for changes to the package
                   3202:          source tree in that 24 hour period.</p></li>
                   3203: </ul></div>
                   3204: <p>To subscribe, do:</p>
                   3205: <pre class="programlisting">
                   3206: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3207: </pre>
                   3208: <p>Archives for all these mailing lists are available from
1.10      hubertf  3209: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  3210: </div>
1.23      wiz      3211: <div class="sect1" title="9.2. Where's the pkgviews documentation?">
1.1       dsieger  3212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3213: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3214: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3215: pkgviews User's guide in
                   3216: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3217: </div>
1.23      wiz      3218: <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
1.1       dsieger  3219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3220: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3221: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3222: a number of useful utilities for both users and developers of pkgsrc.  This
                   3223: section attempts only to make the reader aware of the utilities and when
                   3224: they might be useful, and not to duplicate the documentation that comes
                   3225: with each package.</p>
                   3226: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.23      wiz      3227: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1       dsieger  3228:       Symlinks for use by buildlink.</p></li></ul></div>
                   3229: <p>OS tool augmentation (automatically installed when needed):</p>
1.23      wiz      3230: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3231: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.1       dsieger  3232:       Calculates various kinds of checksums (including SHA1).</p></li>
1.23      wiz      3233: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1       dsieger  3234:       Compatibility library for pkgsrc tools.</p></li>
1.23      wiz      3235: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1       dsieger  3236:       non-BSD systems due to lack of native mtree.</p></li>
1.23      wiz      3237: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1       dsieger  3238:       Up-to-date replacement for
                   3239:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3240:       systems where pkg_install is not present.</p></li>
                   3241: </ul></div>
                   3242: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.23      wiz      3243: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3244: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1       dsieger  3245:       Create a binary package from an
1.10      hubertf  3246:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  3247:       save the old package.</p></li>
1.23      wiz      3248: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1       dsieger  3249:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3250:       from multiple locations. It currently supports the following
                   3251:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23      wiz      3252: <li class="listitem"><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.1       dsieger  3253:       packages someplace else (enabled by default).</p></li>
1.23      wiz      3254: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16      jnemeth  3255:       the best compiler flags to optimise code for your current
1.23      wiz      3256:       CPU and compiler. </p></li>
1.1       dsieger  3257: </ul></div>
                   3258: <p>Utilities for keeping track of installed packages, being up to date,
                   3259: etc:</p>
1.23      wiz      3260: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3261: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1       dsieger  3262:       packages whose installed versions do not match the latest pkgsrc
                   3263:       entries.</p></li>
1.23      wiz      3264: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1       dsieger  3265:       dependency graphs of packages, to aid in choosing a strategy for
                   3266:       updating.</p></li>
1.23      wiz      3267: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
1.1       dsieger  3268:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
1.23      wiz      3269: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12      weinem   3270:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23      wiz      3271: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1       dsieger  3272:       does various checks on the complete pkgsrc system.</p></li>
1.23      wiz      3273: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1       dsieger  3274:       packages you have installed.</p></li>
                   3275: </ul></div>
                   3276: <p>Utilities for people maintaining or creating individual packages:</p>
1.23      wiz      3277: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3278: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1       dsieger  3279:       making and maintaining patches for a package (includes pkgdiff,
                   3280:       pkgvi, mkpatches, etc.).</p></li>
1.23      wiz      3281: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
1.1       dsieger  3282:       <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
                   3283:       converting to pkgsrc.</p></li>
1.23      wiz      3284: <li class="listitem"><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.1       dsieger  3285:       pkgsrc to a Solaris package.</p></li>
                   3286: </ul></div>
                   3287: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3288: utilities)</p>
1.23      wiz      3289: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3290: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1       dsieger  3291:       packages in a chrooted area.</p></li>
1.23      wiz      3292: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1       dsieger  3293:       kernel version for chrooted cross builds.</p></li>
                   3294: </ul></div>
                   3295: </div>
1.23      wiz      3296: <div class="sect1" title="9.4. How to use pkgsrc as non-root">
1.1       dsieger  3297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3298: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3299: <p>If you want to use pkgsrc as non-root user, you can set some
                   3300: variables to make pkgsrc work under these conditions.  At the very least,
1.23      wiz      3301: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>; this
1.1       dsieger  3302: will turn on unprivileged mode and set multiple related variables to allow
                   3303: installation of packages as non-root.</p>
                   3304: <p>In case the defaults are not enough, you may want to tune some other
                   3305: variables used.  For example, if the automatic user/group detection leads
                   3306: to incorrect values (or not the ones you would like to use), you can change
                   3307: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3308: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3309: <p>As regards bootstrapping, please note that the
1.10      hubertf  3310: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23      wiz      3311: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.1       dsieger  3312: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3313: installation targets.  These directories can be overridden by the
1.23      wiz      3314: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.1       dsieger  3315: that allow finer tuning of the tree layout.</p>
                   3316: </div>
1.23      wiz      3317: <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
1.1       dsieger  3318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3319: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3320: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3321: enable this feature by adding the option
                   3322: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  3323: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3324: distfile is found, pkgsrc will try to resume it.</p>
                   3325: <p>You can also
1.29      dholland 3326: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.16      jnemeth  3327: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3328: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3329: by using the value manual.  A value of custom disables the system defaults
                   3330: and dependency tracking for the fetch program.  In that case you have to
                   3331: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3332: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3333: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  3334: <p>For example, if you want to use
1.16      jnemeth  3335: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  3336: like:</p>
                   3337: <pre class="programlisting">
1.16      jnemeth  3338: FETCH_USING=   wget
1.1       dsieger  3339: </pre>
                   3340: </div>
1.23      wiz      3341: <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
1.1       dsieger  3342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3343: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   3344: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3345: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3346: you will have to add the following line into
1.10      hubertf  3347: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3348: <pre class="programlisting">
1.4       rillig   3349: X11_TYPE=modular
1.1       dsieger  3350: </pre>
1.23      wiz      3351: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  3352: <h3 class="title">Note</h3>
1.4       rillig   3353: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3354: </p>
1.1       dsieger  3355: </div>
                   3356: </div>
1.23      wiz      3357: <div class="sect1" title="9.7. How to fetch files from behind a firewall">
1.1       dsieger  3358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3359: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3360: <p>If you are sitting behind a firewall which does not allow direct
                   3361: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3362: relevant proxy hosts.  This is done using an environment variable in the
                   3363: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      3364: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  3365: port 80 as the proxy port number.  So the proxy environment variables
                   3366: are:</p>
                   3367: <pre class="programlisting">
                   3368: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3369: http_proxy=http://orpheus.amdahl.com:80/
                   3370: </pre>
                   3371: </div>
1.23      wiz      3372: <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
1.1       dsieger  3373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  3374: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1       dsieger  3375: <p>This depends on which utility is used to retrieve distfiles.  From
                   3376: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3377: the first available command from the following list:</p>
1.23      wiz      3378: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3379: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3380: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  3381: </ul></div>
                   3382: <p>On a default NetBSD installation, this will be
                   3383: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3384: connections first, and falls back to active connections if the server
                   3385: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  3386: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3387: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3388: <p>Having that option present will prevent
                   3389: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3390: transfers.</p>
                   3391: </div>
1.23      wiz      3392: <div class="sect1" title="9.9. How to fetch all distfiles at once">
1.1       dsieger  3393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3394: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3395: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  3396: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      3397: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1       dsieger  3398: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  3399: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  3400: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3401: resulting list to your machine at work/school and use it there.  If you
1.29      dholland 3402: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1       dsieger  3403: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3404: URL:</p>
                   3405: <p>At home:</p>
                   3406: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3407: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3408: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3409: <p>At work:</p>
                   3410: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3411: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3412: home.</p>
                   3413: <p>If you have a machine running NetBSD, and you want to get
                   3414: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3415: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  3416: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  3417: directly by running:</p>
                   3418: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3419: <p>If you even decide to ignore
                   3420: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3421: by running:</p>
                   3422: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3423: </div>
1.23      wiz      3424: <div class="sect1" title="9.10. What does &#8220;Don't know how to make /usr/share/tmac/tmac.andoc&#8221; mean?">
1.1       dsieger  3425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3426: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                   3427: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3428: <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>
                   3429: package, you get the error from make that it doesn't know how to make
                   3430: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      3431: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  3432: the NetBSD base distribution on your machine.  It is recommended to do
                   3433: that to format man pages.</p>
                   3434: <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
                   3435: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  3436: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3437: </div>
1.23      wiz      3438: <div class="sect1" title="9.11. What does &#8220;Could not find bsd.own.mk&#8221; mean?">
1.1       dsieger  3439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3440: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3441: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3442: when you installed your NetBSD machine.  Please get and install it, by
                   3443: extracting it in <code class="filename">/</code>:</p>
                   3444: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3445: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3446: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  3447: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  3448: -r</strong></span>).</p>
                   3449: </div>
1.23      wiz      3450: <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
1.1       dsieger  3451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3452: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3453: <p>When installing packages as non-root user and using the just-in-time
1.29      dholland 3454: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1       dsieger  3455: password for each required package installed.  To avoid this, the sudo
                   3456: package can be used, which does password caching over a limited time.  To
                   3457: use it, install sudo (either as binary package or from
                   3458: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10      hubertf  3459: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3460: <span class="emphasis"><em>after</em></span> the definition of the
                   3461: <code class="varname">LOCALBASE</code> variable:</p>
                   3462: <pre class="programlisting">
                   3463: .if exists(${LOCALBASE}/bin/sudo)
                   3464: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3465: .endif
                   3466: </pre>
                   3467: </div>
1.23      wiz      3468: <div class="sect1" title="9.13. How do I change the location of configuration files?">
1.1       dsieger  3469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3470: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3471: <p>As the system administrator, you can choose where configuration files
                   3472: are installed.  The default settings make all these files go into
                   3473: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3474: be suboptimal depending on your expectations (e.g., a read-only,
                   3475: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3476: configuration of the provided packages).</p>
                   3477: <p>In order to change the defaults, you can modify the
                   3478: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3479: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3480: directory; some common examples include <code class="filename">/etc</code> or
                   3481: <code class="filename">/etc/pkg</code>.</p>
                   3482: <p>Furthermore, you can change this value on a per-package basis by
                   3483: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3484: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3485: package you would like to modify, that is, the contents of
                   3486: <code class="varname">PKGBASE</code>.</p>
                   3487: <p>Note that after changing these settings, you must rebuild and
                   3488: reinstall any affected packages.</p>
                   3489: </div>
1.23      wiz      3490: <div class="sect1" title="9.14. Automated security checks">
1.1       dsieger  3491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3492: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3493: <p>Please be aware that there can often be bugs in third-party software,
                   3494: and some of these bugs can leave a machine vulnerable to exploitation by
                   3495: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3496: maintains a database of known-exploits to packages which have at one time
                   3497: been included in pkgsrc.  The database can be downloaded automatically, and
                   3498: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3499: do this, refer to the following two tools (installed as part of the
                   3500: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23      wiz      3501: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3502: <li class="listitem">
1.20      snj      3503: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3504:     download a list of the security vulnerabilities information.  This list
1.25      spz      3505:     is kept up to date by the pkgsrc security team, and is distributed
                   3506:     from the NetBSD ftp server:</p>
                   3507: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1       dsieger  3508: </li>
1.23      wiz      3509: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3510:     current machine, checking each known vulnerability.  If a
1.1       dsieger  3511:     vulnerable package is installed, it will be shown by output to stdout,
                   3512:     including a description of the type of vulnerability, and a URL
                   3513:     containing more information.</p></li>
                   3514: </ol></div>
1.14      jmcneill 3515: <p>Use of these tools is strongly recommended!  After
1.23      wiz      3516: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.1       dsieger  3517: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14      jmcneill 3518: pkg_install</code></strong>.</p>
1.1       dsieger  3519: <p>If this package is installed, pkgsrc builds will use it to
1.10      hubertf  3520: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.1       dsieger  3521: check.</p>
                   3522: </div>
1.23      wiz      3523: <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
1.1       dsieger  3524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3525: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  3526: <p>When you add your own preferences to the
                   3527:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3528:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3529:        environment variables to the <code class="filename">./configure</code>
1.29      dholland 3530:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1       dsieger  3531:        <code class="varname">CFLAGS</code> from the environment variable by
                   3532:        overriding them in the <code class="filename">Makefile</code>s of their
                   3533:        package.</p>
                   3534: <p>Currently there is no solution to this problem. If you
                   3535:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3536:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3537:        directory and then inspect any <code class="filename">Makefile</code> and
                   3538:        <code class="filename">Makefile.in</code> for whether they define
                   3539:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3540:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  3541:        programmers write so bad code that it only works for the
                   3542:        specific combination of <code class="varname">CFLAGS</code> they have
                   3543:        chosen.</p>
                   3544: </div>
1.23      wiz      3545: <div class="sect1" title="9.16. A package does not build. What shall I do?">
1.1       dsieger  3546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3547: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3548: <div class="procedure"><ol class="procedure" type="1">
                   3549: <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  3550:        case that occurs often is that people only update pkgsrc in
                   3551:        parts, because of performance reasons. Since pkgsrc is one large
                   3552:        system, not a collection of many small systems, there are
                   3553:        sometimes changes that only work when the whole pkgsrc tree is
                   3554:        updated.</p></li>
1.23      wiz      3555: <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
                   3556:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3557:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  3558:        files.</p></li>
1.23      wiz      3559: <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3560:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3561:        verify this.</p></li>
1.23      wiz      3562: <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
1.1       dsieger  3563:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3564: </ol></div>
                   3565: </div>
1.23      wiz      3566: <div class="sect1" title="9.17. What does &#8220;Makefile appears to contain unresolved cvs/rcs/??? merge conflicts&#8221; mean?">
1.1       dsieger  3567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3568: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3569: <p>You have modified a file from pkgsrc, and someone else has
                   3570: modified that same file afterwards in the CVS repository. Both changes
                   3571: are in the same region of the file, so when you updated pkgsrc, the
                   3572: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3573: file. Because of these markers, the file is no longer a valid
                   3574: <code class="filename">Makefile</code>.</p>
                   3575: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3576: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3577: -dP</strong></span> in that directory to download the current version.</p>
                   3578: </div>
                   3579: </div>
                   3580: </div>
1.23      wiz      3581: <div class="part" title="Part II. The pkgsrc developer's guide">
1.1       dsieger  3582: <div class="titlepage"><div><div><h1 class="title">
                   3583: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.23      wiz      3584: <div class="partintro" title="The pkgsrc developer's guide">
1.1       dsieger  3585: <div></div>
                   3586: <p>This part of the book deals with creating and
1.23      wiz      3587:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3588:        guide on creating a new package. The remaining chapters are more
                   3589:        like a reference manual for pkgsrc.</p>
                   3590: <div class="toc">
                   3591: <p><b>Table of Contents</b></p>
                   3592: <dl>
1.6       rillig   3593: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3594: <dd><dl>
1.6       rillig   3595: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3596: <dd><dl>
1.6       rillig   3597: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3598: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3599: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3600: </dl></dd>
1.6       rillig   3601: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3602: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3603: </dl></dd>
                   3604: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3605: <dd><dl>
1.23      wiz      3606: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3607: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   3608: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3609: <dd><dl>
                   3610: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3611: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3612: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3613: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3614: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3615: </dl></dd>
                   3616: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3617: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3618: <dd><dl>
                   3619: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3620: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3621: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3622: </dl></dd>
1.23      wiz      3623: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3624: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   3625: </dl></dd>
1.23      wiz      3626: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3627: <dd><dl>
                   3628: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      3629: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   3630: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3631: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3632: <dd><dl>
                   3633: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3634: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3635: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3636: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3637: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3638: </dl></dd>
                   3639: </dl></dd>
                   3640: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3641: <dd><dl>
                   3642: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      3643: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3644: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6       rillig   3645: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3646: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      3647: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6       rillig   3648: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3649: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3650: </dl></dd>
                   3651: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3652: <dd><dl>
                   3653: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      3654: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3655: <dd><dl>
                   3656: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      3657: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3658:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3659:       and
                   3660:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3661:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3662: </dl></dd>
1.23      wiz      3663: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig   3664: <dd><dl>
1.23      wiz      3665: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6       rillig   3666: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3667: </dl></dd>
                   3668: </dl></dd>
                   3669: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3670: <dd><dl>
                   3671: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3672: <dd><dl>
                   3673: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3674: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3675: </dl></dd>
                   3676: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3677: <dd><dl>
1.23      wiz      3678: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6       rillig   3679: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3680: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3681: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3682: </dl></dd>
                   3683: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3684: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3685: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3687: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3688: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3689: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3690: </dl></dd>
                   3691: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3692: <dd><dl>
                   3693: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      3694: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6       rillig   3695: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3696: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3697: </dl></dd>
                   3698: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3699: <dd><dl>
                   3700: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3701: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3702: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3703: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      3704: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   3705: <dd><dl>
                   3706: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3707: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3708: </dl></dd>
1.23      wiz      3709: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3710: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3711: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3712: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3713: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3714: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3715: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3716: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3717: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3718: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig   3719: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3720: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3721: </dl></dd>
                   3722: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3723: <dd><dl>
                   3724: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3725: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3726: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3727: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3728: </dl></dd>
                   3729: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3730: <dd><dl>
                   3731: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3732: <dd><dl>
                   3733: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      3734: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6       rillig   3735: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3736: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3737: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3738: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3739: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3740: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3741: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3742: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3745: </dl></dd>
1.23      wiz      3746: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   3747: <dd><dl>
                   3748: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3749: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3750: </dl></dd>
1.23      wiz      3751: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig   3752: <dd><dl>
                   3753: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3754: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3755: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3756: </dl></dd>
                   3757: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3758: <dd><dl>
                   3759: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40    ! wiz      3762: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
        !          3763: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   3764: </dl></dd>
1.23      wiz      3765: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig   3766: <dd><dl>
                   3767: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      3769: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.6       rillig   3770: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3771: </dl></dd>
1.23      wiz      3772: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig   3773: <dd><dl>
                   3774: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3775: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3776: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3777: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3778: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3779: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3780: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3781: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3782: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      3783: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   3784: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3785: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3786: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3787: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3788: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3789: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3790: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3791: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3792:     emulation</a></span></dt>
1.6       rillig   3793: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3794: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3795: </dl></dd>
1.6       rillig   3796: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3797: </dl></dd>
1.6       rillig   3798: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3799: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3800: <dd><dl>
1.6       rillig   3801: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3803: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz      3804: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   3805: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      3806: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3807: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig   3808: </dl></dd>
                   3809: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3810: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3811: <dd><dl>
                   3812: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3813: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3814: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3815: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3816: </dl></dd>
                   3817: </dl>
                   3818: </div>
                   3819: </div>
1.23      wiz      3820: <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
1.1       dsieger  3821: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3822: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3823: <div class="toc">
                   3824: <p><b>Table of Contents</b></p>
                   3825: <dl>
1.6       rillig   3826: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3827: <dd><dl>
1.6       rillig   3828: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3830: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3831: </dl></dd>
1.6       rillig   3832: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3833: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1       dsieger  3834: </dl>
                   3835: </div>
                   3836: <p>When you find a package that is not yet in pkgsrc, you
                   3837: most likely have a URL from where you can download the source
                   3838: code. Starting with this URL, creating a package involves only a
                   3839: few steps.</p>
1.23      wiz      3840: <div class="procedure"><ol class="procedure" type="1">
                   3841: <li class="step" title="Step 1"><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>
                   3842: <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3843: category in which you want to place your package. You can also create a
                   3844: directory of your own (maybe called <code class="filename">local</code>). In that
                   3845: category directory, create another directory for your package and change
                   3846: into it.</p></li>
1.23      wiz      3847: <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3848: you for a URL. Enter the URL of the distribution file (in most cases a
                   3849: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3850: of your package are created automatically. The distribution file is
                   3851: extracted automatically to fill in some details in the
                   3852: <code class="filename">Makefile</code> that would otherwise have to be done
                   3853: manually.</p></li>
1.23      wiz      3854: <li class="step" title="Step 4">
1.1       dsieger  3855: <p>Examine the extracted files to determine the dependencies of
                   3856: your package. Ideally, this is mentioned in some
                   3857: <code class="filename">README</code> file, but things may differ. For each of
                   3858: these dependencies, look where it exists in pkgsrc, and if there is a
                   3859: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3860: line to your package <code class="filename">Makefile</code> which includes that
                   3861: file just before the last line. If the
1.25      spz      3862: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3863: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3864: <p>If you just need binaries from a package, add a
1.1       dsieger  3865: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3866: version of the dependency and where it can be found in pkgsrc. This line
                   3867: should be placed in the third paragraph. If the dependency is only
                   3868: needed for building the package, but not when using it, use
                   3869: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3870: Your package may then look like this:</p>
                   3871: <pre class="programlisting">
                   3872: [...]
                   3873: 
                   3874: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3875: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3876: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3877: 
                   3878: [...]
                   3879: 
                   3880: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3881: .include "../../devel/glib2/buildlink3.mk"
                   3882: .include "../../mk/bsd.pkg.mk"
                   3883: </pre>
                   3884: </li>
1.23      wiz      3885: <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   3886: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.10      hubertf  3887: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3888: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3889: -e</strong></span>, which outputs additional
                   3890: explanations.</p></li>
1.23      wiz      3891: <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3892: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.1       dsieger  3893: over there, you can hopefully continue here.</p></li>
1.23      wiz      3894: <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3895: directory from the extracted files. Besides these files, a lot of cache
                   3896: files and other system information has been saved in the working
                   3897: directory, which may become wrong after you edited the
                   3898: <code class="filename">Makefile</code>.</p></li>
1.23      wiz      3899: <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10      hubertf  3900: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.23      wiz      3901: <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
1.10      hubertf  3902: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3903: everything works.</p></li>
1.23      wiz      3904: <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3905: contains a list of the files that are installed by the package, is
1.10      hubertf  3906: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3907: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3908: the file using your preferred text editor to see if the list of
                   3909: files looks plausible.</p></li>
1.23      wiz      3910: <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3911: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.23      wiz      3912: <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3913: has been registered in the database of installed files, but with an
1.10      hubertf  3914: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3915: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3916: registered with the list of files from
                   3917: <code class="filename">PLIST</code>.</p></li>
1.23      wiz      3918: <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3919: package from the set of installed files.</p></li>
                   3920: </ol></div>
1.23      wiz      3921: <div class="sect1" title="10.1. Common types of packages">
1.1       dsieger  3922: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3923: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.23      wiz      3924: <div class="sect2" title="10.1.1. Perl modules">
1.1       dsieger  3925: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3926: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3927: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3928: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3929: </div>
1.23      wiz      3930: <div class="sect2" title="10.1.2. KDE applications">
1.1       dsieger  3931: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3932: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  3933: <p>KDE applications should always include
                   3934: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3935: settings that are typical of KDE packages.</p>
                   3936: </div>
1.23      wiz      3937: <div class="sect2" title="10.1.3. Python modules and programs">
1.17      imil     3938: <div class="titlepage"><div><div><h3 class="title">
                   3939: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3940: <p>Python modules and programs packages are easily created using a
                   3941: set of predefined variables.</p>
1.23      wiz      3942: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3943: easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3944: If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
                   3945: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
1.17      imil     3946: pkgsrc will make use of this framework.
1.23      wiz      3947: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3948: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
1.17      imil     3949: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3950: to the name of the script.</p>
                   3951: <p>
                   3952: If the default Python versions are not supported by the software, set the
                   3953: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   3954: the software is known to work with, from the most recent to the older
                   3955: one, e.g.
                   3956: </p>
                   3957: <pre class="programlisting">
1.39      wiz      3958: PYTHON_VERSIONS_ACCEPTED=       31 27 26
1.17      imil     3959: </pre>
                   3960: <p>
                   3961: If the packaged software is a Python module, include
1.23      wiz      3962: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
1.17      imil     3963: In this case, the package directory should be called
1.23      wiz      3964: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3965: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3966: </p>
                   3967: <pre class="programlisting">
                   3968: DISTNAME=   foopymodule-1.2.10
                   3969: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3970: </pre>
                   3971: <p>If it is an application, also include
1.23      wiz      3972: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
                   3973: before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
1.17      imil     3974: <p>If the packaged software, either it is an application or a module, is
                   3975: egg-aware, you only need to include
1.23      wiz      3976: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
1.17      imil     3977: <p>In order to correctly set the path to the Python interpreter, use the
                   3978: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35      wiz      3979: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   3980: For example :
1.17      imil     3981: </p>
                   3982: <pre class="programlisting">
1.35      wiz      3983: REPLACE_PYTHON=   *.py
1.17      imil     3984: </pre>
                   3985: </div>
1.1       dsieger  3986: </div>
1.23      wiz      3987: <div class="sect1" title="10.2. Examples">
1.1       dsieger  3988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3989: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.23      wiz      3990: <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
1.1       dsieger  3991: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3992: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.23      wiz      3993: <div class="sect3" title="10.2.1.1. The initial package">
1.1       dsieger  3994: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3995: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3996: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      3997: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  3998: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      3999: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  4000: <pre class="programlisting">
                   4001: <code class="prompt">$</code> mkdir www/nvu
                   4002: <code class="prompt">$</code> cd www/nvu
                   4003: </pre>
                   4004: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  4005: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  4006: <pre class="programlisting">
                   4007: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4008: </pre>
                   4009: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4010: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      4011: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.1       dsieger  4012: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4013: <code class="varname">COMMENT</code> fields. Then the package
                   4014: <code class="filename">Makefile</code> looked like that:</p>
                   4015: <pre class="programlisting">
                   4016: # $NetBSD$
                   4017: #
                   4018: 
                   4019: DISTNAME=       nvu-1.0-sources
                   4020: PKGNAME=        nvu-1.0
                   4021: CATEGORIES=     www
                   4022: MASTER_SITES=   http://cvs.nvu.com/download/
                   4023: EXTRACT_SUFX=   .tar.bz2
                   4024: 
                   4025: MAINTAINER=     rillig@NetBSD.org
                   4026: HOMEPAGE=       http://cvs.nvu.com/
                   4027: COMMENT=        Web Authoring System
                   4028: 
                   4029: # url2pkg-marker (please do not remove this line.)
                   4030: .include "../../mk/bsd.pkg.mk"
                   4031: </pre>
                   4032: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4033: source archive:</p>
                   4034: <pre class="programlisting">
                   4035: url2pkg&gt; Running "make makesum" ...
                   4036: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4037: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4038: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4039: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4040: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4041: url2pkg&gt; Running "make extract" ...
                   4042: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4043: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4044: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4045: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4046: ===&gt; Installing dependencies for nvu-1.0
                   4047: ===&gt; Overriding tools for nvu-1.0
                   4048: ===&gt; Extracting for nvu-1.0
                   4049: url2pkg&gt; Adjusting the Makefile.
                   4050: 
                   4051: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4052: 
                   4053: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4054: </pre>
                   4055: </div>
1.23      wiz      4056: <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
1.1       dsieger  4057: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4058: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1       dsieger  4059: <p>Now that the package has been extracted, let's see what's inside
                   4060: it. The package has a <code class="filename">README.txt</code>, but that only
                   4061: says something about mozilla, so it's probably useless for seeing what
                   4062: dependencies this package has. But since there is a GNU configure script
                   4063: in the package, let's hope that it will complain about everything it
                   4064: needs.</p>
                   4065: <pre class="programlisting">
                   4066: <code class="prompt">$</code> bmake
                   4067: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4068: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4069: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4070: ===&gt; Patching for nvu-1.0
                   4071: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4072: ===&gt; Configuring for nvu-1.0
                   4073: [...]
                   4074: configure: error: Perl 5.004 or higher is required.
                   4075: [...]
                   4076: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4077: [...]
                   4078: </pre>
                   4079: <p>That worked quite well. So I opened the package Makefile in my
                   4080: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      4081: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  4082: package have changed now, and since a perl wrapper is automatically
1.23      wiz      4083: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  4084: from scratch.</p>
                   4085: <pre class="programlisting">
                   4086: <code class="prompt">$</code> bmake clean
                   4087: ===&gt; Cleaning for nvu-1.0
                   4088: <code class="prompt">$</code> bmake
                   4089: [...]
                   4090: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4091: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4092: [...]
                   4093: </pre>
1.23      wiz      4094: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  4095: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4096: <pre class="programlisting">
                   4097: [...]
                   4098: checking for GTK - version &gt;= 1.2.0... no
                   4099: *** Could not run GTK test program, checking why...
                   4100: [...]
                   4101: </pre>
                   4102: <p>Now to the other dependencies. The first question is: Where is the
                   4103: GTK package hidden in pkgsrc?</p>
                   4104: <pre class="programlisting">
                   4105: <code class="prompt">$</code> echo ../../*/gtk*
                   4106: [many packages ...]
                   4107: <code class="prompt">$</code> echo ../../*/gtk
                   4108: ../../x11/gtk
                   4109: <code class="prompt">$</code> echo ../../*/gtk2
                   4110: ../../x11/gtk2
                   4111: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4112: ../../x11/gtk2/buildlink3.mk
                   4113: </pre>
                   4114: <p>The first try was definitely too broad. The second one had exactly
                   4115: one result, which is very good. But there is one pitfall with GNOME
                   4116: packages. Before GNOME 2 had been released, there were already many
                   4117: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4118: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      4119: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  4120: whether this was the case here, and indeed it was.</p>
                   4121: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4122: file, adding the dependency is very easy. I just inserted an
                   4123: <code class="literal">.include</code> line before the last line of the package
                   4124: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4125: <pre class="programlisting">
                   4126: [...]
                   4127: .include "../../x11/gtk2/buildlink3.mk"
                   4128: .include "../../mk/bsd.pkg.mk
                   4129: </pre>
1.10      hubertf  4130: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  4131: was:</p>
                   4132: <pre class="programlisting">
                   4133: [...]
                   4134: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4135: checking for GTK - version &gt;= 1.2.0... no
                   4136: *** Could not run GTK test program, checking why...
                   4137: *** The test program failed to compile or link. See the file config.log for the
                   4138: *** exact error that occured. This usually means GTK was incorrectly installed
                   4139: *** or that you have moved GTK since it was installed. In the latter case, you
                   4140: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4141: configure: error: Test for GTK failed.
                   4142: [...]
                   4143: </pre>
1.23      wiz      4144: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   4145: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  4146: told me that this package really wanted to have the GNOME 1 version of
                   4147: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  4148: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  4149: So I changed the <code class="literal">x11/gtk2</code> to
                   4150: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4151: and tried again.</p>
                   4152: <pre class="programlisting">
                   4153: [...]
                   4154: 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
                   4155: In file included from xpidl.c:42:
                   4156: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4157: In file included from xpidl.c:42:
                   4158: xpidl.h:132: error: parse error before "IDL_ns"
                   4159: [...]
                   4160: </pre>
                   4161: <p>The package still does not find all of its dependencies. Now the
                   4162: question is: Which package provides the
                   4163: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4164: <pre class="programlisting">
                   4165: <code class="prompt">$</code> echo ../../*/*idl*
                   4166: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4167: <code class="prompt">$</code> echo ../../*/*IDL*
                   4168: ../../net/libIDL
                   4169: </pre>
                   4170: <p>Let's take the one from the second try. So I included the
                   4171: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4172: again. But the error didn't change. After digging through some of the
                   4173: code, I concluded that the build process of the package was broken and
                   4174: couldn't have ever worked, but since the Mozilla source tree is quite
                   4175: large, I didn't want to fix it. So I added the following to the package
                   4176: <code class="filename">Makefile</code> and tried again:</p>
                   4177: <pre class="programlisting">
                   4178: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4179: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4180: </pre>
                   4181: <p>The latter line is needed because the package expects the library
                   4182: <code class="filename">libIDL.so</code>, but only
                   4183: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4184: wrapper to rewrite that on the fly.</p>
                   4185: <p>The next problem was related to a recent change of the FreeType
                   4186: 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>
                   4187: which patch files were relevant for this issue and copied them to the
                   4188: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4189: patches so that they applied cleanly and retried again. This time,
                   4190: everything worked.</p>
                   4191: </div>
1.23      wiz      4192: <div class="sect3" title="10.2.1.3. Installing the package">
1.1       dsieger  4193: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4194: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4195: <pre class="programlisting">
                   4196: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4197: [...]
                   4198: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4199: <code class="prompt">$</code> bmake deinstall
                   4200: <code class="prompt">$</code> bmake install
                   4201: </pre>
                   4202: </div>
                   4203: </div>
                   4204: </div>
                   4205: </div>
1.23      wiz      4206: <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
1.1       dsieger  4207: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4208: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4209: <div class="toc">
                   4210: <p><b>Table of Contents</b></p>
                   4211: <dl>
1.23      wiz      4212: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4213: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   4214: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4215: <dd><dl>
                   4216: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4217: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4218: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4219: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4220: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4221: </dl></dd>
                   4222: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4223: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4224: <dd><dl>
                   4225: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4226: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4227: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4228: </dl></dd>
1.23      wiz      4229: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4230: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  4231: </dl>
                   4232: </div>
                   4233: <p>Whenever you're preparing a package, there are a number of
                   4234: files involved which are described in the following
                   4235: sections.</p>
1.23      wiz      4236: <div class="sect1" title="11.1. Makefile">
1.1       dsieger  4237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4238: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4239: </h2></div></div></div>
                   4240: <p>Building, installation and creation of a binary package are all
                   4241:   controlled by the package's <code class="filename">Makefile</code>.
                   4242:   The <code class="filename">Makefile</code> describes various things about
                   4243:   a package, for example from where to get it, how to configure,
                   4244:   build, and install it.</p>
                   4245: <p>A package <code class="filename">Makefile</code> contains several
                   4246:   sections that describe the package.</p>
                   4247: <p>In the first section there are the following variables, which
                   4248:   should appear exactly in the order given here.  The order and
                   4249:   grouping of the variables is mostly historical and has no further
                   4250:   meaning.</p>
1.23      wiz      4251: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4252: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  4253:     distribution file to be downloaded from the package's
                   4254:     website.</p></li>
1.23      wiz      4255: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1       dsieger  4256:     package, as used by pkgsrc. You only need to provide it if
                   4257:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4258:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4259:     directory name together with the version number. It must match the
                   4260:     regular expression
                   4261:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4262:     starts with a letter or digit, and contains only letters, digits,
                   4263:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      4264: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1       dsieger  4265:     the package file to create if the <code class="varname">PKGNAME</code>
                   4266:     isn't unique on a SVR4 system. The default is
                   4267:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4268:     <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
                   4269:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4270:     does not produce an unique package name on a SVR4 system.
                   4271:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4272:     characters.</p></li>
1.23      wiz      4273: <li class="listitem">
1.1       dsieger  4274: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4275:     which the package fits in. You can choose any of the top-level
                   4276:     directories of pkgsrc for it.</p>
                   4277: <p>Currently the following values are available for
                   4278:     <code class="varname">CATEGORIES</code>. If more than
                   4279:     one is used, they need to be separated by spaces:</p>
                   4280: <pre class="programlisting">
                   4281: archivers     cross         geography     meta-pkgs     security
                   4282: audio         databases     graphics      misc          shells
                   4283: benchmarks    devel         ham           multimedia    sysutils
                   4284: biology       editors       inputmethod   net           textproc
                   4285: cad           emulators     lang          news          time
                   4286: chat          finance       mail          parallel      wm
                   4287: comms         fonts         math          pkgtools      www
                   4288: converters    games         mbone         print         x11
                   4289: </pre>
                   4290: </li>
1.23      wiz      4291: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  4292:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4293:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4294:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.23      wiz      4295:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.1       dsieger  4296: </ul></div>
                   4297: <p>The second section contains information about separately
                   4298:   downloaded patches, if any.
                   4299:   </p>
1.23      wiz      4300: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4301: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1       dsieger  4302:     Name(s) of additional files that contain distribution patches.
                   4303:     There is no default. pkgsrc will look for them at
                   4304:     <code class="varname">PATCH_SITES</code>.
                   4305:     They will automatically be uncompressed before patching if
                   4306:     the names end with <code class="filename">.gz</code> or
                   4307:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      4308: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  4309:     Primary location(s) for distribution patch files (see
                   4310:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4311: </ul></div>
                   4312: <p>The third section contains the following variables.
                   4313:   </p>
1.23      wiz      4314: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4315: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 4316:     address of the person who feels responsible for this package,
                   4317:     and who is most likely to look at problems or questions regarding
1.29      dholland 4318:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14      jmcneill 4319:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4320:     before making changes to the package, but are not required to
                   4321:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4322:     to yourself. If you really can't maintain the package for future
                   4323:     updates, set it to
1.10      hubertf  4324:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.23      wiz      4325: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 4326:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4327:     developers to update or change the package without contacting
                   4328:     you first. A package Makefile should contain one of
                   4329:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4330:     not both.  </p></li>
1.23      wiz      4331: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  4332:     find more information about the package.</p></li>
1.23      wiz      4333: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  4334:     description of the package (should not include the package
                   4335:     name).</p></li>
                   4336: </ul></div>
                   4337: <p>Other variables that affect the build:
                   4338:   </p>
1.23      wiz      4339: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4340: <p><code class="varname">WRKSRC</code>: The directory where the
                   4341:       interesting distribution files of the package are found. The
                   4342:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4343:       works for most packages.</p>
                   4344: <p>If a package doesn't create a subdirectory for itself
                   4345:       (most GNU software does, for instance), but extracts itself in
                   4346:       the current directory, you should set
                   4347:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4348: <p>If a package doesn't create a subdirectory with the
                   4349:       name of <code class="varname">DISTNAME</code> but some different name,
                   4350:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4351:       <code class="filename">${WRKDIR}</code>, for example
                   4352:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4353:       <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>
                   4354: <p>The name of the working directory created by pkgsrc is
                   4355:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4356:       variable. By default, its value is
                   4357:       <code class="filename">work</code>. If you want to use the same
                   4358:       pkgsrc tree for building different kinds of binary packages,
                   4359:       you can change the variable according to your needs. Two
                   4360:       other variables handle common cases of setting
                   4361:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4362:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  4363:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4364:       the host's name is attached to the directory name. If
                   4365:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4366:       is attached, which might look like
                   4367:       <code class="filename">work.i386</code> or
                   4368:       <code class="filename">work.sparc</code>.</p>
                   4369: </li></ul></div>
                   4370: <p>Please pay attention to the following gotchas:</p>
1.23      wiz      4371: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4372: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  4373:       installed in compressed form by the package.  For packages using
                   4374:       BSD-style makefiles which honor MANZ, there is
                   4375:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      4376: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4377:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  4378:       below).</p></li>
1.23      wiz      4379: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.1       dsieger  4380: </ul></div>
                   4381: </div>
1.23      wiz      4382: <div class="sect1" title="11.2. distinfo">
1.1       dsieger  4383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4384: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4385: </h2></div></div></div>
                   4386: <p>The <code class="filename">distinfo</code> file contains the message
                   4387:   digest, or checksum, of each distfile needed for the package. This
                   4388:   ensures that the distfiles retrieved from the Internet have not been
                   4389:   corrupted during transfer or altered by a malign force to introduce
                   4390:   a security hole. Due to recent rumor about weaknesses of digest
                   4391:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4392:   message digests, as well as the file size.</p>
                   4393: <p>The <code class="filename">distinfo</code> file also contains the
                   4394:   checksums for all the patches found in the
1.10      hubertf  4395:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.1       dsieger  4396: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10      hubertf  4397:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1       dsieger  4398:   command.</p>
                   4399: <p>Some packages have different sets of distfiles depending on
1.23      wiz      4400:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1       dsieger  4401:   <code class="filename">distinfo</code> file and care should be taken when
                   4402:   upgrading such a package to ensure distfile information is not
                   4403:   lost.</p>
                   4404: </div>
1.23      wiz      4405: <div class="sect1" title="11.3. patches/*">
1.1       dsieger  4406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4407: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4408: <p>Many packages still don't work out-of-the box on the various
                   4409:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4410:   patch files are needed to make the package work. These patch files are
                   4411:   found in the <code class="filename">patches/</code> directory.</p>
                   4412: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4413:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.10      hubertf  4414:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.24      wiz      4415:   order</a>.</p>
1.23      wiz      4416: <div class="sect2" title="11.3.1. Structure of a single patch file">
1.1       dsieger  4417: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4418: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4419: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  4420:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  4421:   problems. (To force patches to apply with fuzz you can set
                   4422:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4423:   should contain only changes for a single file, and no file should be
                   4424:   patched by more than one patch file. This helps to keep future
                   4425:   modifications simple.</p>
                   4426: <p>Each patch file is structured as follows: In the first line,
                   4427:   there is the RCS Id of the patch itself. The second line should be
                   4428:   empty for aesthetic reasons. After that, there should be a comment for
                   4429:   each change that the patch does. There are a number of standard
                   4430:   cases:</p>
1.23      wiz      4431: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4432: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  4433:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      4434: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  4435:   platform and other environment (for example, the compiler) that the
                   4436:   patch is needed for.</p></li>
                   4437: </ul></div>
1.24      wiz      4438: <p>In all, the patch should be commented so that any
1.1       dsieger  4439:   developer who knows the code of the application can make some use of
                   4440:   the patch. Special care should be taken for the upstream developers,
                   4441:   since we generally want that they accept our patches, so we have less
                   4442:   work in the future.</p>
                   4443: </div>
1.23      wiz      4444: <div class="sect2" title="11.3.2. Creating patch files">
1.1       dsieger  4445: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4446: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4447: <p>One important thing to mention is to pay attention that no RCS
                   4448:   IDs get stored in the patch files, as these will cause problems when
                   4449:   later checked into the NetBSD CVS tree. Use the
1.10      hubertf  4450:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1       dsieger  4451:   problems.</p>
                   4452: <p>For even more automation, we recommend using
1.10      hubertf  4453:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  4454:   whole set of patches. You just have to backup files before you
                   4455:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  4456:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4457:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  4458:   you upgrade a package this way, you can easily compare the new
                   4459:   set of patches with the previously existing one with
1.24      wiz      4460:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4461:   are replaced by new files, so carefully check if you want to take all
                   4462:   the changes.</p>
1.1       dsieger  4463: <p>When you have finished a package, remember to generate
1.10      hubertf  4464:   the checksums for the patch files by using the <span class="command"><strong>make
1.23      wiz      4465:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.1       dsieger  4466: <p>When adding a patch that corrects a problem in the
                   4467:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4468:   man pages should go), send the patch as a bug report to the
                   4469:   maintainer.  This benefits non-pkgsrc users of the package,
                   4470:   and usually makes it possible to remove the patch in future
                   4471:   version.</p>
1.2       rillig   4472: <p>The file names of the patch files are usually of the form
1.24      wiz      4473:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4474:   Many packages still use the previous convention
                   4475:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4476:   but new patches should be of the form containing the filename.
                   4477:   <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
                   4478:   automatically.</p>
1.1       dsieger  4479: </div>
1.23      wiz      4480: <div class="sect2" title="11.3.3. Sources where the patch files come from">
1.1       dsieger  4481: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4482: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4483: <p>If you want to share patches between multiple packages
                   4484:   in pkgsrc, e.g. because they use the same distfiles, set
                   4485:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4486:   can be found, e.g.:</p>
                   4487: <pre class="programlisting">
                   4488: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4489: </pre>
                   4490: <p>Patch files that are distributed by the author or other
                   4491:     maintainers can be listed in
                   4492:     <code class="varname">PATCHFILES</code>.</p>
                   4493: <p>If it is desired to store any patches that should not be
                   4494:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4495:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4496:     directory tree there is expected to have the same
1.23      wiz      4497:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  4498:     patches are expected to be stored inside these dirs (also
                   4499:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4500:     example, if you want to keep a private patch for
                   4501:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4502:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4503:     files in the named directory are expected to be patch files,
                   4504:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4505:     applied</em></span>.</p>
                   4506: </div>
1.23      wiz      4507: <div class="sect2" title="11.3.4. Patching guidelines">
1.1       dsieger  4508: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4509: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4510: <p>When fixing a portability issue in the code do not use
                   4511:       preprocessor magic to check for the current operating system nor
                   4512:       platform.  Doing so hurts portability to other platforms because
                   4513:       the OS-specific details are not abstracted appropriately.</p>
                   4514: <p>The general rule to follow is: instead of checking for the
                   4515:       operating system the application is being built on, check for the
                   4516:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4517:       instead of assuming that kqueue is available under NetBSD and
                   4518:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 4519:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4520:       yes, this generally involves patching the
1.10      hubertf  4521:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  4522:       that prevents some OSes from adopting interfaces from other OSes
                   4523:       (e.g. Linux implementing kqueue), something that the above checks
                   4524:       cannot take into account.</p>
                   4525: <p>Of course, checking for features generally involves more
                   4526:       work on the developer's side, but the resulting changes are
                   4527:       cleaner and there are chances they will work on many other
                   4528:       platforms.  Not to mention that there are higher chances of being
                   4529:       later integrated into the mainstream sources.  Remember:
                   4530:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4531: <p>Some typical examples:</p>
                   4532: <div class="table">
1.6       rillig   4533: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4534: <div class="table-contents"><table summary="Patching examples" border="1">
                   4535: <colgroup>
                   4536: <col>
                   4537: <col>
                   4538: <col>
                   4539: </colgroup>
                   4540: <thead><tr>
                   4541: <th>Where</th>
                   4542: <th>Incorrect</th>
                   4543: <th>Correct</th>
                   4544: </tr></thead>
                   4545: <tbody>
                   4546: <tr>
                   4547: <td>configure script</td>
                   4548: <td>
                   4549: <pre class="programlisting">
                   4550: case ${target_os} in
                   4551: netbsd*) have_kvm=yes ;;
                   4552: *)       have_kvm=no  ;;
                   4553: esac
                   4554: </pre>
                   4555:              </td>
                   4556: <td>
                   4557: <pre class="programlisting">
                   4558: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4559: </pre>
                   4560:              </td>
                   4561: </tr>
                   4562: <tr>
                   4563: <td>C source file</td>
                   4564: <td>
                   4565: <pre class="programlisting">
                   4566: #if defined(__NetBSD__)
                   4567: #  include &lt;sys/event.h&gt;
                   4568: #endif
                   4569: </pre>
                   4570:              </td>
                   4571: <td>
                   4572: <pre class="programlisting">
                   4573: #if defined(HAVE_SYS_EVENT_H)
                   4574: #  include &lt;sys/event.h&gt;
                   4575: #endif
                   4576: </pre>
                   4577:              </td>
                   4578: </tr>
                   4579: <tr>
                   4580: <td>C source file</td>
                   4581: <td>
                   4582: <pre class="programlisting">
                   4583: int
                   4584: monitor_file(...)
                   4585: {
                   4586: #if defined(__NetBSD__)
                   4587:         int fd = kqueue();
                   4588:         ...
                   4589: #else
                   4590:         ...
                   4591: #endif
                   4592: }
                   4593: </pre>
                   4594:              </td>
                   4595: <td>
                   4596: <pre class="programlisting">
                   4597: int
                   4598: monitor_file(...)
                   4599: {
                   4600: #if defined(HAVE_KQUEUE)
                   4601:         int fd = kqueue();
                   4602:         ...
                   4603: #else
                   4604:        ...
                   4605: #endif
                   4606: }
                   4607: </pre>
                   4608:              </td>
                   4609: </tr>
                   4610: </tbody>
                   4611: </table></div>
                   4612: </div>
                   4613: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  4614:       packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4615:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  4616:       2</a>).  It summarizes multiple details on how to make
                   4617:       software easier to package; all the suggestions in it were
                   4618:       collected from our experience in pkgsrc work, so they are possibly
                   4619:       helpful when creating patches too.</p>
                   4620: </div>
1.23      wiz      4621: <div class="sect2" title="11.3.5. Feedback to the author">
1.1       dsieger  4622: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4623: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4624: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4625:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4626:       improvements you do to a package to the mainstream developers.
                   4627:       This is the only way to get their attention on portability issues
                   4628:       and to ensure that future versions can be built out-of-the box on
                   4629:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4630:       the fixes straight from the packaged code.</p>
                   4631: <p>This generally involves cleaning up the patches
                   4632:       (because sometimes the patches that are
1.40    ! wiz      4633:       added to pkgsrc are quick hacks), filing bug reports in the
1.1       dsieger  4634:       appropriate trackers for the projects and working with the
                   4635:       mainstream authors to accept your changes.  It is
                   4636:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4637:       the packages in pkgsrc are kept simple and thus further changes
                   4638:       can be done without much hassle.</p>
1.24      wiz      4639: <p>When you have done this, please add a URL to the upstream
                   4640:       bug report to the patch comment.</p>
1.1       dsieger  4641: <p>Support the idea of free software!</p>
                   4642: </div>
                   4643: </div>
1.23      wiz      4644: <div class="sect1" title="11.4. Other mandatory files">
1.1       dsieger  4645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4646: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1       dsieger  4647: <div class="variablelist"><dl>
                   4648: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4649: <dd><p>A multi-line description of the piece of software.  This should include
                   4650:          any credits where they are due.  Please bear in mind that others do not
                   4651:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4652:          will read everything that you write here.</p></dd>
                   4653: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4654: <dd><p>This file governs the files that are installed on your
                   4655:          system: all the binaries, manual pages, etc. There are other
                   4656:          directives which may be entered in this file, to control the
                   4657:          creation and deletion of directories, and the location of
1.10      hubertf  4658:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1       dsieger  4659:          information.</p></dd>
                   4660: </dl></div>
                   4661: </div>
1.23      wiz      4662: <div class="sect1" title="11.5. Optional files">
1.1       dsieger  4663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4664: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.23      wiz      4665: <div class="sect2" title="11.5.1. Files affecting the binary package">
1.1       dsieger  4666: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4667: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1       dsieger  4668: <div class="variablelist"><dl>
                   4669: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      4670: <dd>
1.29      dholland 4671: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1       dsieger  4672:            First time after package extraction and before files are
                   4673:            moved in place, the second time after the files to install
                   4674:            are moved in place. This can be used to do any custom
                   4675:            procedures not possible with @exec commands in
1.29      dholland 4676:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4677:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.28      wiz      4678:            Please note that you can modify variables in it easily by using
                   4679:            <code class="varname">FILES_SUBST</code> in the package's
                   4680:            <code class="filename">Makefile</code>:</p>
                   4681: <pre class="programlisting">
                   4682: FILES_SUBST+=  SOMEVAR="somevalue"
                   4683: </pre>
                   4684: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4685:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4686:            performed for <code class="varname">PREFIX</code>,
                   4687:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4688:            <code class="varname">VARBASE</code>, and a few others, type
                   4689:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4690:            complete list.</p>
                   4691: </dd>
1.1       dsieger  4692: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4693: <dd><p>This script is executed before and after any files are removed.  It is
                   4694:            this script's responsibility to clean up any additional messy details
                   4695:            around the package's installation, since all pkg_delete knows is how to
                   4696:            delete the files created in the original distribution.
1.29      dholland 4697:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4698:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28      wiz      4699:            The same methods to replace variables can be used as for
                   4700:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4701: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4702: <dd>
                   4703: <p>This file is displayed after installation of the package.
                   4704:            Useful for things like legal notices on almost-free
                   4705:            software and hints for updating config files after
                   4706:            installing modules for apache, PHP etc.
                   4707:            Please note that you can modify variables in it easily by using
                   4708:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4709:            <code class="filename">Makefile</code>:</p>
                   4710: <pre class="programlisting">
                   4711: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4712: </pre>
1.23      wiz      4713: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4714:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4715:            performed for <code class="varname">PKGNAME</code>,
                   4716:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4717:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4718:            <code class="varname">X11BASE</code>,
                   4719:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4720:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4721:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4722: <p>You can display a different or additional files by
                   4723:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4724:            default is <code class="filename">MESSAGE</code>, if the file
                   4725:            exists.</p>
                   4726: </dd>
                   4727: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4728: <dd><p>FIXME: There is no documentation on the
                   4729:        alternatives framework.</p></dd>
                   4730: </dl></div>
                   4731: </div>
1.23      wiz      4732: <div class="sect2" title="11.5.2. Files affecting the build process">
1.1       dsieger  4733: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4734: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1       dsieger  4735: <div class="variablelist"><dl>
                   4736: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4737: <dd><p>This file contains arbitrary things that could
                   4738:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4739:        to be used by more than one package. This file should only be
                   4740:        used when the packages that will use the file are known in
                   4741:        advance. For other purposes it is often better to write a
                   4742:        <code class="filename">*.mk</code> file and give it a good name that
                   4743:        describes what it does.</p></dd>
                   4744: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4745: <dd><p>This file contains the dependency information
1.10      hubertf  4746:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1       dsieger  4747: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4748: <dd><p>This file contains workarounds for compiler bugs
                   4749:        and similar things. It is included automatically by the pkgsrc
                   4750:        infrastructure, so you don't need an extra
                   4751:        <code class="literal">.include</code> line for
                   4752:        it.</p></dd>
                   4753: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4754: <dd><p>This file contains the code for the
1.10      hubertf  4755:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1       dsieger  4756:        selected by the user. If a package has only one or two options,
                   4757:        it is equally acceptable to put the code directly into the
                   4758:        <code class="filename">Makefile</code>.</p></dd>
                   4759: </dl></div>
                   4760: </div>
1.23      wiz      4761: <div class="sect2" title="11.5.3. Files affecting nothing at all">
1.1       dsieger  4762: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4763: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1       dsieger  4764: <div class="variablelist"><dl>
                   4765: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4766: <dd><p>These files do not take place in the creation of
                   4767:        a package and thus are purely informative to the package
                   4768:        developer.</p></dd>
                   4769: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4770: <dd><p>This file contains things that need to be done
                   4771:        to make the package even
                   4772:        better.</p></dd>
                   4773: </dl></div>
                   4774: </div>
                   4775: </div>
1.23      wiz      4776: <div class="sect1" title="11.6. work*">
1.1       dsieger  4777: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4778: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4779: </h2></div></div></div>
1.10      hubertf  4780: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4781:     unpacked into the directory denoted by
                   4782:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4783:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4784:     directory is also used to keep various timestamp files.
                   4785:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4786:     The default is <code class="filename">${.CURDIR}/work</code>
                   4787:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4788:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4789: </div>
1.23      wiz      4790: <div class="sect1" title="11.7. files/*">
1.1       dsieger  4791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4792: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4793: </h2></div></div></div>
                   4794: <p>If you have any files that you wish to be placed in the package prior
                   4795:     to configuration or building, you could place these files here and use
1.10      hubertf  4796:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4797:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4798:     this. Alternatively, you could simply diff the file against
                   4799:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4800:     the creation of this file.</p>
                   4801: <p>If you want to share files in this way with other
                   4802:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4803:     to the other package's <code class="filename">files</code> directory,
                   4804:     e.g.:</p>
                   4805: <pre class="programlisting">
                   4806: FILESDIR=${.CURDIR}/../xemacs/files
                   4807: </pre>
                   4808: </div>
                   4809: </div>
1.23      wiz      4810: <div class="chapter" title="Chapter 12. Programming in Makefiles">
1.1       dsieger  4811: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4812: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4813: <div class="toc">
                   4814: <p><b>Table of Contents</b></p>
                   4815: <dl>
1.6       rillig   4816: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      4817: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   4818: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4819: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4820: <dd><dl>
                   4821: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4822: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4823: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4824: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4825: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1       dsieger  4826: </dl></dd>
                   4827: </dl>
                   4828: </div>
                   4829: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4830:   each of which forms a well-defined part of the pkgsrc system. Using
1.29      dholland 4831:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1       dsieger  4832:   like pkgsrc requires some discipline to keep the code correct and
                   4833:   understandable.</p>
                   4834: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4835:   programming are variables (which are actually macros) and shell
                   4836:   commands. Among these shell commands may even be more complex ones
1.29      dholland 4837:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1       dsieger  4838:   as intended it is necessary to quote all variables correctly when they
                   4839:   are used.</p>
                   4840: <p>This chapter describes some patterns, that appear quite often in
                   4841:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4842:   with them.</p>
1.23      wiz      4843: <div class="sect1" title="12.1. Caveats">
1.1       dsieger  4844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4845: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.23      wiz      4846: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4847: <p>When you are creating a file as a
                   4848:     target of a rule, always write the data to a temporary file first
                   4849:     and finally rename that file. Otherwise there might occur an error
                   4850:     in the middle of generating the file, and when the user runs
1.29      dholland 4851:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1       dsieger  4852:     regenerated properly. Example:</p>
                   4853: <pre class="programlisting">
                   4854: wrong:
                   4855:         @echo "line 1" &gt; ${.TARGET}
                   4856:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4857:         @false
                   4858: 
                   4859: correct:
                   4860:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4861:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4862:         @false
                   4863:         @mv ${.TARGET}.tmp ${.TARGET}
                   4864: </pre>
1.10      hubertf  4865: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4866:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4867:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4868:     correct</strong></span> gives an error message twice, as expected.</p>
1.29      dholland 4869: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1       dsieger  4870:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4871:     happens when it is interrupted, for example by pressing
                   4872:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29      dholland 4873:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1       dsieger  4874: </li></ul></div>
                   4875: </div>
1.23      wiz      4876: <div class="sect1" title="12.2. Makefile variables">
1.1       dsieger  4877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4878: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4879: <p><code class="filename">Makefile</code> variables contain strings that
                   4880:     can be processed using the five operators ``='', ``+='', ``?='',
1.29      dholland 4881:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1       dsieger  4882:     page.</p>
                   4883: <p>When a variable's value is parsed from a
                   4884:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4885:     backslash character ``\'' are handled specially. If a backslash is
                   4886:     followed by a newline, any whitespace immediately in front of the
                   4887:     backslash, the backslash, the newline, and any whitespace
                   4888:     immediately behind the newline are replaced with a single space. A
                   4889:     backslash character and an immediately following hash character are
                   4890:     replaced with a single hash character. Otherwise, the backslash is
                   4891:     passed as is. In a variable assignment, any hash character that is
                   4892:     not preceded by a backslash starts a comment that continues upto the
                   4893:     end of the logical line.</p>
                   4894: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4895:     the only way to create a variable consisting of a single backslash
                   4896:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4897: <p>So far for defining variables. The other thing you can do with
                   4898:     variables is evaluating them. A variable is evaluated when it is
                   4899:     part of the right side of the ``:='' or the ``!='' operator, or
                   4900:     directly before executing a shell command which the variable is part
1.29      dholland 4901:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.1       dsieger  4902:     is, variables are not evaluated until there's no other way. The
                   4903:     ``modifiers'' mentioned in the man page also evaluate the
                   4904:     variable.</p>
                   4905: <p>Some of the modifiers split the string into words and then
                   4906:     operate on the words, others operate on the string as a whole. When
                   4907:     a string is split into words, it is split as you would expect
1.29      dholland 4908:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.14      jmcneill 4909: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.1       dsieger  4910:     loop does not follow the shell quoting rules but splits at sequences
                   4911:     of whitespace.</p>
                   4912: <p>There are several types of variables that should be handled
                   4913:     differently. Strings and two types of lists.</p>
1.23      wiz      4914: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4915: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1       dsieger  4916:       characters. Nevertheless, you should restrict yourself to only
                   4917:       using printable characters. Examples are
                   4918:       <code class="varname">PREFIX</code> and
                   4919:       <code class="varname">COMMENT</code>.</p></li>
1.23      wiz      4920: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1       dsieger  4921:       are never exported to any shell command. Their elements are
                   4922:       separated by whitespace. Therefore, the elements themselves cannot
                   4923:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4924:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4925:       Examples are <code class="varname">DEPENDS</code> and
                   4926:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23      wiz      4927: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1       dsieger  4928:       may be exported to a shell command. Their elements can contain any
                   4929:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4930:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4931:       <code class="varname">DISTFILES</code> and
                   4932:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4933: </ul></div>
1.23      wiz      4934: <div class="sect2" title="12.2.1. Naming conventions">
1.1       dsieger  4935: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4936: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.23      wiz      4937: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4938: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4939:        are reserved for use by the pkgsrc infrastructure. They shall
                   4940:        not be used by package
                   4941:        <code class="filename">Makefile</code>s.</p></li>
1.23      wiz      4942: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4943:        lowercase variable names for the iteration
                   4944:        variables.</p></li>
1.23      wiz      4945: <li class="listitem"><p>All list variables should have a ``plural''
1.1       dsieger  4946:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4947:        <code class="varname">DISTFILES</code>.</p></li>
                   4948: </ul></div>
                   4949: </div>
                   4950: </div>
1.23      wiz      4951: <div class="sect1" title="12.3. Code snippets">
1.1       dsieger  4952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4953: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  4954: <p>This section presents you with some code snippets you should
                   4955:     use in your own code. If you don't find anything appropriate here,
                   4956:     you should test your code and add it here.</p>
1.23      wiz      4957: <div class="sect2" title="12.3.1. Adding things to a list">
1.1       dsieger  4958: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4959: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  4960: <pre class="programlisting">
                   4961: STRING=                 foo * bar `date`
                   4962: INT_LIST=               # empty
                   4963: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4964: EXT_LIST=               # empty
                   4965: ANOTHER_EXT_LIST=       a=b c=d
                   4966: 
                   4967: INT_LIST+=              ${STRING}               # 1
                   4968: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4969: EXT_LIST+=              ${STRING:Q}             # 3
                   4970: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   4971: </pre>
                   4972: <p>When you add a string to an external list (example 3), it
                   4973:       must be quoted. In all other cases, you must not add a quoting
                   4974:       level. You must not merge internal and external lists, unless you
                   4975:       are sure that all entries are correctly interpreted in both
                   4976:       lists.</p>
                   4977: </div>
1.23      wiz      4978: <div class="sect2" title="12.3.2. Converting an internal list into an external list">
1.1       dsieger  4979: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4980: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1       dsieger  4981: <pre class="programlisting">
                   4982: EXT_LIST=       # empty
                   4983: .for i in ${INT_LIST}
                   4984: EXT_LIST+=      ${i:Q}""
                   4985: .endfor
                   4986: </pre>
                   4987: <p>This code converts the internal list
                   4988:       <code class="varname">INT_LIST</code> into the external list
                   4989:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4990:       are unquoted they must be quoted here. The reason for appending
                   4991:       <code class="varname">""</code> is explained below.</p>
                   4992: </div>
1.23      wiz      4993: <div class="sect2" title="12.3.3. Passing variables to a shell command">
1.1       dsieger  4994: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4995: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  4996: <p>Sometimes you may want to print an arbitrary string. There
                   4997:        are many ways to get it wrong and only few that can handle every
                   4998:        nastiness.</p>
                   4999: <pre class="programlisting">
                   5000: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5001: EXT_LIST=       string=${STRING:Q} x=second\ item
                   5002: 
                   5003: all:
                   5004:         echo ${STRING}                  # 1
                   5005:         echo "${STRING}"                # 2
                   5006:         echo "${STRING:Q}"              # 3
                   5007:         echo ${STRING:Q}                # 4
                   5008:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5009:         printf "%s\\n" ${STRING:Q}""    # 6
                   5010:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   5011: </pre>
                   5012: <p>Example 1 leads to a syntax error in the shell, as the
                   5013:       characters are just copied.</p>
                   5014: <p>Example 2 leads to a syntax error too, and if you leave out
                   5015:       the last " character from <code class="varname">${STRING}</code>,
1.29      dholland 5016:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.1       dsieger  5017:       variable would be evaluated, too.</p>
                   5018: <p>Example 3 outputs each space character preceded by a
                   5019:       backslash (or not), depending on the implementation of the
1.29      dholland 5020:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.1       dsieger  5021: <p>Example 4 handles correctly every string that does not start
                   5022:       with a dash. In that case, the result depends on the
1.29      dholland 5023:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.1       dsieger  5024:       guarantee that your input does not start with a dash, this form is
                   5025:       appropriate.</p>
                   5026: <p>Example 5 handles even the case of a leading dash
                   5027:       correctly.</p>
                   5028: <p>Example 6 also works with every string and is the
                   5029:       light-weight solution, since it does not involve a pipe, which has
                   5030:       its own problems.</p>
                   5031: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5032:       because the quoting has already been done when adding elements to
                   5033:       the list.</p>
                   5034: <p>As internal lists shall not be passed to the shell, there is
                   5035:       no example for it.</p>
                   5036: </div>
1.23      wiz      5037: <div class="sect2" title="12.3.4. Quoting guideline">
1.1       dsieger  5038: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5039: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  5040: <p>There are many possible sources of wrongly quoted variables.
                   5041:       This section lists some of the commonly known ones.</p>
1.23      wiz      5042: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5043: <li class="listitem">
1.1       dsieger  5044: <p>Whenever you use the value of a list, think
                   5045:        about what happens to leading or trailing whitespace. If the
                   5046:        list is a well-formed shell expression, you can apply the
                   5047:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5048:        whitespace from each word. The <code class="varname">:M</code> operator
                   5049:        first splits its argument according to the rules of the shell,
                   5050:        and then creates a new list consisting of all words that match
                   5051:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5052:        One class of situations where this is needed is when adding a
                   5053:        variable like <code class="varname">CPPFLAGS</code> to
                   5054:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5055:        invokes other configure scripts, it strips the leading and
                   5056:        trailing whitespace from the variable and then passes it to the
                   5057:        other configure scripts. But these configure scripts expect the
                   5058:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5059:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5060:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5061:        here is how we do it:</p>
                   5062: <pre class="programlisting">
                   5063: CPPFLAGS=               # empty
                   5064: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5065: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5066: 
                   5067: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5068: 
                   5069: all:
                   5070:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5071:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   5072: </pre>
                   5073: </li>
1.23      wiz      5074: <li class="listitem"><p>The example above contains one bug: The
1.1       dsieger  5075:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5076:        expression, but there is the C compiler after it, which also
                   5077:        expects a properly quoted string (this time in C syntax). The
                   5078:        version above is therefore only correct if
                   5079:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5080:        or double quotes. If you want to allow these, you have to add
                   5081:        another layer of quoting to each variable that is used as a C
                   5082:        string literal. You cannot use the <code class="varname">:Q</code>
                   5083:        operator for it, as this operator only works for the
                   5084:        shell.</p></li>
1.23      wiz      5085: <li class="listitem">
1.1       dsieger  5086: <p>Whenever a variable can be empty, the
                   5087:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5088:        are two completely different cases which can be solved with the
                   5089:        same trick.</p>
                   5090: <pre class="programlisting">
                   5091: EMPTY=                  # empty
                   5092: empty_test:
                   5093:         for i in a ${EMPTY:Q} c; do \
                   5094:             echo "$$i"; \
                   5095:         done
                   5096: 
                   5097: for_test:
                   5098: .for i in a:\ a:\test.txt
                   5099:         echo ${i:Q}
                   5100:         echo "foo"
                   5101: .endfor
                   5102: </pre>
                   5103: <p>The first example will only print two of the three lines
                   5104:        we might have expected. This is because
                   5105:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5106:        the shell cannot see. The workaround is to write
                   5107:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5108:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5109:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5110: <p>The second example will only print three lines instead of
                   5111:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5112:        This is because the backslash of the value
                   5113:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29      dholland 5114:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5115:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.1       dsieger  5116:        <code class="varname">${i:Q}""</code>.</p>
                   5117: </li>
                   5118: </ul></div>
                   5119: </div>
1.23      wiz      5120: <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
1.1       dsieger  5121: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5122: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5123: <p>The pkgsrc bmake program does not handle the following
                   5124:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5125:       contains a ``-'' character, one of the closing braces is included
                   5126:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5127: <pre class="programlisting">
                   5128: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5129: </pre>
                   5130: <p>For a more complex code snippet and a workaround, see the
                   5131:       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
                   5132:       <code class="varname">bug1</code>.</p>
                   5133: </div>
                   5134: </div>
                   5135: </div>
1.23      wiz      5136: <div class="chapter" title="Chapter 13. PLIST issues">
1.1       dsieger  5137: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5138: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5139: <div class="toc">
                   5140: <p><b>Table of Contents</b></p>
                   5141: <dl>
1.6       rillig   5142: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      5143: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5144: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6       rillig   5145: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5146: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      5147: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6       rillig   5148: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5149: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5150: </dl>
                   5151: </div>
                   5152: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      5153:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  5154:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5155:   directory it's been installed in) plus some additional statements
1.29      dholland 5156:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1       dsieger  5157:   This chapter addresses some issues that need attention when
                   5158:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5159:   below!).</p>
1.23      wiz      5160: <div class="sect1" title="13.1. RCS ID">
1.1       dsieger  5161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5162: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5163: <p>Be sure to add a RCS ID line as the first thing in any
                   5164:     <code class="filename">PLIST</code> file you write:</p>
                   5165: <pre class="programlisting">
                   5166: @comment $NetBSD$
                   5167:     </pre>
                   5168: </div>
1.23      wiz      5169: <div class="sect1" title="13.2. Semi-automatic PLIST generation">
1.1       dsieger  5170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5171: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  5172: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  5173:     to output a PLIST that matches any new files since the package
1.10      hubertf  5174:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.1       dsieger  5175:     more information on this target.</p>
                   5176: </div>
1.23      wiz      5177: <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
1.1       dsieger  5178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  5179: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  5180: </h2></div></div></div>
                   5181: <p>If you have used any of the *-dirs packages, as explained in
1.10      hubertf  5182:     <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
                   5183:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1       dsieger  5184:     <code class="varname">@comment</code>s instead of real
                   5185:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5186:     specific directories and files, so that the results of that
                   5187:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5188:     lot</em></span> during the update of packages.</p>
                   5189: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5190:     of AWK patterns and actions that are used to filter the output of
                   5191:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5192:     scripting you like to it, but be careful with quoting.</p>
                   5193: <p>For example, to get all files inside the
                   5194:     <code class="filename">libdata/foo</code> directory removed from the
                   5195:     resulting PLIST:</p>
                   5196: <pre class="programlisting">
                   5197: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5198:     </pre>
                   5199: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5200:     to a specific (shared) directory converted to
                   5201:     <code class="varname">@comment</code>s:</p>
                   5202: <pre class="programlisting">
                   5203: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5204:     </pre>
                   5205: </div>
1.23      wiz      5206: <div class="sect1" title="13.4. Variable substitution in PLIST">
1.1       dsieger  5207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5208: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5209: <p>A number of variables are substituted automatically in
                   5210:     PLISTs when a package is installed on a system. This includes the
                   5211:     following variables:</p>
                   5212: <div class="variablelist"><dl>
                   5213: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5214: <dd>
                   5215: <p>Some packages like emacs and perl embed information
                   5216:          about which architecture they were built on into the
                   5217:          pathnames where they install their files. To handle this
                   5218:          case, PLIST will be preprocessed before actually used, and
                   5219:          the symbol
1.23      wiz      5220:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  5221:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  5222:          same is done if the string
                   5223:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5224:          PLIST somewhere - use this on packages that have GNU
                   5225:          autoconf-created configure scripts.</p>
1.23      wiz      5226: <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  5227: <h3 class="title">Legacy note</h3>
                   5228: <p>There used to be a symbol
1.23      wiz      5229:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  5230:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  5231:            -m</strong></span>, but that's no longer supported and has
                   5232:            been removed.</p>
                   5233: </div>
                   5234: </dd>
                   5235: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5236: <dd>
                   5237: <p>Some packages want to embed the OS name and version
                   5238:          into some paths.  To do this, use these variables in the
                   5239:          <code class="filename">PLIST</code>:
                   5240:          </p>
1.23      wiz      5241: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5242: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</span></p></li>
                   5243: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">&#8220;<span class="quote">solaris</span>&#8221;</span>)</p></li>
                   5244: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
1.1       dsieger  5245: </ul></div>
                   5246: </dd>
                   5247: </dl></div>
                   5248: <p>For a complete list of values which are replaced by
                   5249:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5250:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5251: <p>If you want to change other variables not listed above, you
                   5252:     can add variables and their expansions to this variable in the
1.10      hubertf  5253:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.1       dsieger  5254: <pre class="programlisting">
                   5255: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5256:     </pre>
1.23      wiz      5257: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  5258:     in the <code class="filename">PLIST</code> with
1.23      wiz      5259:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      5260: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   5261:     the common case of conditionally including some
                   5262:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5263:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   5264:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5265:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      5266:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      5267:     in the <code class="filename">PLIST</code> with either
1.23      wiz      5268:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5269:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      5270:     For example, in <code class="filename">Makefile</code>:</p>
                   5271: <pre class="programlisting">
                   5272: PLIST_VARS+=   foo
                   5273: .if <em class="replaceable"><code>condition</code></em>
                   5274: PLIST.foo=     yes
                   5275: .else
                   5276:     </pre>
                   5277: <p>And then in <code class="filename">PLIST</code>:</p>
                   5278: <pre class="programlisting">
                   5279: @comment $NetBSD$
                   5280: bin/bar
                   5281: man/man1/bar.1
                   5282: ${PLIST.foo}bin/foo
                   5283: ${PLIST.foo}man/man1/foo.1
                   5284: ${PLIST.foo}share/bar/foo.data
                   5285: ${PLIST.foo}@dirrm share/bar
                   5286:     </pre>
1.1       dsieger  5287: </div>
1.23      wiz      5288: <div class="sect1" title="13.5. Man page compression">
1.1       dsieger  5289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5290: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5291: <p>Man pages should be installed in compressed form if
                   5292:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5293:     and uncompressed otherwise. To handle this in the
1.23      wiz      5294:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  5295:     appended/removed automatically for man pages according to
                   5296:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5297:     or not, see above for details. This modification of the
                   5298:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5299:     <code class="filename">PLIST</code> itself.</p>
                   5300: </div>
1.23      wiz      5301: <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
1.1       dsieger  5302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5303: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5304: </h2></div></div></div>
                   5305: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5306:     in generating the binary package, set the variable
                   5307:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29      dholland 5308:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1       dsieger  5309:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5310:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5311: </div>
1.23      wiz      5312: <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
1.1       dsieger  5313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5314: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5315: <p>Some packages decide to install a different set of files based on
                   5316:     the operating system being used. These differences can be
                   5317:     automatically handled by using the following files:</p>
1.23      wiz      5318: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5319: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5320: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5321: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5322: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5323: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  5324: </ul></div>
                   5325: </div>
1.23      wiz      5326: <div class="sect1" title="13.8. Sharing directories between packages">
1.1       dsieger  5327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5328: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23      wiz      5329: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  5330:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 5331:     directories were problematic because you had to add special
                   5332:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  5333:     centralized package handle them.</p>
1.22      jakllsch 5334: <p>In pkgsrc, it is now easy: Each package should create
                   5335:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5336:     will remove any directories left empty after uninstalling a
                   5337:     package.</p>
                   5338: <p>If a package needs an empty directory to work, create
                   5339:     the directory during installation as usual, and also add an
                   5340:     entry to the PLIST:
                   5341:     </p>
1.1       dsieger  5342: <pre class="programlisting">
1.22      jakllsch 5343: @pkgdir path/to/empty/directory
1.1       dsieger  5344:     </pre>
1.22      jakllsch 5345: <p>
                   5346:     </p>
1.1       dsieger  5347: </div>
                   5348: </div>
1.23      wiz      5349: <div class="chapter" title="Chapter 14. Buildlink methodology">
1.1       dsieger  5350: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5351: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5352: <div class="toc">
                   5353: <p><b>Table of Contents</b></p>
                   5354: <dl>
1.6       rillig   5355: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      5356: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5357: <dd><dl>
1.6       rillig   5358: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      5359: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5360:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5361:       and
                   5362:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5363:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5364: </dl></dd>
1.23      wiz      5365: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1       dsieger  5366: <dd><dl>
1.23      wiz      5367: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6       rillig   5368: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1       dsieger  5369: </dl></dd>
                   5370: </dl>
                   5371: </div>
                   5372: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5373:   are seen by a package's configure and build processes.  This is implemented
                   5374:   in a two step process:</p>
1.23      wiz      5375: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5376: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  5377:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5378:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      5379: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  5380:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5381:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5382:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5383:       native compiler on some operating systems look like GCC, so that
                   5384:       packages that expect GCC won't require modifications to build with
                   5385:       those native compilers.</p></li>
                   5386: </ol></div>
                   5387: <p>This normalizes the environment in which a package is built so that the
                   5388:   package may be built consistently despite what other software may be
                   5389:   installed. Please note that the normal system header and library paths,
                   5390:   e.g. <code class="filename">/usr/include</code>,
                   5391:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5392:   designed to insulate the package build from non-system-supplied
                   5393:   software.</p>
1.23      wiz      5394: <div class="sect1" title="14.1. Converting packages to use buildlink3">
1.1       dsieger  5395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5396: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5397: <p>The process of converting packages to use the buildlink3
1.23      wiz      5398:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  5399:     The things to keep in mind are:</p>
1.23      wiz      5400: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5401: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  5402:        instead of the actual toolchain.  Some packages are tricky,
                   5403:        and the only way to know for sure is the check
                   5404:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5405:        wrappers are being invoked.</p></li>
1.23      wiz      5406: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  5407:        the package Makefile, e.g. Java VMs, standalone shells,
                   5408:        etc., because the code to symlink files into
                   5409:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      5410:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.1       dsieger  5411:        </p></li>
1.23      wiz      5412: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  5413:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5414:        package's Makefile are added as dependencies for that package.
                   5415:        </p></li>
                   5416: </ol></div>
                   5417: <p>If a dependency on a particular package is required for its libraries and
                   5418:     headers, then we replace:</p>
                   5419: <pre class="programlisting">
                   5420: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5421: </pre>
                   5422: <p>with</p>
                   5423: <pre class="programlisting">
                   5424: .include "../../category/foo/buildlink3.mk"
                   5425: </pre>
                   5426: <p>The buildlink3.mk files usually define the required dependencies.
                   5427:     If you need a newer version of the dependency when using buildlink3.mk
                   5428:     files, then you can define it in your Makefile; for example:</p>
                   5429: <pre class="programlisting">
                   5430: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5431: .include "../../category/foo/buildlink3.mk"
                   5432: </pre>
                   5433: <p>There are several <code class="filename">buildlink3.mk</code>
                   5434:     files in <code class="filename">pkgsrc/mk</code>
                   5435:     that handle special package issues:</p>
1.23      wiz      5436: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5437: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  5438:        the native or a pkgsrc Berkeley DB implementation based on
                   5439:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5440:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      5441: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  5442:        comes with neither Curses nor NCurses, this will take care
                   5443:        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.23      wiz      5444: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  5445:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5446:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5447:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      5448: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  5449:        system-provided Motif installation or adds a dependency on
                   5450:        <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.23      wiz      5451:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   5452:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, or <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.1       dsieger  5453:        which Motif version will be used.</p></li>
1.23      wiz      5454: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  5455:        variables that may be used by packages that use the
                   5456:        Open Sound System (OSS) API.</p></li>
1.23      wiz      5457: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35      wiz      5458:        any of the Postgres versions in the variable
                   5459:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   5460:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1       dsieger  5461:        the file for more information.</p></li>
1.23      wiz      5462: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  5463:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5464:        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.23      wiz      5465: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  5466:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5467:        library.</p></li>
                   5468: </ul></div>
                   5469: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5470:     files provide a more complete
                   5471:     description of how to use them properly.</p>
                   5472: </div>
1.23      wiz      5473: <div class="sect1" title="14.2. Writing buildlink3.mk files">
1.1       dsieger  5474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5475: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5476: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5477:     included by Makefiles to indicate the need to compile and link
                   5478:     against header files and libraries provided by the package.  A
                   5479:     <code class="filename">buildlink3.mk</code> file should always provide
                   5480:     enough information to add the correct type of dependency
                   5481:     relationship and include any other
                   5482:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5483:     headers and libraries that it needs in turn.</p>
                   5484: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5485:     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>
                   5486:     package is highly recommended.  For most packages, the following
                   5487:     command will generate a good starting point for
                   5488:     <code class="filename">buildlink3.mk</code> files:</p>
                   5489: <pre class="screen">
                   5490: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5491: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5492:     </pre>
1.23      wiz      5493: <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
1.1       dsieger  5494: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5495: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5496: <p>The following real-life example
                   5497:       <code class="filename">buildlink3.mk</code> is taken
                   5498:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5499: <pre class="programlisting">
1.18      snj      5500: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  5501: 
1.18      snj      5502: BUILDLINK_TREE+=       tiff
1.1       dsieger  5503: 
1.18      snj      5504: .if !defined(TIFF_BUILDLINK3_MK)
                   5505: TIFF_BUILDLINK3_MK:=
1.1       dsieger  5506: 
1.18      snj      5507: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5508: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5509: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.1       dsieger  5510: 
                   5511: .include "../../devel/zlib/buildlink3.mk"
                   5512: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      5513: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  5514: 
1.18      snj      5515: BUILDLINK_TREE+=       -tiff
1.1       dsieger  5516: </pre>
                   5517: <p>The header and footer manipulate
1.18      snj      5518:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  5519:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      5520:       the dependency tree.</p>
                   5521: <p>The main section is protected from multiple inclusion
1.1       dsieger  5522:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5523:       added.  Several important variables are set in the section:</p>
1.23      wiz      5524: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5525: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5526:          is the actual dependency recorded in the installed
                   5527:          package; this should always be set using
1.10      hubertf  5528:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  5529:          we're appending to any pre-existing list of values.  This
                   5530:          variable should be set to the first version of the
1.26      wiz      5531:          package that had an backwards-incompatible API change.
1.1       dsieger  5532:          </p></li>
1.23      wiz      5533: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5534:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5535:          pkgsrc directory.</p></li>
1.23      wiz      5536: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5537:          (not shown above) controls whether we use
                   5538:          <code class="varname">BUILD_DEPENDS</code> or
                   5539:          <code class="varname">DEPENDS</code> to add the dependency on
                   5540:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5541:          selected by setting
                   5542:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5543:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  5544:          used.</p></li>
1.23      wiz      5545: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5546:            and
                   5547:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5548:            (not shown above) are lists of subdirectories of
                   5549:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5550:            to add to the header and library search paths.  These
1.23      wiz      5551:            default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
1.1       dsieger  5552:          respectively.</p></li>
1.23      wiz      5553: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5554:            (not shown above) is the list of preprocessor flags to add
                   5555:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      5556:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  5557:            should be avoided and instead be handled using
                   5558:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5559:          above.</p></li>
                   5560: </ul></div>
                   5561: <p>The following variables are all optionally defined within
                   5562:       this second section (protected against multiple inclusion) and
                   5563:       control which package files are symlinked into
                   5564:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5565:       transformed during the symlinking:</p>
1.23      wiz      5566: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5567: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5568:            (not shown above) is a shell glob pattern relative to
                   5569:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5570:            to be symlinked into
                   5571:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5572:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      5573: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5574:            (not shown above) is a shell pipeline that
                   5575:            outputs to stdout a list of files relative to
                   5576:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5577:            The resulting files are to be symlinked
                   5578:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5579:            this takes the <code class="filename">+CONTENTS</code> of a
                   5580:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5581:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      5582: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5583:            (not shown above) is a filter command that filters
                   5584:            <code class="filename">+CONTENTS</code> input into a list of files
                   5585:            relative to
                   5586:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5587:            on stdout.  By default for overwrite packages,
                   5588:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5589:            outputs the contents of the <code class="filename">include</code>
                   5590:            and <code class="filename">lib</code> directories in the package
                   5591:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5592:            it outputs any libtool archives in
                   5593:            <code class="filename">lib</code> directories.</p></li>
1.23      wiz      5594: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5595:            (not shown above) is a list of sed arguments used to
                   5596:            transform the name of the source filename into a
1.10      hubertf  5597:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  5598:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5599: </ul></div>
1.18      snj      5600: <p>This section can additionally include any
1.1       dsieger  5601:       <code class="filename">buildlink3.mk</code> needed for
                   5602:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5603:       Including these <code class="filename">buildlink3.mk</code> files
                   5604:       means that the headers and libraries for these
                   5605:       dependencies are also symlinked into
                   5606:       <code class="filename">${BUILDLINK_DIR}</code>
                   5607:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5608:       <code class="filename">buildlink3.mk</code>
1.18      snj      5609:       file is included. Dependencies are only added for directly
                   5610:       include <code class="filename">buildlink3.mk</code> files.</p>
1.1       dsieger  5611: </div>
1.26      wiz      5612: <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files">
1.1       dsieger  5613: <div class="titlepage"><div><div><h3 class="title">
1.26      wiz      5614: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1       dsieger  5615:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5616:       and
                   5617:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5618:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5619: <p>These two variables differ in that one describes source
                   5620:       compatibility (API) and the other binary compatibility (ABI).
                   5621:       The difference is that a change in the API breaks compilation of
                   5622:       programs while changes in the ABI stop compiled programs from
                   5623:       running.</p>
                   5624: <p>Changes to the
1.27      wiz      5625:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5626:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5627:       very rarely. One possible reason is that all packages depending
                   5628:       on this already need a newer version. In case it is bumped see
                   5629:       the description below.</p>
                   5630: <p>The most common example of an ABI change is that the major
                   5631:       version of a shared library is increased. In this case,
                   5632:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5633:       should be adjusted to require at least the new package version.
                   5634:       Then the packages that depend on this package need their
                   5635:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5636:       <code class="filename">buildlink3.mk</code> files, their
                   5637:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5638:       adjusted, too. This is needed so pkgsrc will require the correct
                   5639:       package dependency and not settle for an older one when building
                   5640:       the source.</p>
1.10      hubertf  5641: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.26      wiz      5642:       more information about dependencies on other packages,
                   5643:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  5644:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5645: <p>Please take careful consideration before adjusting
                   5646:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5647:       or
                   5648:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5649:       as we don't want to cause unneeded package deletions and
                   5650:       rebuilds.  In many cases, new versions of packages work just
                   5651:       fine with older dependencies.</p>
                   5652: <p>Also it is not needed to set
1.26      wiz      5653:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5654:       when it is identical to
1.1       dsieger  5655:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5656: </div>
                   5657: </div>
1.23      wiz      5658: <div class="sect1" title="14.3. Writing builtin.mk files">
1.1       dsieger  5659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5660: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5661: <p>Some packages in pkgsrc install headers and libraries that
                   5662:       coincide with headers and libraries present in the base system.
                   5663:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5664:       packages should also include a <code class="filename">builtin.mk</code>
                   5665:       file that includes the necessary checks to decide whether using
                   5666:       the built-in software or the pkgsrc software is
                   5667:     appropriate.</p>
                   5668: <p>The only requirements of a builtin.mk file for
                   5669:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      5670: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5671: <li class="listitem"><p>It should set
1.1       dsieger  5672:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5673:        to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
1.1       dsieger  5674:        after it is included.</p></li>
1.23      wiz      5675: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  5676:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5677:        which is already set before the
                   5678:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      5679: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  5680:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5681:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5682: </ol></div>
1.23      wiz      5683: <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
1.1       dsieger  5684: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5685: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1       dsieger  5686: <p>The following is the recommended template for builtin.mk
                   5687:       files:</p>
                   5688: <pre class="programlisting">
                   5689: .if !defined(IS_BUILTIN.foo)
                   5690: #
                   5691: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5692: # genuinely exists in the system or not.
                   5693: #
                   5694: IS_BUILTIN.foo?=        no
                   5695: 
                   5696: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5697: # version can be determined.
                   5698: #
                   5699: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5700: BUILTIN_PKG.foo?=       foo-1.0
                   5701: .  endif
                   5702: .endif  # IS_BUILTIN.foo
                   5703: 
                   5704: .if !defined(USE_BUILTIN.foo)
                   5705: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5706: .  if defined(BUILTIN_PKG.foo)
                   5707: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5708: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5709: USE_BUILTIN.foo!=                                                       \
                   5710:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5711:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5712: .      endif
                   5713: .    endfor
                   5714: .  endif
                   5715: .endif  # USE_BUILTIN.foo
                   5716: 
                   5717: CHECK_BUILTIN.foo?=     no
                   5718: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5719: #
                   5720: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5721: # "yes" or "no".
                   5722: #
                   5723: .endif  # CHECK_BUILTIN.foo
                   5724: </pre>
                   5725: <p>The first section sets
                   5726:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5727:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5728:       in the base system.  This should not be a base system software
                   5729:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      5730:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  5731:       included as part of the base system.  This variable is only
                   5732:       used internally within the <code class="filename">builtin.mk</code>
                   5733:       file.</p>
                   5734: <p>The second section sets
                   5735:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5736:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5737:       system if it exists (if
                   5738:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5739:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  5740:       within the <code class="filename">builtin.mk</code> file.</p>
                   5741: <p>The third section sets
                   5742:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5743:       and is <span class="emphasis"><em>required</em></span> in all
                   5744:       <code class="filename">builtin.mk</code> files.  The code in this
                   5745:       section must make the determination whether the built-in
                   5746:       software is adequate to satisfy the dependencies listed in
                   5747:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5748:       This is typically done by comparing
                   5749:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5750:       against each of the dependencies in
                   5751:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5752:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5753:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5754:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5755:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5756:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5757:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5758:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5759:       that the built-in version of the software is similar enough to
                   5760:       be used as a replacement.</p>
                   5761: <p>The last section is guarded by
                   5762:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5763:       and includes code that uses the value of
                   5764:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5765:       set in the previous section.  This typically includes, e.g.,
                   5766:       adding additional dependency restrictions and listing additional
                   5767:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5768:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5769: </div>
1.23      wiz      5770: <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
1.1       dsieger  5771: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5772: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5773: <p>When building packages, it's possible to choose whether to set
                   5774:        a global preference for using either the built-in (native)
                   5775:        version or the pkgsrc version of software to satisfy a
                   5776:        dependency.  This is controlled by setting
                   5777:        <code class="varname">PREFER_PKGSRC</code> and
                   5778:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5779:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
1.1       dsieger  5780:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5781:        use the pkgsrc versions of software, while
                   5782:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5783:        built-in versions.  Preferences are determined by the most
                   5784:        specific instance of the package in either
                   5785:        <code class="varname">PREFER_PKGSRC</code> or
                   5786:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5787:        in neither or in both variables, then
                   5788:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5789:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5790:        using pkgsrc versions of software for all but the most basic
                   5791:       bits on a NetBSD system, you can set:</p>
                   5792: <pre class="programlisting">
                   5793: PREFER_PKGSRC=  yes
                   5794: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5795: </pre>
                   5796: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5797:       <code class="filename">builtin.mk</code>
                   5798:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5799:       otherwise it is simply ignored in that list.</p>
                   5800: </div>
                   5801: </div>
                   5802: </div>
1.23      wiz      5803: <div class="chapter" title="Chapter 15. The pkginstall framework">
1.1       dsieger  5804: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5805: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5806: <div class="toc">
                   5807: <p><b>Table of Contents</b></p>
                   5808: <dl>
1.6       rillig   5809: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1       dsieger  5810: <dd><dl>
1.6       rillig   5811: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5812: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5813: </dl></dd>
1.6       rillig   5814: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5815: <dd><dl>
1.23      wiz      5816: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6       rillig   5817: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5818: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5819: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5820: </dl></dd>
                   5821: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5822: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5823: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5824: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5825: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5826: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5827: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1       dsieger  5828: </dl>
                   5829: </div>
                   5830: <p>This chapter describes the framework known as
                   5831: <code class="literal">pkginstall</code>, whose key features are:</p>
1.23      wiz      5832: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5833: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5834:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5835: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5836:     provided that packages are correctly designed.</p></li>
1.23      wiz      5837: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5838: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5839: <li class="listitem"><p>Registration of system shells.</p></li>
                   5840: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5841: </ul></div>
                   5842: <p>The following sections inspect each of the above points in detail.</p>
                   5843: <p>You may be thinking that many of the things described here could be
                   5844: easily done with simple code in the package's post-installation target
                   5845: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5846: as the code in them is only executed when building from source.  Machines
                   5847: using binary packages could not benefit from it at all (as the code itself
                   5848: could be unavailable).  Therefore, the only way to achieve any of the items
                   5849: described above is by means of the installation scripts, which are
                   5850: automatically generated by pkginstall.</p>
1.23      wiz      5851: <div class="sect1" title="15.1. Files and directories outside the installation prefix">
1.1       dsieger  5852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5853: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5854: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5855: of files and directories that belong to a package.  The names used in it
                   5856: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5857: which means that it cannot register files outside this directory (absolute
                   5858: path names are not allowed).  Despite this restriction, some packages need
                   5859: to install files outside this location; e.g., under
                   5860: <code class="filename">${VARBASE}</code> or
                   5861: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5862: is to create such files during installation time by using
                   5863: installation scripts.</p>
                   5864: <p>The generic installation scripts are shell scripts that can
                   5865: contain arbitrary code.  The list of scripts to execute is taken from
                   5866: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5867: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5868: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5869: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5870: commands, so they have the potential to create and manage files
                   5871: anywhere in the file system.</p>
                   5872: <p>Using these general installation files is not recommended, but
                   5873: may be needed in some special cases.  One reason for avoiding them is
                   5874: that the user has to trust the packager that there is no unwanted or
                   5875: simply erroneous code included in the installation script. Also,
                   5876: previously there were many similar scripts for the same functionality,
                   5877: and fixing a common error involved finding and changing all of
                   5878: them.</p>
                   5879: <p>The pkginstall framework offers another, standardized way.  It
                   5880: provides generic scripts to abstract the manipulation of such files
                   5881: and directories based on variables set in the package's
                   5882: <code class="filename">Makefile</code>.  The rest of this section describes
                   5883: these variables.</p>
1.23      wiz      5884: <div class="sect2" title="15.1.1. Directory manipulation">
1.1       dsieger  5885: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5886: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5887: <p>The following variables can be set to request the creation of
                   5888: directories anywhere in the file system:</p>
1.23      wiz      5889: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5890: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5891:     contain a list of directories that should be created and should attempt
                   5892:     to be destroyed by the installation scripts.  The difference between
                   5893:     the two is that the latter prompts the administrator to remove any
                   5894:     directories that may be left after deinstallation (because they were
                   5895:     not empty), while the former does not.</p></li>
1.23      wiz      5896: <li class="listitem">
1.1       dsieger  5897: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5898:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5899:     which directories should be created and should attempt to be destroyed
                   5900:     by the installation scripts.  Each tuple holds the following values,
                   5901:     separated by spaces: the directory name, its owner, its group and its
                   5902:     numerical mode.  For example:</p>
                   5903: <pre class="programlisting">
                   5904: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5905: </pre>
                   5906: <p>The difference between the two is exactly the same as their
                   5907:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5908: </li>
                   5909: </ul></div>
                   5910: </div>
1.23      wiz      5911: <div class="sect2" title="15.1.2. File manipulation">
1.1       dsieger  5912: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5913: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5914: <p>Creating non-empty files outside the installation prefix is tricky
                   5915: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5916: To overcome this problem, the only solution is to extract the file in the
                   5917: known place (i.e., inside the installation prefix) and copy it to the
                   5918: appropriate location during installation (done by the installation scripts
                   5919: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5920: file</em></span> in the following paragraphs, which describe the variables
                   5921: that can be used to automatically and consistently handle files outside the
                   5922: installation prefix:</p>
1.23      wiz      5923: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5924: <li class="listitem">
1.1       dsieger  5925: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      5926:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5927:     During installation time, the master file is copied to the target one
                   5928:     if and only if the latter does not exist.  Upon deinstallation, the
                   5929:     target file is removed provided that it was not modified by the
                   5930:     installation.</p>
                   5931: <p>The difference between the two is that the latter prompts the
                   5932:     administrator to remove any files that may be left after
                   5933:     deinstallation (because they were not empty), while the former does
                   5934:     not.</p>
                   5935: </li>
1.23      wiz      5936: <li class="listitem">
1.1       dsieger  5937: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      5938:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5939:     files as well as their target locations.  For each of them, it also
                   5940:     specifies their owner, their group and their numeric permissions, in
                   5941:     this order.  For example:</p>
                   5942: <pre class="programlisting">
1.30      wiz      5943: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       dsieger  5944: </pre>
                   5945: <p>The difference between the two is exactly the same as their
                   5946:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5947: </li>
                   5948: </ul></div>
                   5949: </div>
                   5950: </div>
1.23      wiz      5951: <div class="sect1" title="15.2. Configuration files">
1.1       dsieger  5952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5953: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  5954: <p>Configuration files are special in the sense that they are installed
                   5955: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5956: need special treatment during installation (most of which is automated by
                   5957: pkginstall).  The main concept you must bear in mind is that files marked
                   5958: as configuration files are automatically copied to the right place (somewhere
                   5959: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5960: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5961: be removed if they have local modifications.  This ensures that
                   5962: administrators never lose any custom changes they may have made.</p>
1.23      wiz      5963: <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
1.1       dsieger  5964: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5965: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1       dsieger  5966: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5967: specifies where configuration files shall be installed.  Its contents are
                   5968: set based upon the following variables:</p>
1.23      wiz      5969: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5970: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5971:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5972:     be overridden by the user to point to his preferred location (e.g.,
                   5973:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5974:     Packages must not use it directly.</p></li>
1.23      wiz      5975: <li class="listitem">
1.1       dsieger  5976: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5977:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5978:     for the package being built shall be installed.  The definition of this
                   5979:     variable only makes sense in the package's
                   5980:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5981: <p>As an example, consider the Apache package,
                   5982:     <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
                   5983:     configuration files under the
                   5984:     <code class="filename">httpd/</code> subdirectory of
                   5985:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5986:     Makefile.</p>
                   5987: </li>
1.23      wiz      5988: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5989:     variable that holds this package's configuration directory (if
                   5990:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5991:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5992:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5993: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5994:     directory where the configuration files for the package identified by
                   5995:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5996: </ul></div>
                   5997: <p>Based on the above variables, pkginstall determines the value of
                   5998: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5999: variable that can be used within a package to refer to its configuration
                   6000: directory.  The algorithm used to set its value is basically the
                   6001: following:</p>
1.23      wiz      6002: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6003: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  6004:     its value is used.</p></li>
1.23      wiz      6005: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  6006:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6007:     <code class="filename">Makefile</code>, the resulting value is
                   6008:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      6009: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  6010:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6011: </ol></div>
                   6012: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  6013: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
                   6014: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6015: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  6016: </div>
1.23      wiz      6017: <div class="sect2" title="15.2.2. Telling the software where configuration files are">
1.1       dsieger  6018: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6019: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  6020: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6021: known place, you need to teach each package where it shall install its
                   6022: files.  In some cases you will have to patch the package Makefiles to
                   6023: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6024: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6025: generated files:</p>
                   6026: <pre class="programlisting">
                   6027: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   6028: </pre>
                   6029: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6030: for</em></span> its configuration files, not where they will be originally
                   6031: installed (although the difference is never explicit,
                   6032: unfortunately).</p>
                   6033: </div>
1.23      wiz      6034: <div class="sect2" title="15.2.3. Patching installations">
1.1       dsieger  6035: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6036: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  6037: <p>As said before, pkginstall automatically handles configuration files.
                   6038: This means that <span class="strong"><strong>the packages themselves must not
                   6039: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   6040: directly</strong></span>.  Bad news is that many software installation scripts
                   6041: will, out of the box, mess with the contents of that directory.  So what is
                   6042: the correct procedure to fix this issue?</p>
                   6043: <p>You must teach the package (usually by manually patching it) to
                   6044: install any configuration files under the examples hierarchy,
                   6045: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6046: <code class="filename">PLIST</code> registers them and the administrator always
                   6047: has the original copies available.</p>
                   6048: <p>Once the required configuration files are in place (i.e., under the
                   6049: examples hierarchy), the pkginstall framework can use them as master copies
                   6050: during the package installation to update what is in
                   6051: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   6052: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  6053: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.1       dsieger  6054: about their syntax and their purpose.  Here is an example, taken from the
                   6055: <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>
                   6056: <pre class="programlisting">
                   6057: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6058: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   6059: </pre>
                   6060: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6061: package and has no meaning outside it.</p>
                   6062: </div>
1.23      wiz      6063: <div class="sect2" title="15.2.4. Disabling handling of configuration files">
1.1       dsieger  6064: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6065: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  6066: <p>The automatic copying of config files can be toggled by setting the
                   6067: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6068: installation.</p>
                   6069: </div>
                   6070: </div>
1.23      wiz      6071: <div class="sect1" title="15.3. System startup scripts">
1.1       dsieger  6072: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6073: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  6074: <p>System startup scripts are special files because they must be
                   6075: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  6076: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.1       dsieger  6077: can be used.  However, pkginstall provides a special mechanism to handle
                   6078: these files.</p>
                   6079: <p>In order to provide system startup scripts, the package has
                   6080: to:</p>
1.23      wiz      6081: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6082: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  6083:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   6084:     <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
                   6085:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      6086: <li class="listitem">
1.1       dsieger  6087: <p>Tell pkginstall to handle it, appending the name of the script,
                   6088:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6089:     Continuing the previous example:</p>
                   6090: <pre class="programlisting">
                   6091: RCD_SCRIPTS+=   cupsd
                   6092: </pre>
                   6093: </li>
                   6094: </ol></div>
                   6095: <p>Once this is done, pkginstall will do the following steps for each
                   6096: script in an automated fashion:</p>
1.23      wiz      6097: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6098: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  6099:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6100:     variable.</p></li>
1.23      wiz      6101: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  6102:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6103:     that this master file must be explicitly registered in the
                   6104:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      6105: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  6106:     from the examples hierarchy into the system-wide startup scripts
                   6107:     directory.</p></li>
                   6108: </ol></div>
1.23      wiz      6109: <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
1.1       dsieger  6110: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6111: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6112: <p>The automatic copying of config files can be toggled by setting the
                   6113: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6114: installation.  Note that the scripts will be always copied inside the
                   6115: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6116: matter what the value of this variable is.</p>
                   6117: </div>
                   6118: </div>
1.23      wiz      6119: <div class="sect1" title="15.4. System users and groups">
1.1       dsieger  6120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6121: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6122: <p>If a package needs to create special users and/or groups during
                   6123: installation, it can do so by using the pkginstall framework.</p>
                   6124: <p>Users can be created by adding entries to the
                   6125: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6126: syntax:</p>
                   6127: <pre class="programlisting">
                   6128: user:group
                   6129: </pre>
                   6130: <p>Further specification of user details may be done by setting
                   6131: per-user variables.
                   6132: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6133: numeric UID for the user.
                   6134: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6135: user's description or comment.
                   6136: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6137: user's home directory, and defaults to
                   6138: <code class="filename">/nonexistent</code> if not specified.
                   6139: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6140: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6141: not specified.</p>
                   6142: <p>Similarly, groups can be created by adding entries to the
                   6143: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6144: <pre class="programlisting">
                   6145: group
                   6146: </pre>
                   6147: <p>The numeric GID of the group may be set by defining
                   6148: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6149: <p>If a package needs to create the users and groups at an earlier
                   6150: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6151: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6152: indicate the phase before which the users and groups are created.  In
                   6153: this case, the numeric UIDs and GIDs of the created users and groups
                   6154: are automatically hardcoded into the final installation scripts.</p>
                   6155: </div>
1.23      wiz      6156: <div class="sect1" title="15.5. System shells">
1.1       dsieger  6157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6158: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6159: <p>Packages that install system shells should register them in the shell
                   6160: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6161: administrator.  This must be done from the installation scripts to keep
                   6162: binary packages working on any system.  pkginstall provides an easy way to
                   6163: accomplish this task.</p>
                   6164: <p>When a package provides a shell interpreter, it has to set the
                   6165: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6166: add some hooks to the installation scripts to handle it.  Consider the
                   6167: 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>
                   6168: <pre class="programlisting">
                   6169: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6170: </pre>
1.23      wiz      6171: <div class="sect2" title="15.5.1. Disabling shell registration">
1.1       dsieger  6172: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6173: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6174: <p>The automatic registration of shell interpreters can be disabled by
                   6175: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6176: environment variable to <code class="literal">NO</code>.</p>
                   6177: </div>
                   6178: </div>
1.23      wiz      6179: <div class="sect1" title="15.6. Fonts">
1.1       dsieger  6180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6181: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6182: <p>Packages that install X11 fonts should update the database files
                   6183: that index the fonts within each fonts directory.  This can easily be
                   6184: accomplished within the pkginstall framework.</p>
                   6185: <p>When a package installs X11 fonts, it must list the directories in
                   6186: which fonts are installed in the
                   6187: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      6188: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   6189: <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
1.1       dsieger  6190: installation scripts to run the appropriate commands to update the fonts
                   6191: database files within each of those directories.  For convenience, if the
                   6192: directory path is relative, it is taken to be relative to the package's
                   6193: 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>
                   6194: <pre class="programlisting">
                   6195: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6196: </pre>
1.23      wiz      6197: <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
1.1       dsieger  6198: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6199: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6200: <p>The automatic update of fonts databases can be disabled by
                   6201: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6202: environment variable to <code class="literal">NO</code>.</p>
                   6203: </div>
                   6204: </div>
                   6205: </div>
1.23      wiz      6206: <div class="chapter" title="Chapter 16. Options handling">
1.1       dsieger  6207: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6208: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6209: <div class="toc">
                   6210: <p><b>Table of Contents</b></p>
                   6211: <dl>
1.6       rillig   6212: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      6213: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6       rillig   6214: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6215: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6216: </dl>
                   6217: </div>
                   6218: <p>Many packages have the ability to be built to support different
                   6219: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6220: in pkgsrc that provides generic handling of those options that
                   6221: determine different ways in which the packages can be built.  It's
                   6222: possible for the user to specify exactly which sets of options will be
                   6223: built into a package or to allow a set of global default options
                   6224: apply.</p>
1.7       rillig   6225: <p>There are two broad classes of behaviors that one might want to
                   6226: control via options.  One is whether some particular feature is
                   6227: enabled in a program that will be built anyway, often by including or
                   6228: not including a dependency on some other package.  The other is
                   6229: whether or not an additional program will be built as part of the
                   6230: package.  Generally, it is better to make a split package for such
                   6231: additional programs instead of using options, because it enables
                   6232: binary packages to be built which can then be added separately.  For
                   6233: example, the foo package might have minimal dependencies (those
                   6234: packages without which foo doesn't make sense), and then the foo-gfoo
                   6235: package might include the GTK frontend program gfoo.  This is better
                   6236: than including a gtk option to foo that adds gfoo, because either that
                   6237: option is default, in which case binary users can't get foo without
                   6238: gfoo, or not default, in which case they can't get gfoo.  With split
                   6239: packages, they can install foo without having GTK, and later decide to
                   6240: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6241: source users too, avoiding the need for rebuilds.</p>
                   6242: <p>Plugins with widely varying dependencies should usually be split
                   6243: instead of options.</p>
                   6244: <p>It is often more work to maintain split packages, especially if
                   6245: the upstream package does not support this.  The decision of split
                   6246: vs. option should be made based on the likelihood that users will want
                   6247: or object to the various pieces, the size of the dependencies that are
                   6248: included, and the amount of work.</p>
                   6249: <p>A further consideration is licensing.  Non-free parts, or parts
                   6250: that depend on non-free dependencies (especially plugins) should
                   6251: almost always be split if feasible.</p>
1.23      wiz      6252: <div class="sect1" title="16.1. Global default options">
1.1       dsieger  6253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6254: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6255: <p>Global default options are listed in
                   6256: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6257: that should be built into every package if that option is supported.
1.10      hubertf  6258: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6259: </div>
1.23      wiz      6260: <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
1.1       dsieger  6261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6262: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6263: </h2></div></div></div>
                   6264: <p>The following example shows how
                   6265: <code class="filename">bsd.options.mk</code> should be used
                   6266: by the hypothetical ``wibble'' package, either in the package
                   6267: <code class="filename">Makefile</code>, or in a file,
                   6268: e.g. <code class="filename">options.mk</code>, that is included by the
                   6269: main package <code class="filename">Makefile</code>.</p>
                   6270: <pre class="programlisting">
                   6271: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6272: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6273: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6274: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6275: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6276: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6277: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6278: 
                   6279: .include "../../mk/bsd.prefs.mk"
                   6280: 
                   6281: # this package was previously named wibble2
                   6282: .if defined(PKG_OPTIONS.wibble2)
                   6283: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6284: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6285:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6286: .endif
                   6287: 
                   6288: .include "../../mk/bsd.options.mk"
                   6289: 
                   6290: # Package-specific option-handling
                   6291: 
                   6292: ###
                   6293: ### FOO support
                   6294: ###
                   6295: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6296: CONFIGURE_ARGS+=    --enable-foo
                   6297: .endif
                   6298: 
                   6299: ###
                   6300: ### LDAP support
                   6301: ###
                   6302: .if !empty(PKG_OPTIONS:Mldap)
                   6303: .  include "../../databases/openldap-client/buildlink3.mk"
                   6304: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6305: .endif
                   6306: 
                   6307: ###
                   6308: ### database support
                   6309: ###
                   6310: .if !empty(PKG_OPTIONS:Mmysql)
                   6311: .  include "../../mk/mysql.buildlink3.mk"
                   6312: .endif
                   6313: .if !empty(PKG_OPTIONS:Mpgsql)
                   6314: .  include "../../mk/pgsql.buildlink3.mk"
                   6315: .endif
                   6316: </pre>
                   6317: <p>The first section contains the information about which build
                   6318: options are supported by the package, and any default options settings
                   6319: if needed.</p>
1.23      wiz      6320: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6321: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29      dholland 6322: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1       dsieger  6323: options.  It should be set to
                   6324: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6325: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6326: at the point where the options are processed.</p></li>
1.23      wiz      6327: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  6328: build options supported by the package.</p></li>
1.23      wiz      6329: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  6330: list of names of groups of mutually exclusive options.  The options in
                   6331: each group are listed in
                   6332: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6333: The most specific setting of any option from the group takes
                   6334: precedence over all other options in the group.  Options from the
                   6335: groups will be automatically added to
                   6336: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      6337: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  6338: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6339: packages will fail if no option from the group is
                   6340: selected.</p></li>
1.23      wiz      6341: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  6342: of names of sets of options.  At least one option from each set must
                   6343: be selected.  The options in each set are listed in
                   6344: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6345: Options from the sets will be automatically added to
                   6346: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6347: fail if no option from the set is selected.</p></li>
1.23      wiz      6348: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  6349: build options which are enabled by default.</p></li>
1.23      wiz      6350: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  6351: of
1.23      wiz      6352: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
1.10      hubertf  6353: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6354: their option counterparts.  Pairs should be added with
1.23      wiz      6355: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  6356: warning will be issued if the user uses a legacy
                   6357: variable.</p></li>
1.23      wiz      6358: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  6359: of
1.23      wiz      6360: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
1.1       dsieger  6361: pairs that map options that have been renamed to their new
1.23      wiz      6362: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  6363: the listing of global legacy options.  A warning will be issued if
                   6364: the user uses a legacy option.</p></li>
1.23      wiz      6365: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  6366: options implied by deprecated variables used.  This can be used for
                   6367: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6368: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6369: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      6370: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  6371: a list of warnings about deprecated variables or options used, and
                   6372: what to use instead.</p></li>
                   6373: </ol></div>
                   6374: <p>A package should never modify
                   6375: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6376: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6377: To suggest a default set of options, use
                   6378: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6379: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6380: including <code class="filename">bsd.options.mk</code>.  If none of
                   6381: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6382: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6383: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6384: happen with platform-specific options if none of them is supported on
                   6385: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6386: empty list and the package is otherwise treated as not using the
                   6387: options framework.</p>
                   6388: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6389: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6390: build options, properly filtered to remove unsupported and duplicate
                   6391: options.</p>
                   6392: <p>The remaining sections contain the logic that is specific to
                   6393: each option.  The correct way to check for an option is to check
                   6394: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6395: <pre class="programlisting">
                   6396: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6397: </pre>
                   6398: </div>
1.23      wiz      6399: <div class="sect1" title="16.3. Option Names">
1.1       dsieger  6400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6401: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6402: <p>Options that enable similar features in different packages (like
                   6403: optional support for a library) should use a common name in all
                   6404: packages that support it (like the name of the library).  If another
                   6405: package already has an option with the same meaning, use the same
                   6406: name.</p>
                   6407: <p>Options that enable features specific to one package, where it's
                   6408: unlikely that another (unrelated) package has the same (or a similar)
                   6409: optional feature, should use a name prefixed with
                   6410: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6411: <p>If a group of related packages share an optional feature
                   6412: specific to that group, prefix it with the name of the
1.23      wiz      6413: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  6414: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6415: <p>For new options, add a line to
                   6416: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6417: fields, separated by tab.  The first field is the option name, the
                   6418: second its description.  The description should be a whole sentence
                   6419: (starting with an uppercase letter and ending with a period) that
1.23      wiz      6420: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6421: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  6422: </div>
1.23      wiz      6423: <div class="sect1" title="16.4. Determining the options of dependencies">
1.7       rillig   6424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6425: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  6426: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7       rillig   6427: different dependencies based on the options with which the package was
                   6428: built. For querying these options, the file
                   6429: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6430: typical example looks like this:</p>
                   6431: <pre class="programlisting">
                   6432: pkgbase := libpurple
                   6433: .include "../../mk/pkg-build-options.mk"
                   6434: 
                   6435: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6436: ...
                   6437: .endif
                   6438: </pre>
                   6439: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6440: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6441: options of the libpurple package, which can then be queried like
                   6442: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6443: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6444: details.</p>
                   6445: </div>
1.1       dsieger  6446: </div>
1.23      wiz      6447: <div class="chapter" title="Chapter 17. The build process">
1.1       dsieger  6448: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6449: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6450: <div class="toc">
                   6451: <p><b>Table of Contents</b></p>
                   6452: <dl>
1.6       rillig   6453: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6454: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6455: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6456: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      6457: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   6458: <dd><dl>
                   6459: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6460: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6461: </dl></dd>
1.23      wiz      6462: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6463: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6464: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6465: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6466: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6467: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6468: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6469: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6470: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6471: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig   6472: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6473: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6474: </dl>
                   6475: </div>
1.23      wiz      6476: <div class="sect1" title="17.1. Introduction">
1.1       dsieger  6477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6478: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6479: <p>This chapter gives a detailed description on how a package is
                   6480:     built. Building a package is separated into different
                   6481:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6482:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      6483:     described in the following sections. Each phase is split into
1.1       dsieger  6484:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6485:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6486:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6487:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6488:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6489: <p>Never override the regular targets (like
                   6490:     <code class="varname">fetch</code>), if you have to, override the
                   6491:     <code class="varname">do-*</code> ones instead.</p>
                   6492: <p>The basic steps for building a program are always the same.  First
                   6493:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6494:     the local system and then extracted. After any pkgsrc-specific patches
                   6495:     to compile properly are applied, the software can be configured, then
                   6496:     built (usually by compiling), and finally the generated binaries, etc.
                   6497:     can be put into place on the system.</p>
                   6498: <p>To get more details about what is happening at each step,
                   6499:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6500:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6501:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6502: </div>
1.23      wiz      6503: <div class="sect1" title="17.2. Program location">
1.1       dsieger  6504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6505: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6506: <p>Before outlining the process performed by the NetBSD package system in
                   6507:     the next section, here's a brief discussion on where programs are
                   6508:     installed, and which variables influence this.</p>
                   6509: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6510:     where all files of the final program shall be installed. It is
                   6511:     usually set to <code class="varname">LOCALBASE</code>
                   6512:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6513:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6514:     <code class="varname">PREFIX</code> needs to be put
                   6515:     into the various places in the program's source where paths to
1.10      hubertf  6516:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.1       dsieger  6517: <p>When choosing which of these variables to use,
                   6518:     follow the following rules:</p>
1.23      wiz      6519: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   6520: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  6521:        where the current pkg will be installed.  When referring to a
                   6522:        pkg's own installation path, use
1.23      wiz      6523:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6524: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  6525:        are installed.  If you need to construct a -I or -L argument
                   6526:        to the compiler to find includes and libraries installed by
1.23      wiz      6527:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  6528:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6529:        installed all packages in <code class="filename">/usr/local</code>. As
                   6530:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6531:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      6532: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  6533:        distribution (from xsrc, etc.) is installed. When looking for
                   6534:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      6535:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   6536: <li class="listitem">
1.1       dsieger  6537: <p>X11-based packages are special in that they may be
                   6538:        installed in either <code class="varname">X11BASE</code> or
                   6539:        <code class="varname">LOCALBASE</code>.</p>
                   6540: <p>Usually, X11 packages should be installed under
                   6541:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6542:        will need to include
                   6543:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6544:        request the presence of X11 and to get the right compilation
                   6545:        flags.</p>
                   6546: <p>Even though, there are some packages that cannot be installed
                   6547:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6548:        files. These packages are special and they must be placed under
                   6549:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6550:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6551:        your package.</p>
                   6552: <p>Some notes: If you need
                   6553:        to find includes or libraries installed by a pkg that has
                   6554:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6555:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6556:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6557:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6558:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6559:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6560:        is enabled by default.</p>
                   6561: </li>
1.23      wiz      6562: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1       dsieger  6563:        the installed location of an X11
                   6564:        package. <code class="varname">X11PREFIX</code> will be set to
                   6565:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6566:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6567:        installed.</p></li>
1.23      wiz      6568: <li class="listitem">
1.1       dsieger  6569: <p>If xpkgwedge is installed, it is possible to have some
                   6570:        packages installed in <code class="varname">X11BASE</code> and some in
                   6571:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6572:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6573:        definition can be used. It takes pairs in the format
1.29      dholland 6574:        <span class="quote">&#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  6575:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6576:        of the installed package &lt;package&gt;, or
1.23      wiz      6577:        <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
1.1       dsieger  6578:        installed.</p>
                   6579: <p>This is best illustrated by example.</p>
                   6580: <p>The following lines are taken from
                   6581:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6582: <pre class="programlisting">
                   6583: EVAL_PREFIX+=           GTKDIR=gtk+
                   6584: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6585: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6586: CONFIGURE_ARGS+=        --enable-multibyte
                   6587: </pre>
                   6588: <p>Specific defaults can be defined for the packages
                   6589:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6590:        definition of the form:</p>
                   6591: <pre class="programlisting">
                   6592: GTKDIR_DEFAULT= ${LOCALBASE}
                   6593: </pre>
                   6594: <p>where <code class="varname">GTKDIR</code> corresponds
                   6595:        to the first definition in
                   6596:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6597: </li>
1.23      wiz      6598: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29      dholland 6599:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1       dsieger  6600:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6601:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6602: </ul></div>
                   6603: </div>
1.23      wiz      6604: <div class="sect1" title="17.3. Directories used during the build process">
1.1       dsieger  6605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6606: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 6607: <p>When building a package, various directories are used to store
1.1       dsieger  6608:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6609:     directories are explained here.</p>
                   6610: <p>Some of the directory variables contain relative pathnames. There
                   6611:     are two common base directories for these relative directories:
                   6612:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6613:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6614:     inside the package itself.</p>
                   6615: <div class="variablelist"><dl>
                   6616: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6617: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6618:       root directory. Generally, you don't need
                   6619:       it.</p></dd>
                   6620: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6621: <dd><p>This is an absolute pathname that points to the
                   6622:       current package.</p></dd>
                   6623: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6624: <dd><p>This is a pathname relative to
                   6625:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6626:       package.</p></dd>
                   6627: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6628: <dd><p>This is an absolute pathname pointing to the directory
                   6629:       where all work takes place. The distfiles are extracted to this
                   6630:       directory. It also contains temporary directories and log files used by
                   6631:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6632:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6633: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6634: <dd><p>This is an absolute pathname pointing to the directory
                   6635:       where the distfiles are extracted. It is usually a direct subdirectory
                   6636:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6637:       that isn't hidden. This variable may be changed by a package
                   6638:       <code class="filename">Makefile</code>.</p></dd>
                   6639: </dl></div>
1.14      jmcneill 6640: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6641:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   6642:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 6643:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6644:     If users would like to have their pkgsrc trees behave in a
                   6645:     read-only manner, then the value of
                   6646:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6647:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  6648: </div>
1.23      wiz      6649: <div class="sect1" title="17.4. Running a phase">
1.1       dsieger  6650: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6651: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  6652: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  6653:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6654:     phase. This will automatically run all phases that are required for this
                   6655:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  6656:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  6657:     the package will be built, but not installed.</p>
                   6658: </div>
1.23      wiz      6659: <div class="sect1" title="17.5. The fetch phase">
1.1       dsieger  6660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6661: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6662: <p>The first step in building a package is to fetch the
                   6663:     distribution files (distfiles) from the sites that are providing
                   6664:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6665:     phase.</p>
1.23      wiz      6666: <div class="sect2" title="17.5.1. What to fetch and where to get it from">
1.1       dsieger  6667: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6668: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1       dsieger  6669: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6670:       defines all URLs from where the distfile, whose name is
                   6671:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6672:       fetched. The more complicated cases are described
                   6673:       below.</p>
                   6674: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6675:       the list of distfiles that have to be fetched. Its value
                   6676:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6677:       so that most packages don't need to define it at all.
                   6678:       <code class="varname">EXTRACT_SUFX</code> is
                   6679:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6680:       freely. Note that if your package requires additional
                   6681:       distfiles to the default one, you cannot just append the
                   6682:       additional filenames using the <code class="literal">+=</code>
                   6683:       operator, but you have write for example:</p>
                   6684: <pre class="programlisting">
                   6685: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6686: </pre>
                   6687: <p>Each distfile is fetched from a list of sites, usually
                   6688:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6689:       <code class="varname">DISTFILES</code> or multiple
                   6690:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6691:       set
                   6692:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6693:       to the list of URLs where the file
                   6694:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6695:       (including the suffix) can be found.</p>
                   6696: <pre class="programlisting">
                   6697: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6698: DISTFILES+=     foo-file.tar.gz
                   6699: SITES.foo-file.tar.gz= \
                   6700: http://www.somewhere.com/somehow/ \
                   6701: http://www.somewhereelse.com/mirror/somehow/
                   6702: </pre>
                   6703: <p>When actually fetching the distfiles, each item from
                   6704:       <code class="varname">MASTER_SITES</code> or
                   6705:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6706:       appended to it, without an intermediate slash. Therefore,
                   6707:       all site values have to end with a slash or other separator
                   6708:       character. This allows for example to set
                   6709:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6710:       that gets the name of the distfile as a parameter. In this
                   6711:       case, the definition would look like:</p>
                   6712: <pre class="programlisting">
                   6713: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6714: </pre>
1.22      jakllsch 6715: <p> The exception to this rule are URLs starting with a dash.
                   6716:       In that case the URL is taken as is, fetched and the result stored
                   6717:       under the name of the distfile.</p>
1.1       dsieger  6718: <p>There are some predefined values for
                   6719:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6720:       packages.  The names of the variables should speak for
                   6721:       themselves.</p>
                   6722: <pre class="programlisting">
                   6723: ${MASTER_SITE_APACHE}
                   6724: ${MASTER_SITE_BACKUP}
                   6725: ${MASTER_SITE_CYGWIN}
                   6726: ${MASTER_SITE_DEBIAN}
                   6727: ${MASTER_SITE_FREEBSD}
                   6728: ${MASTER_SITE_FREEBSD_LOCAL}
                   6729: ${MASTER_SITE_GENTOO}
                   6730: ${MASTER_SITE_GNOME}
                   6731: ${MASTER_SITE_GNU}
                   6732: ${MASTER_SITE_GNUSTEP}
                   6733: ${MASTER_SITE_IFARCHIVE}
                   6734: ${MASTER_SITE_KDE}
                   6735: ${MASTER_SITE_MOZILLA}
                   6736: ${MASTER_SITE_MYSQL}
                   6737: ${MASTER_SITE_OPENOFFICE}
                   6738: ${MASTER_SITE_PERL_CPAN}
                   6739: ${MASTER_SITE_PGSQL}
                   6740: ${MASTER_SITE_R_CRAN}
                   6741: ${MASTER_SITE_SOURCEFORGE}
                   6742: ${MASTER_SITE_SOURCEFORGE_JP}
                   6743: ${MASTER_SITE_SUNSITE}
                   6744: ${MASTER_SITE_SUSE}
                   6745: ${MASTER_SITE_TEX_CTAN}
                   6746: ${MASTER_SITE_XCONTRIB}
                   6747: ${MASTER_SITE_XEMACS}
                   6748: </pre>
                   6749: <p>Some explanations for the less self-explaining ones:
                   6750:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6751:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25      spz      6752:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1       dsieger  6753: <p>If you choose one of these predefined sites, you may
                   6754:       want to specify a subdirectory of that site. Since these
                   6755:       macros may expand to more than one actual site, you
                   6756:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6757:       specify a subdirectory:</p>
                   6758: <pre class="programlisting">
                   6759: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6760: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6761: </pre>
                   6762: <p>Note the trailing slash after the subdirectory
                   6763:       name.</p>
                   6764: </div>
1.23      wiz      6765: <div class="sect2" title="17.5.2. How are the files fetched?">
1.1       dsieger  6766: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6767: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6768: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6769:       all the distfiles exist in a local directory
                   6770:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6771:       user). If the files do not exist, they are fetched using
                   6772:       commands of the form</p>
                   6773: <pre class="programlisting">
                   6774: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6775: </pre>
                   6776: <p>where <code class="literal">${site}</code> varies through
                   6777:       several possibilities in turn: first,
                   6778:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6779:       sites specified in either <code class="varname">SITES.file</code> if
                   6780:       defined, else <code class="varname">MASTER_SITES</code> or
                   6781:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6782:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6783:       all except the first and the last can be optionally sorted
                   6784:       by the user, via setting either
                   6785:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6786:       <code class="varname">MASTER_SORT_AWK</code> or
                   6787:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6788: <p> The specific command and arguments used depend on the
                   6789:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6790:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6791: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6792:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6793:       distfiles, if they are freely distributable.  Packages setting
                   6794:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6795:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6796:       mirrored.</p>
                   6797: </div>
                   6798: </div>
1.23      wiz      6799: <div class="sect1" title="17.6. The checksum phase">
1.1       dsieger  6800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6801: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6802: <p>After the distfile(s) are fetched, their checksum is
                   6803:     generated and compared with the checksums stored in the
                   6804:     distinfo file. If the checksums don't match, the build is
                   6805:     aborted. This is to ensure the same distfile is used for
                   6806:     building, and that the distfile wasn't changed, e.g. by some
                   6807:     malign force, deliberately changed distfiles on the master
                   6808:     distribution site or network lossage.</p>
                   6809: </div>
1.23      wiz      6810: <div class="sect1" title="17.7. The extract phase">
1.1       dsieger  6811: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6812: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6813: <p>When the distfiles are present on the local system, they
                   6814:     need to be extracted, as they usually come in the form of some
                   6815:     compressed archive format.</p>
                   6816: <p>By default, all <code class="varname">DISTFILES</code> are
                   6817:     extracted. If you only need some of them, you can set the
                   6818:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6819:     files.</p>
                   6820: <p>Extracting the files is usually done by a little
                   6821:     program, <code class="filename">mk/extract/extract</code>, which
                   6822:     already knows how to extract various archive formats, so most
                   6823:     likely you will not need to change anything here. But if you
                   6824:     need, the following variables may help you:</p>
                   6825: <div class="variablelist"><dl>
                   6826: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6827: <dd><p>Use these variables to override the default
                   6828:       options for an extract command, which are defined in
                   6829:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6830: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6831: <dd><p>This variable can be set to
1.14      jmcneill 6832:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6833:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6834:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6835:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6836:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6837: </dl></div>
                   6838: <p>If the <code class="filename">extract</code> program doesn't
                   6839:     serve your needs, you can also override the
                   6840:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6841:     command used for extracting the files. This command is
                   6842:     executed in the <code class="filename">${WRKSRC}</code>
                   6843:     directory. During execution of this command, the shell
                   6844:     variable <code class="varname">extract_file</code> holds the absolute
                   6845:     pathname of the file that is going to be extracted.</p>
                   6846: <p>And if that still does not suffice, you can override the
                   6847:     <code class="varname">do-extract</code> target in the package
                   6848:     Makefile.</p>
                   6849: </div>
1.23      wiz      6850: <div class="sect1" title="17.8. The patch phase">
1.1       dsieger  6851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6852: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6853: <p>After extraction, all the patches named by the
                   6854:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6855:     subdirectory of the package as well as in
                   6856:     $LOCALPATCHES/$PKGPATH (e.g.
                   6857:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6858:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6859:     <code class="filename">.gz</code> are uncompressed before they are
                   6860:     applied, files ending in <code class="filename">.orig</code> or
                   6861:     <code class="filename">.rej</code> are ignored. Any special options to
1.29      dholland 6862:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.10      hubertf  6863:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more details.</p>
1.29      dholland 6864: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1       dsieger  6865:     it fail if the patches apply with some lines of fuzz. Please
                   6866:     fix (regen) the patches so that they apply cleanly. The
                   6867:     rationale behind this is that patches that don't apply cleanly
                   6868:     may end up being applied in the wrong place, and cause severe
                   6869:     harm there.</p>
                   6870: </div>
1.23      wiz      6871: <div class="sect1" title="17.9. The tools phase">
1.1       dsieger  6872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6873: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6874: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1       dsieger  6875:     </p>
                   6876: </div>
1.23      wiz      6877: <div class="sect1" title="17.10. The wrapper phase">
1.1       dsieger  6878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6879: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6880: <p>This phase creates wrapper programs for the compilers and
                   6881:     linkers. The following variables can be used to tweak the
                   6882:     wrappers.</p>
                   6883: <div class="variablelist"><dl>
                   6884: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6885: <dd><p>The command used to print progress
                   6886:       messages. Does nothing by default. Set to
                   6887:       <code class="literal">${ECHO}</code> to see the progress
                   6888:       messages.</p></dd>
                   6889: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6890: <dd><p>This variable can be set to
                   6891:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6892:       depending on whether you want additional information in the
                   6893:       wrapper log file.</p></dd>
                   6894: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6895: <dd><p>This variable can be set to
                   6896:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6897:       on whether the wrapper should use its cache, which will
                   6898:       improve the speed. The default value is
                   6899:       <code class="literal">yes</code>, but is forced to
                   6900:       <code class="literal">no</code> if the platform does not support
                   6901:       it.</p></dd>
                   6902: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6903: <dd><p>A list of reordering commands. A reordering
                   6904:       command has the form
                   6905:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6906:       It ensures that that
                   6907:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6908:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6909:       </p></dd>
                   6910: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6911: <dd><p>A list of transformation commands. [TODO:
                   6912:       investigate further]</p></dd>
                   6913: </dl></div>
                   6914: </div>
1.23      wiz      6915: <div class="sect1" title="17.11. The configure phase">
1.1       dsieger  6916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6917: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6918: <p>Most pieces of software need information on the header
                   6919:     files, system calls, and library routines which are available
                   6920:     on the platform they run on. The process of determining this
                   6921:     information is known as configuration, and is usually
                   6922:     automated. In most cases, a script is supplied with the
                   6923:     distfiles, and its invocation results in generation of header
                   6924:     files, Makefiles, etc.</p>
                   6925: <p>If the package contains a configure script, this can be
                   6926:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6927:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6928:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6929:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6930:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6931: <pre class="programlisting">
                   6932: .for d in ${CONFIGURE_DIRS}
                   6933:         cd ${WRKSRC} \
                   6934:         &amp;&amp; cd ${d} \
                   6935:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6936: .endfor
                   6937: </pre>
                   6938: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6939:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6940:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6941:     configure script is run with the environment
                   6942:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6943:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6944:     <code class="varname">CONFIGURE_ENV</code>,
                   6945:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6946:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6947:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6948:     package.</p>
1.37      wiz      6949: <p>If the program uses the Perl way of configuration (mainly Perl
                   6950:     modules, but not only), i.e. a file called
                   6951:     <code class="filename">Makefile.PL</code>, it should include
                   6952:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6953:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6954:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1       dsieger  6955: <p>If the program uses an <code class="filename">Imakefile</code>
                   6956:     for configuration, the appropriate steps can be invoked by
                   6957:     setting <code class="varname">USE_IMAKE</code> to
1.23      wiz      6958:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
1.1       dsieger  6959:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   6960:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6961:     xmkmf's environment by adding them to the
                   6962:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6963: <p>If the program uses <code class="filename">cmake</code>
                   6964:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6965:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6966:     You can add variables to cmake's environment by adding them to the
                   6967:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6968:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6969:     The top directory argument is given by the
                   6970:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6971:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6972: <p>If there is no configure step at all, set
1.23      wiz      6973:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6974: </div>
1.23      wiz      6975: <div class="sect1" title="17.12. The build phase">
1.1       dsieger  6976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6977: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6978: <p>For building a package, a rough equivalent of the
                   6979:     following code is executed.</p>
                   6980: <pre class="programlisting">
                   6981: .for d in ${BUILD_DIRS}
                   6982:         cd ${WRKSRC} \
                   6983:         &amp;&amp; cd ${d} \
                   6984:         &amp;&amp; env ${MAKE_ENV} \
                   6985:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6986:                 -f ${MAKE_FILE} \
                   6987:                 ${BUILD_TARGET}
                   6988: .endfor
                   6989: </pre>
                   6990: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6991:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6992:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6993:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6994:     <code class="varname">MAKE_ENV</code> and arguments
                   6995:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6996:     <code class="varname">MAKE_ENV</code>,
                   6997:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6998:     <code class="varname">MAKE_FILE</code> and
                   6999:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7000:     package.</p>
                   7001: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      7002:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   7003:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.1       dsieger  7004:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      7005:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   7006:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  7007: <p>If there is no build step at all, set
1.23      wiz      7008:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  7009: </div>
1.23      wiz      7010: <div class="sect1" title="17.13. The test phase">
1.1       dsieger  7011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7012: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  7013: <p>[TODO]</p>
                   7014: </div>
1.23      wiz      7015: <div class="sect1" title="17.14. The install phase">
1.1       dsieger  7016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7017: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  7018: <p>Once the build stage has completed, the final step is to
                   7019:     install the software in public directories, so users can
                   7020:     access the programs and files.</p>
                   7021: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   7022:     equivalent of the following code is executed. Additionally,
                   7023:     before and after this code, much magic is performed to do
                   7024:     consistency checks, registering the package, and so on.</p>
                   7025: <pre class="programlisting">
                   7026: .for d in ${INSTALL_DIRS}
                   7027:         cd ${WRKSRC} \
                   7028:         &amp;&amp; cd ${d} \
                   7029:         &amp;&amp; env ${MAKE_ENV} \
                   7030:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7031:                 -f ${MAKE_FILE} \
                   7032:                 ${INSTALL_TARGET}
                   7033: .endfor
                   7034: </pre>
                   7035: <p>The variable's meanings are analogous to the ones in the
                   7036:     <span class="emphasis"><em>build</em></span> phase.
                   7037:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7038:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      7039:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   7040:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  7041:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7042:     defined.</p>
                   7043: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   7044:     variables are useful. They are all variations of the
1.29      dholland 7045:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1       dsieger  7046:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7047:     install command. The specialized variants, together with their
                   7048:     intended use, are:</p>
                   7049: <div class="variablelist"><dl>
                   7050: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   7051: <dd><p>directories that contain
                   7052:       binaries</p></dd>
                   7053: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   7054: <dd><p>directories that contain
                   7055:       scripts</p></dd>
                   7056: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   7057: <dd><p>directories that contain shared and static
                   7058:       libraries</p></dd>
                   7059: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   7060: <dd><p>directories that contain data
                   7061:       files</p></dd>
                   7062: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   7063: <dd><p>directories that contain man
                   7064:       pages</p></dd>
                   7065: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   7066: <dd><p>binaries that can be stripped from debugging
                   7067:       symbols</p></dd>
                   7068: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   7069: <dd><p>binaries that cannot be
                   7070:       stripped</p></dd>
                   7071: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   7072: <dd><p>game
                   7073:       binaries</p></dd>
                   7074: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   7075: <dd><p>shared and static
                   7076:       libraries</p></dd>
                   7077: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7078: <dd><p>data files</p></dd>
                   7079: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   7080: <dd><p>data files for
                   7081:       games</p></dd>
                   7082: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7083: <dd><p>man pages</p></dd>
                   7084: </dl></div>
                   7085: <p>Some other variables are:</p>
                   7086: <div class="variablelist"><dl>
                   7087: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7088: <dd><p>A list of directories relative to
                   7089:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   7090:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7091:       The package is supposed to create all needed directories itself
                   7092:       before installing files to it and list all other directories here.
                   7093:       </p></dd>
                   7094: </dl></div>
                   7095: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      7096:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  7097:     mostly relevant for packages in the <code class="filename">regress</code>
                   7098:     category.</p>
                   7099: </div>
1.23      wiz      7100: <div class="sect1" title="17.15. The package phase">
1.1       dsieger  7101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7102: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  7103: <p>Once the install stage has completed, a binary package of
                   7104:     the installed files can be built.  These binary packages can be
                   7105:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  7106:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7107:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  7108: <p>By default, the binary packages are created in
                   7109:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7110:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7111:     one for each category in the <code class="varname">CATEGORIES</code>
                   7112:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7113:     <code class="filename">pkgsrc/packages</code>.</p>
                   7114: </div>
1.23      wiz      7115: <div class="sect1" title="17.16. Cleaning up">
1.1       dsieger  7116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7117: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  7118: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  7119:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  7120:     to clean the work directories of all dependencies too, use
1.10      hubertf  7121:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  7122: </div>
1.23      wiz      7123: <div class="sect1" title="17.17. Other helpful targets">
1.1       dsieger  7124: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7125: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1       dsieger  7126: <div class="variablelist"><dl>
                   7127: <dt><span class="term">pre/post-*</span></dt>
                   7128: <dd><p>For any of the main targets described in the
                   7129:          previous section, two auxiliary targets exist with
1.23      wiz      7130:          <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
1.1       dsieger  7131:          prefix for the main target's name.  These targets are
                   7132:          invoked before and after the main target is called,
                   7133:          allowing extra configuration or installation steps be
                   7134:          performed from a package's Makefile, for example, which
                   7135:          a program's configure script or install target
                   7136:          omitted.</p></dd>
                   7137: <dt><span class="term">do-*</span></dt>
                   7138: <dd><p>Should one of the main targets do the wrong thing,
                   7139:          and should there be no variable to fix this, you can
                   7140:          redefine it with the do-* target.  (Note that redefining
                   7141:          the target itself instead of the do-* target is a bad
                   7142:          idea, as the pre-* and post-* targets won't be called
                   7143:          anymore, etc.) You will not usually need to do
                   7144:          this.</p></dd>
                   7145: <dt><span class="term">reinstall</span></dt>
                   7146: <dd>
1.10      hubertf  7147: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  7148:          you noticed some file was not installed properly, you
                   7149:          can repeat the installation with this target, which will
1.23      wiz      7150:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  7151: <p>This is the default value of
                   7152:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  7153:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  7154:          package</strong></span>, where the defaults are
1.23      wiz      7155:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.1       dsieger  7156:          respectively.</p>
                   7157: </dd>
                   7158: <dt><span class="term">deinstall</span></dt>
                   7159: <dd>
1.29      dholland 7160: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1       dsieger  7161:          current directory, effectively de-installing the
                   7162:          package. The following variables can be used to tune the
                   7163:          behaviour:</p>
                   7164: <div class="variablelist"><dl>
                   7165: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29      dholland 7166: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1       dsieger  7167: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7168: <dd><p>Remove all packages that require (depend on)
                   7169:                the given package.  This can be used to remove any
                   7170:                packages that may have been pulled in by a given
1.10      hubertf  7171:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  7172:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7173:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7174:                likely to remove whole KDE. Works by adding
1.29      dholland 7175:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1       dsieger  7176:                command line.</p></dd>
                   7177: </dl></div>
                   7178: </dd>
                   7179: <dt><span class="term">bin-install</span></dt>
                   7180: <dd><p>Install a binary package from local disk and via FTP
                   7181:          from a list of sites (see the
                   7182:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  7183:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  7184:          available anywhere.  The arguments given to
1.10      hubertf  7185:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  7186:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7187:          operation, etc.</p></dd>
                   7188: <dt><span class="term">update</span></dt>
                   7189: <dd>
                   7190: <p>This target causes the current package to be
                   7191:          updated to the latest version.  The package and all
                   7192:          depending packages first get de-installed, then current
                   7193:          versions of the corresponding packages get compiled and
                   7194:          installed.  This is similar to manually noting which
                   7195:          packages are currently installed, then performing a
1.10      hubertf  7196:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7197:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  7198:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7199:          packages.</p>
1.23      wiz      7200: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  7201:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  7202:          update</strong></span> was interrupted for some reason.
                   7203:          However, in this case, make sure you don't call
1.10      hubertf  7204:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  7205:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7206:          Otherwise, you lose the ability to automatically update
                   7207:          the current package along with the dependent packages
                   7208:          you have installed.</p>
1.10      hubertf  7209: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  7210:          update</strong></span> will only work as long as the package
                   7211:          tree remains unchanged.  If the source code for one of
                   7212:          the packages to be updated has been changed, resuming
1.10      hubertf  7213:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  7214:          fail!</p>
                   7215: <p>The following variables can be used either on the
1.10      hubertf  7216:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7217:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  7218:          update</strong></span>:</p>
                   7219: <div class="variablelist"><dl>
                   7220: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7221: <dd><p>Install target to recursively use for the
                   7222:                updated package and the dependent packages.
                   7223:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      7224:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  7225:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      7226:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7227:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7228:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  7229:                endless loop!</p></dd>
                   7230: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7231: <dd><p>Don't clean up after updating.  Useful if
                   7232:                you want to leave the work sources of the updated
                   7233:                packages around for inspection or other purposes.
                   7234:                Be sure you eventually clean up the source tree
1.23      wiz      7235:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  7236:                or you may run into troubles with old source code
                   7237:                still lying around on your next
1.10      hubertf  7238:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  7239:                update</strong></span>.</p></dd>
                   7240: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7241: <dd><p>Deinstall each package before installing
                   7242:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7243:                may be necessary if the
1.23      wiz      7244:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  7245:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  7246:                update</strong></span>.</p></dd>
                   7247: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7248: <dd><p>Allows you to disable recursion and hardcode
                   7249:                the target for packages.  The default is
1.23      wiz      7250:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  7251:                facilitating a recursive update of prerequisite
                   7252:                packages.  Only set
                   7253:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7254:                disable recursive updates. Use
                   7255:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7256:                set a specific target for each package to be
1.10      hubertf  7257:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  7258:                (see above).</p></dd>
                   7259: </dl></div>
                   7260: </dd>
                   7261: <dt><span class="term">clean-update</span></dt>
                   7262: <dd>
                   7263: <p>Clean the source tree for all packages that would
1.10      hubertf  7264:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  7265:          from the current directory.  This target should not be
                   7266:          used if the current package (or any of its depending
                   7267:          packages) have already been de-installed (e.g., after
1.10      hubertf  7268:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  7269:          some packages you intended to update. As a rule of
                   7270:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  7271:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  7272:          and only if you have a dirty package tree (e.g., if you
                   7273:          used <code class="varname">NOCLEAN</code>).</p>
                   7274: <p>If you are unsure about whether your tree is
1.10      hubertf  7275:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  7276:          clean</strong></span> at the top of the tree, or use the
                   7277:          following sequence of commands from the directory of the
                   7278:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  7279:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  7280:          time, otherwise you lose all the packages you wanted to
                   7281:          update!):</p>
                   7282: <pre class="screen">
                   7283: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7284: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7285: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7286:          </pre>
                   7287: <p>The following variables can be used either on the
1.10      hubertf  7288:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7289:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.1       dsieger  7290: <div class="variablelist"><dl>
                   7291: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  7292: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  7293:                reconstruct the list of directories to update for
1.10      hubertf  7294:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  7295:                update</strong></span> successfully installed all
                   7296:                packages you wanted to update.  Normally, this is
1.10      hubertf  7297:                done automatically on <span class="command"><strong>make
1.1       dsieger  7298:                update</strong></span>, but may have been suppressed by
                   7299:                the <code class="varname">NOCLEAN</code> variable (see
                   7300:                above).</p></dd>
                   7301: </dl></div>
                   7302: </dd>
                   7303: <dt><span class="term">replace</span></dt>
                   7304: <dd>
                   7305: <p>Update the installation of the current package.  This
                   7306:          differs from update in that it does not replace dependent
                   7307:          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
                   7308:          target to work.</p>
                   7309: <p><span class="emphasis"><em>Be careful when using this
                   7310:          target!</em></span> There are no guarantees that dependent
                   7311:          packages will still work, in particular they will most
1.10      hubertf  7312:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  7313:          library package whose shared library major version changed
                   7314:          between your installed version and the new one.  For this
                   7315:          reason, this target is not officially supported and only
                   7316:          recommended for advanced users.</p>
                   7317: </dd>
                   7318: <dt><span class="term">info</span></dt>
1.29      dholland 7319: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1       dsieger  7320:          package. You can use this to check which version of a
                   7321:          package is installed.</p></dd>
                   7322: <dt><span class="term">index</span></dt>
                   7323: <dd>
                   7324: <p>This is a top-level command, i.e. it should be used in
                   7325:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7326:          database of all packages in the local pkgsrc tree, including
                   7327:          dependencies, comment, maintainer, and some other useful
                   7328:          information.  Individual entries are created by running
1.10      hubertf  7329:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  7330:          directories.  This index file is saved as
                   7331:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  7332:          verbose format by running <span class="command"><strong>make
1.1       dsieger  7333:          print-index</strong></span>.  You can search in it with
1.10      hubertf  7334:          <span class="command"><strong>make search
1.1       dsieger  7335:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7336:          extract a list of all packages that depend on a particular
1.10      hubertf  7337:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  7338:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7339: <p>Running this command takes a very long time, some
                   7340:          hours even on fast machines!</p>
                   7341: </dd>
                   7342: <dt><span class="term">readme</span></dt>
                   7343: <dd>
                   7344: <p>This target generates a
                   7345:          <code class="filename">README.html</code> file, which can be
                   7346:          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
                   7347:          contain references to any packages which are in the
                   7348:          <code class="varname">PACKAGES</code> directory on the local
                   7349:          host. The generated files can be made to refer to URLs
                   7350:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7351:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7352:          wanted to generate <code class="filename">README.html</code>
                   7353:          files which pointed to binary packages on the local
                   7354:          machine, in the directory
                   7355:          <code class="filename">/usr/packages</code>, set
                   7356:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7357:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7358:          <code class="varname">${PACKAGES}</code> directory and its
                   7359:          subdirectories will be searched for all the binary
                   7360:          packages.</p>
                   7361: <p>The target can be run at the toplevel or in category
                   7362:          directories, in which case it descends recursively.</p>
                   7363: </dd>
                   7364: <dt><span class="term">readme-all</span></dt>
                   7365: <dd><p>This is a top-level command, run it in
                   7366:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7367:          file <code class="filename">README-all.html</code> which contains a
                   7368:          list of all packages currently available in the NetBSD
                   7369:          Packages Collection, together with the category they belong
                   7370:          to and a short description. This file is compiled from the
                   7371:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  7372:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  7373:          readme</strong></span>.</p></dd>
                   7374: <dt><span class="term">cdrom-readme</span></dt>
                   7375: <dd><p>This is very much the same as the
1.23      wiz      7376:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  7377:          used when generating a pkgsrc tree to be written to a
                   7378:          CD-ROM.  This target also produces
                   7379:          <code class="filename">README.html</code> files, and can be made
                   7380:          to refer to URLs based on
                   7381:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7382:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7383: <dt><span class="term">show-distfiles</span></dt>
                   7384: <dd><p>This target shows which distfiles and patchfiles
                   7385:          are needed to build the package
                   7386:          (<code class="varname">ALLFILES</code>, which contains all
                   7387:          <code class="varname">DISTFILES</code> and
                   7388:          <code class="varname">PATCHFILES</code>, but not
                   7389:          <code class="filename">patches/*</code>).</p></dd>
                   7390: <dt><span class="term">show-downlevel</span></dt>
                   7391: <dd><p>This target shows nothing if the package is not
                   7392:          installed. If a version of this package is installed,
                   7393:          but is not the version provided in this version of
                   7394:          pkgsrc, then a warning message is displayed. This target
                   7395:          can be used to show which of your installed packages are
                   7396:          downlevel, and so the old versions can be deleted, and
                   7397:          the current ones added.</p></dd>
                   7398: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7399: <dd><p>This target shows the directory in the pkgsrc
                   7400:          hierarchy from which the package can be built and
                   7401:          installed. This may not be the same directory as the one
                   7402:          from which the package was installed. This target is
                   7403:          intended to be used by people who may wish to upgrade
                   7404:          many packages on a single host, and can be invoked from
                   7405:          the top-level pkgsrc Makefile by using the
1.23      wiz      7406:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  7407: <dt><span class="term">show-installed-depends</span></dt>
                   7408: <dd><p>This target shows which installed packages match
                   7409:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7410:          if out of date dependencies are causing build
                   7411:          problems.</p></dd>
                   7412: <dt><span class="term">check-shlibs</span></dt>
                   7413: <dd><p>After a package is installed, check all its
                   7414:          binaries and (on ELF platforms) shared libraries to see
                   7415:          if they find the shared libs they need.  Run by default
1.10      hubertf  7416:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1       dsieger  7417: <dt><span class="term">print-PLIST</span></dt>
                   7418: <dd>
1.23      wiz      7419: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  7420:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  7421:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  7422:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7423:          to care for shared libs etc., but it is
                   7424:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7425:          result before putting it into
                   7426:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7427:          diff the output of this command against an already
                   7428:          existing <code class="filename">PLIST</code> file.</p>
1.29      dholland 7429: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1       dsieger  7430:          other methods that don't update file access times, be
                   7431:          sure to add these files manually to your
1.23      wiz      7432:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7433:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  7434:          them!</p>
1.23      wiz      7435: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.1       dsieger  7436:          information on this target.</p>
                   7437: </dd>
                   7438: <dt><span class="term">bulk-package</span></dt>
                   7439: <dd>
                   7440: <p>Used to do bulk builds. If an appropriate binary
                   7441:          package already exists, no action is taken. If not, this
                   7442:          target will compile, install and package it (and its
                   7443:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10      hubertf  7444:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7445:          After creating the binary package, the sources, the
                   7446:          just-installed package and its required packages are
                   7447:          removed, preserving free disk space.</p>
                   7448: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7449:          all packages installed on a system!</em></span></p>
                   7450: </dd>
                   7451: <dt><span class="term">bulk-install</span></dt>
                   7452: <dd>
                   7453: <p>Used during bulk-installs to install required
                   7454:          packages. If an up-to-date binary package is available,
1.29      dholland 7455:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10      hubertf  7456:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  7457:          but the installed binary won't be removed.</p>
                   7458: <p>A binary package is considered
1.23      wiz      7459:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.29      dholland 7460:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.23      wiz      7461: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7462: <li class="listitem"><p>None of the package's files
1.1       dsieger  7463:              (<code class="filename">Makefile</code>, ...) were modified
                   7464:              since it was built.</p></li>
1.23      wiz      7465: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  7466:              packages were modified since it was built.</p></li>
                   7467: </ul></div>
                   7468: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7469:          all packages installed on a system!</em></span></p>
                   7470: </dd>
                   7471: </dl></div>
                   7472: </div>
                   7473: </div>
1.23      wiz      7474: <div class="chapter" title="Chapter 18. Tools needed for building or running">
1.1       dsieger  7475: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7476: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7477: <div class="toc">
                   7478: <p><b>Table of Contents</b></p>
                   7479: <dl>
1.6       rillig   7480: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7481: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7482: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7483: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7484: </dl>
                   7485: </div>
                   7486: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7487: by pkgsrc and also for individual packages to define what commands
                   7488: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7489: or for later run-time of an installed packaged (such as
                   7490: <code class="varname">DEPENDS</code>).
                   7491: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7492: package will not be used.</p>
                   7493: <p>When building a package, the replacement tools are
                   7494: made available in a directory (as symlinks or wrapper scripts)
                   7495: that is early in the executable search path. Just like the buildlink
                   7496: system, this helps with consistent builds.</p>
                   7497: <p>A tool may be needed to help build a specific package. For example,
                   7498: perl, GNU make (gmake) or yacc may be needed.</p>
                   7499: <p>Also a tool may be needed, for example, because the native system's supplied
                   7500: tool may be inefficient for building a package with pkgsrc.
                   7501: For example, a package may need GNU awk, bison (instead of
                   7502: yacc) or a better sed.</p>
                   7503: <p>The tools used by a package can be listed by running
1.10      hubertf  7504: <span class="command"><strong>make show-tools</strong></span>.</p>
1.23      wiz      7505: <div class="sect1" title="18.1. Tools for pkgsrc builds">
1.1       dsieger  7506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7507: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7508: <p>The default set of tools used by pkgsrc is defined in
                   7509: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  7510: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7511: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  7512: These can be seen by running:
1.10      hubertf  7513: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  7514: <p>If a package needs a specific program to build
                   7515: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7516: to define the tools needed.</p>
                   7517: </div>
1.23      wiz      7518: <div class="sect1" title="18.2. Tools needed by packages">
1.1       dsieger  7519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7520: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      7521: <p>In the following examples, the :run means that it is needed at
                   7522: run-time (and becomes a DEPENDS).
1.1       dsieger  7523: The default is a build dependency which can be set with
                   7524: :build. (So in this example, it is the same as gmake:build
                   7525: and pkg-config:build.)</p>
                   7526: <pre class="programlisting">
                   7527: USE_TOOLS+=     gmake perl:run pkg-config
                   7528: </pre>
                   7529: <p>When using the tools framework, a
                   7530: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7531: which contains the full path to the appropriate tool. For example,
1.23      wiz      7532: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  7533: on Linux systems.</p>
                   7534: <p>If you always need a pkgsrc version of the
                   7535: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7536: </p>
                   7537: </div>
1.23      wiz      7538: <div class="sect1" title="18.3. Tools provided by platforms">
1.1       dsieger  7539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7540: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7541: <p>When improving or porting pkgsrc to a new platform, have a look
                   7542: at (or create) the corresponding platform specific make file fragment under
                   7543: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7544: the name of the common tools. For example:</p>
                   7545: <pre class="programlisting">
                   7546: .if exists(/usr/bin/bzcat)
                   7547: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7548: .elif exists(/usr/bin/bzip2)
                   7549: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7550: .endif
                   7551: 
                   7552: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7553: </pre>
                   7554: </div>
1.23      wiz      7555: <div class="sect1" title="18.4. Questions regarding the tools">
1.1       dsieger  7556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7557: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.23      wiz      7558: <div class="qandaset" title="Frequently Asked Questions">
1.40    ! wiz      7559: <a name="idm20025536"></a><dl>
1.6       rillig   7560: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7561: </dt>
1.6       rillig   7562: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7563:        tools?</a>
                   7564: </dt>
1.6       rillig   7565: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7566:        package is using while being built? I want to know whether it
                   7567:        uses sed or not.</a>
                   7568: </dt>
                   7569: </dl>
1.23      wiz      7570: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  7571: <col align="left" width="1%">
1.23      wiz      7572: <col>
1.1       dsieger  7573: <tbody>
1.23      wiz      7574: <tr class="question" title="18.4.1.">
1.1       dsieger  7575: <td align="left" valign="top">
1.40    ! wiz      7576: <a name="tools.new"></a><a name="idm20025152"></a><p><b>18.4.1.</b></p>
1.1       dsieger  7577: </td>
                   7578: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7579: </tr>
                   7580: <tr class="answer">
                   7581: <td align="left" valign="top"></td>
                   7582: <td align="left" valign="top"><p>TODO</p></td>
                   7583: </tr>
1.23      wiz      7584: <tr class="question" title="18.4.2.">
1.1       dsieger  7585: <td align="left" valign="top">
1.40    ! wiz      7586: <a name="tools.listall"></a><a name="idm20024128"></a><p><b>18.4.2.</b></p>
1.1       dsieger  7587: </td>
                   7588: <td align="left" valign="top"><p>How do I get a list of all available
                   7589:        tools?</p></td>
                   7590: </tr>
                   7591: <tr class="answer">
                   7592: <td align="left" valign="top"></td>
                   7593: <td align="left" valign="top"><p>TODO</p></td>
                   7594: </tr>
1.23      wiz      7595: <tr class="question" title="18.4.3.">
1.1       dsieger  7596: <td align="left" valign="top">
1.40    ! wiz      7597: <a name="tools.used"></a><a name="idm20023104"></a><p><b>18.4.3.</b></p>
1.1       dsieger  7598: </td>
                   7599: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7600:        package is using while being built? I want to know whether it
                   7601:        uses sed or not.</p></td>
                   7602: </tr>
                   7603: <tr class="answer">
                   7604: <td align="left" valign="top"></td>
                   7605: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7606:        to do it.)</p></td>
                   7607: </tr>
                   7608: </tbody>
                   7609: </table>
                   7610: </div>
                   7611: </div>
                   7612: </div>
1.23      wiz      7613: <div class="chapter" title="Chapter 19. Making your package work">
1.1       dsieger  7614: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7615: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7616: <div class="toc">
                   7617: <p><b>Table of Contents</b></p>
                   7618: <dl>
1.6       rillig   7619: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7620: <dd><dl>
1.6       rillig   7621: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      7622: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6       rillig   7623: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7624: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7625: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7626: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7627: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7628: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7629: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7630: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7631: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7632: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7633: </dl></dd>
1.23      wiz      7634: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   7635: <dd><dl>
                   7636: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7637: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   7638: </dl></dd>
1.23      wiz      7639: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig   7640: <dd><dl>
                   7641: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7642: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7643: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7644: </dl></dd>
                   7645: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7646: <dd><dl>
                   7647: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7648: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7649: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40    ! wiz      7650: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
        !          7651: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   7652: </dl></dd>
1.23      wiz      7653: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig   7654: <dd><dl>
                   7655: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7656: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      7657: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.6       rillig   7658: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7659: </dl></dd>
1.23      wiz      7660: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig   7661: <dd><dl>
                   7662: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7663: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7664: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7665: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7666: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7667: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7668: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7669: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7670: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      7671: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   7672: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7673: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7674: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7675: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7676: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7677: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7678: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7679: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7680:     emulation</a></span></dt>
1.6       rillig   7681: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7682: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7683: </dl></dd>
1.6       rillig   7684: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7685: </dl>
                   7686: </div>
1.23      wiz      7687: <div class="sect1" title="19.1. General operation">
1.1       dsieger  7688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7689: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.23      wiz      7690: <div class="sect2" title="19.1.1. Portability of packages">
1.1       dsieger  7691: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7692: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7693: <p>One appealing feature of pkgsrc is that it runs on many
                   7694:     different platforms. As a result, it is important to ensure,
                   7695:     where possible, that packages in pkgsrc are portable. This
                   7696:     chapter mentions some particular details you should pay
                   7697:     attention to while working on pkgsrc.</p>
                   7698: </div>
1.23      wiz      7699: <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
1.1       dsieger  7700: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  7701: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  7702: </h3></div></div></div>
                   7703: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7704:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7705:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7706:     want to use those variables in the preprocessor directives of
1.29      dholland 7707:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1       dsieger  7708:     <code class="literal">.for</code>), you need to include the file
                   7709:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7710:     loads the user preferences.</p>
                   7711: <p>But note that some variables may not be completely defined
                   7712:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7713:     included, as they may contain references to variables that are
                   7714:     not yet defined. In shell commands this is no problem, since
                   7715:     variables are actually macros, which are only expanded when they
                   7716:     are used. But in the preprocessor directives mentioned above and
                   7717:     in dependency lines (of the form <code class="literal">target:
                   7718:     dependencies</code>) the variables are expanded at load
                   7719:     time.</p>
1.23      wiz      7720: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7721: <h3 class="title">Note</h3>
                   7722: <p>Currently there is no exhaustive list of all
                   7723:     variables that tells you whether they can be used at load time
                   7724:     or only at run time, but it is in preparation.</p>
                   7725: </div>
                   7726: </div>
1.23      wiz      7727: <div class="sect2" title="19.1.3. User interaction">
1.1       dsieger  7728: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7729: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7730: <p>Occasionally, packages require interaction from the user,
                   7731:     and this can be in a number of ways:</p>
1.23      wiz      7732: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7733: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7734:        interaction such as entering username/password or accepting a
                   7735:        license on a web page.</p></li>
1.23      wiz      7736: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7737:        passwords.</p></li>
1.23      wiz      7738: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7739: <li class="listitem"><p>help during the build process</p></li>
                   7740: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7741: </ul></div>
                   7742: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7743:     provided to notify the pkgsrc mechanism of an interactive stage
                   7744:     which will be needed, and this should be set in the package's
                   7745:     <code class="filename">Makefile</code>, e.g.:</p>
                   7746: <pre class="programlisting">
                   7747: INTERACTIVE_STAGE=      build
                   7748:     </pre>
                   7749: <p>Multiple interactive stages can be specified:</p>
                   7750: <pre class="programlisting">
                   7751: INTERACTIVE_STAGE=      configure install
                   7752:     </pre>
                   7753: <p>The user can then decide to skip this package by setting the
                   7754:     <code class="varname">BATCH</code> variable.</p>
                   7755: </div>
1.23      wiz      7756: <div class="sect2" title="19.1.4. Handling licenses">
1.1       dsieger  7757: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7758: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7759: <p>Authors of software can choose the licence under which
                   7760:     software can be copied.  This is due to copyright law, and reasons
                   7761:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7762:     system recognizes that there are a number of licenses which some
                   7763:     users may find objectionable or difficult or impossible to comply
                   7764:     with.  The Free Software Foundation has declared some licenses
                   7765:     "Free", and the Open Source Initiative has a definition of "Open
                   7766:     Source".  The pkgsrc system, as a policy choice, does not label
                   7767:     packages which have licenses that are Free or Open Source.
                   7768:     However, packages without a license meeting either of those tests
                   7769:     are labeled with a license tag denoting the license.  Note that a
                   7770:     package with no license to copy trivially does not meet either the
                   7771:     Free or Open Source test.</p>
                   7772: <p>For packages which are not Free or Open Source, pkgsrc will
                   7773:     not build the package unless the user has indicated to pkgsrc that
                   7774:     packages with that particular license may be built.  Note that
                   7775:     this documentation avoids the term "accepted the license".  The
                   7776:     pkgsrc system is merely providing a mechanism to avoid
                   7777:     accidentally building a package with a non-free license;
                   7778:     judgement and responsibility remain with the user.  (Installation
                   7779:     of binary packages are not currently subject to this mechanism;
                   7780:     this is a bug.)</p>
                   7781: <p>One might want to only install packages with a BSD license,
1.19      jnemeth  7782:     or the GPL, and not the other.  The free licenses are added to the 
                   7783:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7784:     user can override the default by setting the
                   7785:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7786:     of "+=".  The licenses accepted by default are:
                   7787:     </p>
                   7788: <pre class="programlisting">
1.32      wiz      7789:         public-domain unlicense
                   7790:         gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7791:         gnu-gpl-v1
                   7792:         gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7793:         gnu-gpl-v3 gnu-lgpl-v3
                   7794:         original-bsd modified-bsd 2-clause-bsd
                   7795:         x11 mit miros
                   7796:         apache-1.1 apache-2.0
                   7797:         artistic artistic-2.0
                   7798:         cddl-1.0
                   7799:         cpl-1.0
                   7800:         open-font-license
                   7801:         mpl-1.0 mpl-1.1 mpl-2.0
                   7802:         php png-license
                   7803:         postgresql-license
                   7804:         zlib
                   7805:         zpl
                   7806:         python-software-foundation
                   7807:         ipafont
                   7808:         ibm-public-license-1.0
                   7809:         isc
                   7810:         boost-license
                   7811:         mplusfont
                   7812:         cc-by-sa-v3.0
                   7813:         lppl-1.3c
                   7814:         lucent
                   7815:         epl-v1.0
                   7816:        info-zip
1.19      jnemeth  7817:     </pre>
                   7818: <p>
                   7819:     </p>
1.1       dsieger  7820: <p>The license tag mechanism is intended to address
                   7821:     copyright-related issues surrounding building, installing and
                   7822:     using a package, and not to address redistribution issues (see
                   7823:     <code class="varname">RESTRICTED</code> and
1.19      jnemeth  7824:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7825:     Packages with redistribution restrictions should set these
                   7826:     tags.</p>
1.1       dsieger  7827: <p>Denoting that a package may be copied according to a
                   7828:     particular license is done by placing the license in
                   7829:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7830:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7831:     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>
                   7832: <pre class="programlisting">
                   7833: LICENSE=        xv-license
                   7834:     </pre>
                   7835: <p>When trying to build, the user will get a notice that the
                   7836:     package is covered by a license which has not been placed in the
                   7837:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7838: <pre class="programlisting">
                   7839: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7840: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7841: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7842: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7843: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7844: *** Error code 1
                   7845:     </pre>
1.10      hubertf  7846: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7847:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7848:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7849:     convey to pkgsrc that it should not in the future fail because of
                   7850:     that license:</p>
                   7851: <pre class="programlisting">
                   7852: ACCEPTABLE_LICENSES+=xv-license
                   7853:     </pre>
                   7854: <p>When adding a package with a new license, the license text
                   7855:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7856:     displaying.  A list of known licenses can be seen in this
                   7857:     directory.</p>
                   7858: <p>When the license changes (in a way other than formatting),
                   7859:     please make sure that the new license has a different name (e.g.,
                   7860:     append the version number if it exists, or the date).  Just
                   7861:     because a user told pkgsrc to build programs under a previous
                   7862:     version of a license does not mean that pkgsrc should build
                   7863:     programs under the new licenses.  The higher-level point is that
                   7864:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7865:     test is a mechanistic test of whether a particular text has been
                   7866:     approved by either of two bodies.</p>
                   7867: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7868:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7869:     is deprecated because it does not crisply refer to a particular
                   7870:     license text.  Another problem with such usage is that it does not
                   7871:     enable a user to tell pkgsrc to proceed for a single package
                   7872:     without also telling pkgsrc to proceed for all packages with that
                   7873:     tag.</p>
                   7874: </div>
1.23      wiz      7875: <div class="sect2" title="19.1.5. Restricted packages">
1.1       dsieger  7876: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7877: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7878: <p>Some licenses restrict how software may be re-distributed.
                   7879:     Because a license tag is required unless the package is Free or
                   7880:     Open Source, all packages with restrictions should have license
                   7881:     tags.  By declaring the restrictions, package tools can
                   7882:     automatically refrain from e.g. placing binary packages on FTP
                   7883:     sites.</p>
                   7884: <p>There are four restrictions that may be encoded, which are
                   7885:     the cross product of sources (distfiles) and binaries not being
                   7886:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7887:     language in any license, and because non-Free licenses tend to be
                   7888:     different from each other, pkgsrc adopts a definition of FTP and
                   7889:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7890:     should not be made available over the Internet at no charge.
                   7891:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7892:     made available on some kind of media, together with other source
                   7893:     and binary packages, and which is sold for a distribution charge.
                   7894:     </p>
                   7895: <p>In order to encode these restrictions, the package system
                   7896:     defines five make variables that can be set to note these
                   7897:     restrictions:</p>
1.23      wiz      7898: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7899: <li class="listitem">
1.1       dsieger  7900: <p><code class="varname">RESTRICTED</code></p>
                   7901: <p>This variable should be set whenever a restriction
                   7902:        exists (regardless of its kind).  Set this variable to a
                   7903:        string containing the reason for the restriction.  It should
                   7904:        be understood that those wanting to understand the restriction
                   7905:        will have to read the license, and perhaps seek advice of
                   7906:        counsel.</p>
                   7907: </li>
1.23      wiz      7908: <li class="listitem">
1.1       dsieger  7909: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7910: <p>Binaries may not be placed on CD-ROM containing other
                   7911:        binary packages, for which a distribution charge may be made.
                   7912:        In this case, set this variable to
                   7913:        <code class="varname">${RESTRICTED}</code>.</p>
                   7914: </li>
1.23      wiz      7915: <li class="listitem">
1.1       dsieger  7916: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7917: <p>Binaries may not made available on the Internet without
                   7918:        charge.  In this case, set this variable to
                   7919:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7920:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7921: </li>
1.23      wiz      7922: <li class="listitem">
1.1       dsieger  7923: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7924: <p>Distfiles may not be placed on CD-ROM, together with
                   7925:        other distfiles, for which a fee may be charged.  In this
                   7926:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7927:        </p>
                   7928: </li>
1.23      wiz      7929: <li class="listitem">
1.1       dsieger  7930: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7931: <p>Distfiles may not made available via FTP at no charge.
                   7932:        In this case, set this variable to
                   7933:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7934:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7935: </li>
                   7936: </ul></div>
1.32      wiz      7937: <p>Please note that packages will to be removed from pkgsrc
                   7938:     when the distfiles are not distributable and cannot be obtained
                   7939:     for a period of one full quarter branch. Packages with manual /
                   7940:     interactive fetch must have a maintainer and it is his/her
                   7941:     responsibility to ensure this.</p>
1.1       dsieger  7942: </div>
1.23      wiz      7943: <div class="sect2" title="19.1.6. Handling dependencies">
1.1       dsieger  7944: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7945: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  7946: <p>Your package may depend on some other package being present
                   7947:     - and there are various ways of expressing this dependency.
                   7948:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7949:     <code class="varname">DEPENDS</code> definitions, the
                   7950:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7951:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7952:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  7953:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1       dsieger  7954: <p>The basic difference between the two variables is as
                   7955:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7956:     that pre-requisite in the binary package so it will be pulled in
                   7957:     when the binary package is later installed, whilst the
                   7958:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7959:     dependency that is only needed for building the package.</p>
                   7960: <p>This means that if you only need a package present whilst
                   7961:     you are building, it should be noted as a
                   7962:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7963: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7964:     <code class="varname">DEPENDS</code> definition is:</p>
                   7965: <pre class="programlisting">
                   7966: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7967:     </pre>
1.23      wiz      7968: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7969:     may include any of the wildcard version numbers recognized by
1.29      dholland 7970:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23      wiz      7971: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7972: <li class="listitem">
1.1       dsieger  7973: <p>If your package needs another package's binaries or
                   7974:        libraries to build or run, and if that package has a
                   7975:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7976: <pre class="programlisting">
                   7977: .include "../../graphics/jpeg/buildlink3.mk"
                   7978:        </pre>
                   7979: </li>
1.23      wiz      7980: <li class="listitem">
1.25      spz      7981: <p>If your package needs binaries from another package to build,
                   7982:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1       dsieger  7983: <pre class="programlisting">
1.25      spz      7984: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1       dsieger  7985:        </pre>
                   7986: </li>
1.25      spz      7987: <li class="listitem"><p>If your package needs a library with which to link and
                   7988:        there is no <code class="filename">buildlink3.mk</code> file
                   7989:        available, create one. Using
                   7990:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7991:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7992: <li class="listitem">
1.25      spz      7993: <p>If your package needs some executable to be able to run
                   7994:        correctly and if there's no
                   7995:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7996:        using the <code class="varname">DEPENDS</code> variable. The
                   7997:        <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
                   7998:        be able to execute the latex binary from the teTeX package
                   7999:        when it runs, and that is specified:</p>
1.1       dsieger  8000: <pre class="programlisting">
1.25      spz      8001: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.1       dsieger  8002:        </pre>
1.25      spz      8003: </li>
                   8004: <li class="listitem">
                   8005: <p>You can use wildcards in package dependencies. Note that
                   8006:        such wildcard dependencies are retained when creating binary
                   8007:        packages. The dependency is checked when installing the binary
                   8008:        package and any package which matches the pattern will be
                   8009:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      8010: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   8011:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   8012:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   8013:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  8014: <p>Wildcards can also be used to specify that a package
                   8015:        will only build against a certain minimum version of a
                   8016:        pre-requisite:</p>
                   8017: <pre class="programlisting">
1.25      spz      8018: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.1       dsieger  8019:        </pre>
1.25      spz      8020: <p>This means that the package will build using version 6.0
                   8021:        of ImageMagick or newer. Such a dependency may be warranted
                   8022:        if, for example, the command line options of an executable
                   8023:        have changed.</p>
                   8024: <p>If you need to depend on minimum versions of libraries,
                   8025:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  8026: <p>For security fixes, please update the package
1.10      hubertf  8027:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.1       dsieger  8028:        information.</p>
                   8029: </li>
                   8030: </ol></div>
                   8031: <p>If your package needs files from another package to build,
                   8032:     add the relevant distribution files to
                   8033:     <code class="varname">DISTFILES</code>, so they will be extracted
                   8034:     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.
                   8035:     (It relies on the jpeg sources being present in source form
                   8036:     during the build.)</p>
                   8037: </div>
1.23      wiz      8038: <div class="sect2" title="19.1.7. Handling conflicts with other packages">
1.1       dsieger  8039: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8040: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  8041: <p>Your package may conflict with other packages a user might
                   8042:     already have installed on his system, e.g. if your package
                   8043:     installs the same set of files as another package in the pkgsrc
                   8044:     tree.</p>
                   8045: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   8046:     space-separated list of packages (including version string) your
                   8047:     package conflicts with.</p>
                   8048: <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>
                   8049:     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>
                   8050:     install the same shared library, thus you set in
                   8051:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8052: <pre class="programlisting">
                   8053: CONFLICTS=      Xaw-Xpm-[0-9]*
                   8054:     </pre>
                   8055: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   8056: <pre class="programlisting">
                   8057: CONFLICTS=      Xaw3d-[0-9]*
                   8058:     </pre>
                   8059: <p>Packages will automatically conflict with other packages
                   8060:     with the name prefix and a different version
1.23      wiz      8061:     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
                   8062:     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
1.1       dsieger  8063: </div>
1.23      wiz      8064: <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
1.1       dsieger  8065: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8066: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  8067: <p>There are several reasons why a package might be
                   8068:     instructed to not build under certain circumstances.  If the
                   8069:     package builds and runs on most platforms, the exceptions
                   8070:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8071:     the package builds and runs on a small handful of platforms,
                   8072:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8073:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8074:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8075:     (OS-version-platform) that can use glob-style
                   8076:     wildcards.</p>
                   8077: <p>Some packages are tightly bound to a specific version of an
                   8078:     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
                   8079:     backwards compatible with other versions of the OS, and should be
                   8080:     uploaded to a version specific directory on the FTP server.  Mark
                   8081:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      8082:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  8083:     the package system internals, but may be used in the
                   8084:     future.</p>
                   8085: <p>If the package should be skipped (for example, because it
                   8086:     provides functionality already provided by the system), set
                   8087:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8088:     the package should fail because some preconditions are not met,
                   8089:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   8090:     message.</p>
                   8091: </div>
1.23      wiz      8092: <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
1.1       dsieger  8093: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8094: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  8095: <p>To ensure that a package may not be deleted, once it has been
                   8096:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8097:     be set in the package Makefile. This will be carried into any
                   8098:     binary package that is made from this pkgsrc entry. A
1.23      wiz      8099:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.29      dholland 8100:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23      wiz      8101:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  8102: </div>
1.23      wiz      8103: <div class="sect2" title="19.1.10. Handling packages with security problems">
1.1       dsieger  8104: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8105: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  8106: <p>When a vulnerability is found, this should be noted in
                   8107:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      8108:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   8109:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  8110: <p>After fixing the vulnerability by a patch, its
1.31      wiz      8111:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8112:     course not necessary if the problem is fixed by using a newer
                   8113:     release of the software), and the pattern in the
                   8114:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  8115: <p>Also, if the fix should be applied to the stable pkgsrc
                   8116:     branch, be sure to submit a pullup request!</p>
                   8117: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8118:     semi-automatically by a weekly cron job.</p>
                   8119: </div>
1.23      wiz      8120: <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
1.1       dsieger  8121: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8122: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  8123: <p>When making fixes to an existing package it can be useful
                   8124:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8125:     avoid conflicting with future versions by the original author, a
1.23      wiz      8126:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.1       dsieger  8127:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      8128:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8129:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  8130: <pre class="programlisting">
                   8131: DISTNAME=       foo-17.42
                   8132: PKGREVISION=    9
                   8133:     </pre>
                   8134: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      8135:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8136:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  8137:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8138:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8139: <p>When a new release of the package is released, the
                   8140:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8141:     minor release of the above package, things should be like:</p>
                   8142: <pre class="programlisting">
                   8143: DISTNAME=       foo-17.43
                   8144:     </pre>
                   8145: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8146:     non-trivial change in the resulting binary package.  Without a
                   8147:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8148:     version installed has no way of knowing that their package is out
                   8149:     of date.  Thus, changes without increasing
                   8150:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8151:     trivial that no reasonable person would want to upgrade", and this
                   8152:     is the rough test for when increasing
                   8153:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8154:     changes that do not merit increasing
                   8155:     <code class="varname">PKGREVISION</code> are:</p>
1.23      wiz      8156: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8157: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 8158:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  8159:       or comments in Makefile.</p></li>
1.23      wiz      8160: <li class="listitem"><p>
1.1       dsieger  8161:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      8162: <li class="listitem"><p>
1.1       dsieger  8163:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      8164: <li class="listitem"><p>
1.1       dsieger  8165:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8166: </ul></div>
                   8167: <p>Examples of changes that do merit an increase to
                   8168:     <code class="varname">PKGREVISION</code> include:</p>
1.23      wiz      8169: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8170: <li class="listitem"><p>
1.1       dsieger  8171:       Security fixes</p></li>
1.23      wiz      8172: <li class="listitem"><p>
1.1       dsieger  8173:       Changes or additions to a patch file</p></li>
1.23      wiz      8174: <li class="listitem"><p>
1.1       dsieger  8175:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      8176: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  8177: </ul></div>
                   8178: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8179:     changes.</p>
                   8180: </div>
1.23      wiz      8181: <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
1.1       dsieger  8182: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8183: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1       dsieger  8184: <p>When you want to replace the same text in multiple files
                   8185:     or when the replacement text varies, patches alone cannot help.
                   8186:     This is where the SUBST framework comes in. It provides an
                   8187:     easy-to-use interface for replacing text in files.
                   8188:     Example:</p>
                   8189: <pre class="programlisting">
                   8190: SUBST_CLASSES+=                 fix-paths
                   8191: SUBST_STAGE.fix-paths=          pre-configure
                   8192: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8193: SUBST_FILES.fix-paths=          src/*.c
                   8194: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8195: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8196: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8197:     </pre>
                   8198: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8199:     that are used to identify the different SUBST blocks that are
                   8200:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8201:     important to always use the <code class="literal">+=</code> operator with
                   8202:     this variable. Otherwise some substitutions may be
                   8203:     skipped.</p>
                   8204: <p>The remaining variables of each SUBST block are
                   8205:     parameterized with the identifier from the first line
                   8206:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8207:     parameters to a function call.</p>
                   8208: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8209:     which the replacement will take place. All combinations of
                   8210:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8211:     <code class="literal">post-</code> together with a phase name are
                   8212:     possible, though only few are actually used. Most commonly used
                   8213:     are <code class="literal">post-patch</code> and
                   8214:     <code class="literal">pre-configure</code>. Of these two,
                   8215:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  8216:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  8217:     have the state after applying the patches but before making any
                   8218:     other changes. This is especially useful when you are debugging
                   8219:     a package in order to create new patches for it. Similarly,
                   8220:     <code class="literal">post-build</code> is preferred over
                   8221:     <code class="literal">pre-install</code>, because the install phase should
                   8222:     generally be kept as simple as possible. When you use
                   8223:     <code class="literal">post-build</code>, you have the same files in the
                   8224:     working directory that will be installed later, so you can check
                   8225:     if the substitution has succeeded.</p>
                   8226: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8227:     that is printed just before the substitution is done.</p>
                   8228: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8229:     globbing patterns that specifies the files in which the
                   8230:     substitution will take place. The patterns are interpreted
                   8231:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8232: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29      dholland 8233:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1       dsieger  8234:     command should be prefixed with <code class="literal">-e</code>, so that
                   8235:     all SUBST blocks look uniform.</p>
                   8236: <p>There are some more variables, but they are so seldomly
                   8237:     used that they are only documented in the
                   8238:     <code class="filename">mk/subst.mk</code> file.</p>
                   8239: </div>
                   8240: </div>
1.23      wiz      8241: <div class="sect1" title="19.2. Fixing problems in the fetch phase">
1.1       dsieger  8242: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8243: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.23      wiz      8244: <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
1.1       dsieger  8245: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8246: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  8247: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8248:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8249:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8250:     with the name of each file to download as an argument, expecting
                   8251:     it to output the URL of the directory from which to download
                   8252:     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
                   8253:     example of this usage.</p>
                   8254: <p>If the download can't be automated, because the user must
                   8255:     submit personal information to apply for a password, or must pay
                   8256:     for the source, or whatever, you can set
                   8257:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8258:     displayed to the user before aborting the build. Example:</p>
                   8259: <pre class="programlisting">
                   8260: FETCH_MESSAGE=  "Please download the files"
                   8261: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8262: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8263:     </pre>
                   8264: </div>
1.23      wiz      8265: <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
1.1       dsieger  8266: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8267: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  8268: <p>Sometimes authors of a software package make some
                   8269:     modifications after the software was released, and they put up a
                   8270:     new distfile without changing the package's version number. If a
                   8271:     package is already in pkgsrc at that time, the checksum will
                   8272:     no longer match. The contents of the new distfile should be
                   8273:     compared against the old one before changing anything, to make
                   8274:     sure the distfile was really updated on purpose, and that
                   8275:     no trojan horse or so crept in.
                   8276:     Please mention that the distfiles were compared and what was found
                   8277:     in your commit message.
                   8278:     Then, the correct way to work around this is to
                   8279:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8280:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8281:     <code class="varname">DISTFILES</code> and
                   8282:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8283:     subdirectory of the local distfiles directory.
1.10      hubertf  8284:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.1       dsieger  8285:     In case this
                   8286:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8287:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8288:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8289:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8290:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8291:     path in the filenames.
                   8292:     Also increase the PKGREVISION if the installed package is different.
                   8293:     Furthermore, a mail to the package's authors seems appropriate
                   8294:     telling them that changing distfiles after releases without
                   8295:     changing the file names is not good practice.</p>
                   8296: </div>
                   8297: </div>
1.23      wiz      8298: <div class="sect1" title="19.3. Fixing problems in the configure phase">
1.1       dsieger  8299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8300: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.23      wiz      8301: <div class="sect2" title="19.3.1. Shared libraries - libtool">
1.1       dsieger  8302: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8303: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8304: <p>pkgsrc supports many different machines, with different
                   8305:     object formats like a.out and ELF, and varying abilities to do
                   8306:     shared library and dynamic loading at all. To accompany this,
                   8307:     varying commands and options have to be passed to the
                   8308:     compiler, linker, etc. to get the Right Thing, which can be
                   8309:     pretty annoying especially if you don't have all the machines
                   8310:     at your hand to test things.  The
                   8311:     <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.23      wiz      8312:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8313:     both static and dynamic libraries from a set of source files,
                   8314:     thus being platform-independent.</p>
                   8315: <p>Here's how to use libtool in a package in seven simple
                   8316:     steps:</p>
1.23      wiz      8317: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8318: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8319:        Makefile.</p></li>
1.23      wiz      8320: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8321:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8322:        add it to the definition of <code class="varname">CC</code>, if only
                   8323:        libraries are being built in a given Makefile. This one command
                   8324:        will build both PIC and non-PIC library objects, so you need not
                   8325:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8326: <li class="listitem">
1.1       dsieger  8327: <p>For the linking of the library, remove any
1.23      wiz      8328:        <span class="quote">&#8220;<span class="quote">ar</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">ranlib</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">ld
                   8329:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8330: <pre class="programlisting">
                   8331: ${LIBTOOL} --mode=link \
                   8332:     ${CC} -o ${.TARGET:.a=.la} \
                   8333:         ${OBJS:.o=.lo} \
                   8334:         -rpath ${PREFIX}/lib \
                   8335:         -version-info major:minor
                   8336:        </pre>
                   8337: <p>Note that the library is changed to have a
                   8338:        <code class="filename">.la</code> extension, and the objects are
                   8339:        changed to have a <code class="filename">.lo</code>
                   8340:        extension. Change <code class="varname">OBJS</code> as
                   8341:        necessary. This automatically creates all of the
                   8342:        <code class="filename">.a</code>,
                   8343:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8344:        necessary) in the build directory. Be sure to include
1.23      wiz      8345:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8346:        minor are zero, as libtool will otherwise strip off the
                   8347:        shared library version.</p>
                   8348: <p>From the libtool manual:</p>
                   8349: <pre class="programlisting">
                   8350: So, libtool library versions are described by three integers:
                   8351: 
                   8352: CURRENT
                   8353: The most recent interface number that this library implements.
                   8354: 
                   8355: REVISION
                   8356: The implementation number of the CURRENT interface.
                   8357: 
                   8358: AGE
                   8359: The difference between the newest and oldest interfaces that
                   8360: this library implements.  In other words, the library implements
                   8361: all the interface numbers in the range from number `CURRENT -
                   8362: AGE' to `CURRENT'.
                   8363: 
                   8364: If two libraries have identical CURRENT and AGE numbers, then the
                   8365: dynamic linker chooses the library with the greater REVISION number.
                   8366:        </pre>
1.23      wiz      8367: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8368:        different results for a.out and ELF (excluding symlinks)
                   8369:        in only one case. An ELF library of the form
1.23      wiz      8370:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.1       dsieger  8371:        will have a symlink of
1.23      wiz      8372:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.1       dsieger  8373:        on an a.out platform. This is handled
                   8374:        automatically.</p>
1.23      wiz      8375: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8376:        directory of the library being built.</p>
                   8377: <p>In the <code class="filename">PLIST</code>, include only the
                   8378:        <code class="filename">.la</code> file, the other files will be
                   8379:        added automatically.</p>
                   8380: </li>
1.23      wiz      8381: <li class="listitem">
1.1       dsieger  8382: <p>When linking shared object (<code class="filename">.so</code>)
1.29      dholland 8383:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23      wiz      8384:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8385:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8386:        tacked on.</p>
                   8387: <p>The <code class="filename">PLIST</code> file gets the
                   8388:        <code class="filename">foo.so</code> entry.</p>
                   8389: </li>
1.23      wiz      8390: <li class="listitem">
1.1       dsieger  8391: <p>When linking programs that depend on these libraries
                   8392:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.29      dholland 8393:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      8394:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8395:        libraries (static or shared), but please be aware that
                   8396:        libtool will not allow you to specify a relative path in
1.23      wiz      8397:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8398:        expects you to change that argument to be the
                   8399:        <code class="filename">.la</code> file. e.g.</p>
                   8400: <pre class="programlisting">
                   8401: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8402:        </pre>
                   8403: <p>should be changed to:</p>
                   8404: <pre class="programlisting">
                   8405: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8406:        </pre>
                   8407: <p>and it will do the right thing with the libraries.</p>
                   8408: </li>
1.23      wiz      8409: <li class="listitem">
1.29      dholland 8410: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8411:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      8412:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8413:        <code class="filename">.la</code>. e.g.</p>
                   8414: <pre class="programlisting">
1.22      jakllsch 8415: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1       dsieger  8416:        </pre>
                   8417: <p>This will install the static <code class="filename">.a</code>,
                   8418:        shared library, any needed symlinks, and run
1.29      dholland 8419:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1       dsieger  8420: </li>
1.23      wiz      8421: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8422:        the <code class="filename">.la</code>
                   8423:        file (this is a change from previous behaviour).</p></li>
                   8424: </ol></div>
                   8425: </div>
1.23      wiz      8426: <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
1.1       dsieger  8427: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8428: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8429: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8430:     package Makefile. This will override the package's own libtool
                   8431:     in most cases.  For older libtool using packages,  libtool is
                   8432:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8433:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8434:     configure; find work*/ -name libtool</strong></span>.</p>
                   8435: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8436:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8437:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8438:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8439:     package's libtool script(s), set it as appropriate.</p>
                   8440: <p>If you do not need <code class="filename">*.a</code> static
                   8441:     libraries built and installed, then use
                   8442:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8443: <p>If your package makes use of the platform-independent library
                   8444:     for loading dynamic shared objects, that comes with libtool
                   8445:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8446: <p>Some packages use libtool incorrectly so that the package
                   8447:     may not work or build in some circumstances. Some of the more
                   8448:     common errors are:</p>
1.23      wiz      8449: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8450: <li class="listitem">
1.1       dsieger  8451: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8452:        executable or library. This in itself isn't a problem if one of two things
                   8453:        has been done:</p>
1.23      wiz      8454: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8455: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8456:            <code class="filename">libfoo.la</code>, not
                   8457:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8458: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8459: </ol></div>
                   8460: </li>
1.23      wiz      8461: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8462:        The function lt_dlinit() should be called and the macro
                   8463:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8464:        executables.</p></li>
                   8465: </ul></div>
                   8466: </div>
1.23      wiz      8467: <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
1.1       dsieger  8468: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8469: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8470: <p>If a package needs GNU autoconf or automake to be executed
                   8471:     to regenerate the configure script and Makefile.in makefile
                   8472:     templates, then they should be executed in a pre-configure
                   8473:     target.</p>
                   8474: <p>For packages that need only autoconf:</p>
                   8475: <pre class="programlisting">
                   8476: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8477: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8478: ...
                   8479: 
                   8480: pre-configure:
                   8481:         cd ${WRKSRC} &amp;&amp; autoconf
                   8482: 
                   8483: ...
                   8484:     </pre>
                   8485: <p>and for packages that need automake and autoconf:</p>
                   8486: <pre class="programlisting">
                   8487: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8488: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8489: ...
                   8490: 
                   8491: pre-configure:
                   8492:         set -e; cd ${WRKSRC}; \
                   8493:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8494: 
                   8495: ...
                   8496:     </pre>
                   8497: <p>Packages which use GNU Automake will almost certainly
                   8498:     require GNU Make.</p>
                   8499: <p>There are times when the configure process makes
                   8500:     additional changes to the generated files, which then causes
                   8501:     the build process to try to re-execute the automake sequence.
                   8502:     This is prevented by touching various files in the configure
                   8503:     stage. If this causes problems with your package you can set
                   8504:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8505:     Makefile.</p>
                   8506: </div>
                   8507: </div>
1.23      wiz      8508: <div class="sect1" title="19.4. Programming languages">
1.1       dsieger  8509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8510: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.23      wiz      8511: <div class="sect2" title="19.4.1. C, C++, and Fortran">
1.1       dsieger  8512: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8513: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8514: <p>Compilers for the C, C++, and Fortran languages comes with
                   8515:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8516:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  8517:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8518: <p>To declare which language's compiler a package needs, set
                   8519:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      8520:     currently are <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">c++</span>&#8221;</span>, and
                   8521:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8522:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8523:     written in C++, usually need a C compiler for the configure
                   8524:     phase.</p>
                   8525: </div>
1.23      wiz      8526: <div class="sect2" title="19.4.2. Java">
1.1       dsieger  8527: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8528: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8529: <p>If a program is written in Java, use the Java framework in
                   8530:     pkgsrc.  The package must include
                   8531:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8532:     provides the following variables:</p>
1.23      wiz      8533: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8534: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8535:       dependency on the JDK is added.  If
1.23      wiz      8536:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8537:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8538:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8539:       JDK.</p></li>
1.23      wiz      8540: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8541:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8542:       are <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span>, and
                   8543:       <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span>.  <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> accepts any Java2
                   8544:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8545:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8546:       above. This variable is not set by default.</p></li>
1.24      wiz      8547: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8548:       automatically set to the runtime location of the used Java
                   8549:       implementation dependency. It may be used to set
                   8550:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8551:       needs this variable to be defined.
                   8552:       </p></li>
1.1       dsieger  8553: </ul></div>
                   8554: </div>
1.23      wiz      8555: <div class="sect2" title="19.4.3. Packages containing perl scripts">
1.1       dsieger  8556: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8557: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8558: <p>If your package contains interpreted perl scripts, add
1.23      wiz      8559:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8560:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8561:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8562:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8563:     that you want adjusted.  Every occurrence of
                   8564:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8565:     path to the perl executable.</p>
                   8566: <p>If a particular version of perl is needed, set the
                   8567:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8568:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.10      hubertf  8569: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.1       dsieger  8570:     about handling perl modules.</p>
                   8571: </div>
1.40    ! wiz      8572: <div class="sect2" title="19.4.4. Packages containing shell scripts">
1.1       dsieger  8573: <div class="titlepage"><div><div><h3 class="title">
1.40    ! wiz      8574: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
        !          8575: <p><code class="varname">REPLACE_SH</code>,
        !          8576:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
        !          8577:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
        !          8578:     hash bangs in files. Please use the appropriate one, prefering
        !          8579:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
        !          8580:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
        !          8581:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
        !          8582: </div>
        !          8583: <div class="sect2" title="19.4.5. Other programming languages">
        !          8584: <div class="titlepage"><div><div><h3 class="title">
        !          8585: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  8586: <p>Currently, there is no special handling for other languages
                   8587:     in pkgsrc.  If a compiler package provides a
                   8588:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8589:     just add a (build) dependency on the appropriate compiler
                   8590:     package.</p>
                   8591: </div>
                   8592: </div>
1.23      wiz      8593: <div class="sect1" title="19.5. Fixing problems in the build phase">
1.1       dsieger  8594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8595: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  8596: <p>The most common failures when building a package are that
                   8597:        some platforms do not provide certain header files, functions or
                   8598:        libraries, or they provide the functions in a library that the
                   8599:        original package author didn't know. To work around this, you
                   8600:        can rewrite the source code in most cases so that it does not
                   8601:        use the missing functions or provides a replacement function.</p>
1.23      wiz      8602: <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
1.1       dsieger  8603: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8604: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8605: <p>If a package already comes with a GNU configure script, the
                   8606:        preferred way to fix the build failure is to change the
                   8607:        configure script, not the code. In the other cases, you can
                   8608:        utilize the C preprocessor, which defines certain macros
                   8609:        depending on the operating system and hardware architecture it
                   8610:        compiles for. These macros can be queried using for example
                   8611:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8612:        system, hardware architecture and compiler has its own macro.
                   8613:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8614:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8615:        are all defined, you know that you are using NetBSD on an i386
                   8616:        compatible CPU, and your compiler is GCC.</p>
                   8617: <p>The list of the following macros for hardware and
                   8618:        operating system depends on the compiler that is used. For
                   8619:        example, if you want to conditionally compile code on Solaris,
                   8620:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8621:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.23      wiz      8622: <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
1.1       dsieger  8623: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8624: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  8625: <p>To distinguish between 4.4 BSD-derived systems and the
                   8626:         rest of the world, you should use the following code.</p>
                   8627: <pre class="programlisting">
                   8628: #include &lt;sys/param.h&gt;
                   8629: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8630: /* BSD-specific code goes here */
                   8631: #else
                   8632: /* non-BSD-specific code goes here */
                   8633: #endif
                   8634: </pre>
                   8635: <p>If this distinction is not fine enough, you can also test
                   8636:        for the following macros.</p>
                   8637: <pre class="programlisting">
                   8638: FreeBSD     __FreeBSD__
                   8639: DragonFly   __DragonFly__
                   8640: Interix     __INTERIX
                   8641: IRIX        __sgi (TODO: get a definite source for this)
                   8642: Linux       linux, __linux, __linux__
                   8643: NetBSD      __NetBSD__
                   8644: OpenBSD     __OpenBSD__
                   8645: Solaris     sun, __sun
                   8646: </pre>
                   8647: </div>
1.23      wiz      8648: <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
1.1       dsieger  8649: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8650: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  8651: <pre class="programlisting">
                   8652: i386        i386, __i386, __i386__
                   8653: MIPS        __mips
                   8654: SPARC       sparc, __sparc
                   8655: </pre>
                   8656: </div>
1.23      wiz      8657: <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
1.1       dsieger  8658: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8659: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  8660: <pre class="programlisting">
                   8661: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8662: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8663: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8664: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8665: </pre>
                   8666: </div>
                   8667: </div>
1.23      wiz      8668: <div class="sect2" title="19.5.2. How to handle compiler bugs">
1.1       dsieger  8669: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8670: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8671: <p>Some source files trigger bugs in the compiler, based on
                   8672:         combinations of compiler version and architecture and almost
                   8673:         always relation to optimisation being enabled.  Common symptoms
                   8674:         are gcc internal errors or never finishing compiling a
                   8675:        file.</p>
                   8676: <p>Typically, a workaround involves testing the
                   8677:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8678:         optimisation for that combination of file,
                   8679:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8680:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8681:        number of examples.</p>
                   8682: </div>
1.23      wiz      8683: <div class="sect2" title="19.5.3. Undefined reference to &#8220;...&#8221;">
1.1       dsieger  8684: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz      8685: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8686: </h3></div></div></div>
1.1       dsieger  8687: <p>This error message often means that a package did not
                   8688:        link to a shared library it needs. The following functions are
                   8689:        known to cause this error message over and over.</p>
                   8690: <div class="informaltable">
                   8691: <a name="undefined-reference-functions"></a><table border="1">
                   8692: <colgroup>
                   8693: <col>
                   8694: <col>
                   8695: <col>
                   8696: </colgroup>
                   8697: <thead><tr>
                   8698: <th>Function</th>
                   8699: <th>Library</th>
                   8700: <th>Affected platforms</th>
                   8701: </tr></thead>
                   8702: <tbody>
                   8703: <tr>
                   8704: <td>accept, bind, connect</td>
                   8705: <td>-lsocket</td>
                   8706: <td>Solaris</td>
                   8707: </tr>
                   8708: <tr>
                   8709: <td>crypt</td>
                   8710: <td>-lcrypt</td>
                   8711: <td>DragonFly, NetBSD</td>
                   8712: </tr>
                   8713: <tr>
                   8714: <td>dlopen, dlsym</td>
                   8715: <td>-ldl</td>
                   8716: <td>Linux</td>
                   8717: </tr>
                   8718: <tr>
                   8719: <td>gethost*</td>
                   8720: <td>-lnsl</td>
                   8721: <td>Solaris</td>
                   8722: </tr>
                   8723: <tr>
                   8724: <td>inet_aton</td>
                   8725: <td>-lresolv</td>
                   8726: <td>Solaris</td>
                   8727: </tr>
                   8728: <tr>
                   8729: <td>nanosleep, sem_*, timer_*</td>
                   8730: <td>-lrt</td>
                   8731: <td>Solaris</td>
                   8732: </tr>
                   8733: <tr>
                   8734: <td>openpty</td>
                   8735: <td>-lutil</td>
                   8736: <td>Linux</td>
                   8737: </tr>
                   8738: </tbody>
                   8739: </table>
                   8740: </div>
                   8741: <p>To fix these linker errors, it is often sufficient to say
                   8742:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8743:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8744:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8745:     bmake</strong></span>.</p>
1.23      wiz      8746: <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
1.1       dsieger  8747: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8748: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8749: <p>When you are using the SunPro compiler, there is another
                   8750: possibility. That compiler cannot handle the following code:</p>
                   8751: <pre class="programlisting">
                   8752: extern int extern_func(int);
                   8753: 
                   8754: static inline int
                   8755: inline_func(int x)
                   8756: {
                   8757:         return extern_func(x);
                   8758: }
                   8759: 
                   8760: int main(void)
                   8761: {
                   8762:         return 0;
                   8763: }
                   8764: </pre>
                   8765: <p>It generates the code for <code class="function">inline_func</code> even if
                   8766: that function is never used. This code then refers to
                   8767: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8768: solve this problem you can try to tell the package to disable inlining
                   8769: of functions.</p>
                   8770: </div>
                   8771: </div>
1.23      wiz      8772: <div class="sect2" title="19.5.4. Running out of memory">
1.1       dsieger  8773: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8774: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8775: <p>Sometimes packages fail to build because the compiler runs
                   8776:     into an operating system specific soft limit.  With the
                   8777:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8778:     to unlimit the resources.  Currently, the allowed values are
1.23      wiz      8779:     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> (or both).
1.1       dsieger  8780:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8781:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8782:     segment size or maximum stack size of a process, respectively, to
                   8783:     their hard limits.</p>
                   8784: </div>
                   8785: </div>
1.23      wiz      8786: <div class="sect1" title="19.6. Fixing problems in the install phase">
1.1       dsieger  8787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8788: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.23      wiz      8789: <div class="sect2" title="19.6.1. Creating needed directories">
1.1       dsieger  8790: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8791: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8792: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8793:     with some operating systems cannot create more than one
                   8794:     directory at a time. As such, you should call
                   8795:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8796: <pre class="programlisting">
                   8797: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8798: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8799:     </pre>
1.23      wiz      8800: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8801:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8802:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8803:     automatically do the right thing.</p>
                   8804: </div>
1.23      wiz      8805: <div class="sect2" title="19.6.2. Where to install documentation">
1.1       dsieger  8806: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8807: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8808: <p>In general, documentation should be installed into
                   8809:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8810:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8811:     includes the version number of the package).</p>
                   8812: <p>Many modern packages using GNU autoconf allow to set the
                   8813:     directory where HTML documentation is installed with the
1.23      wiz      8814:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8815:     is needed because otherwise the documentation ends up in
                   8816:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8817:     places.</p>
                   8818: <p>An exception to the above is that library API documentation
                   8819:     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
                   8820:     browsers (devhelp) should be left at their default location, which
                   8821:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8822:     documentation can be recognized from files ending in
                   8823:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8824:     (It is also acceptable to install such files in
                   8825:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8826:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8827:     <code class="filename">.devhelp*</code> file must be directly in that
                   8828:     directory then, no additional subdirectory level is allowed in
                   8829:     this case. This is usually achieved by using
1.23      wiz      8830:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8831:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8832:     though.)</p>
                   8833: </div>
1.23      wiz      8834: <div class="sect2" title="19.6.3. Installing highscore files">
1.1       dsieger  8835: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8836: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8837: <p>Certain packages, most of them in the games category, install
                   8838:     a score file that allows all users on the system to record their
                   8839:     highscores.  In order for this to work, the binaries need to be
                   8840:     installed setgid and the score files owned by the appropriate
1.35      wiz      8841:     group and/or owner (traditionally the "games" user/group).  Set
                   8842:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8843:     following variables, documented in more detail in
                   8844:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8845:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8846:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
                   8847:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14      jmcneill 8848: <p>A package should therefore never hard code file ownership or
1.1       dsieger  8849:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8850:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8851:     correctly.</p>
                   8852: </div>
1.23      wiz      8853: <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
1.1       dsieger  8854: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8855: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8856: <p><code class="varname">DESTDIR</code> support means that a package
                   8857:     installs into a staging directory, not the final location of the
                   8858:     files. Then a binary package is created which can be used for
                   8859:     installation as usual. There are two ways: Either the package must
1.23      wiz      8860:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8861:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
                   8862: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8863: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38      wiz      8864:       set to <span class="quote">&#8220;<span class="quote">none</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>, or
                   8865:       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
                   8866:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8867:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8868:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8869:       the inclusion.</p></li>
1.23      wiz      8870: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8871:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8872: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8873:       automatically. Many manual rules and pre/post-install often are
                   8874:       incorrect; fix them.</p></li>
1.23      wiz      8875: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8876:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8877: <li class="listitem"><p>In general, packages should support
1.4       rillig   8878:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8879:       DESTDIR.</p></li>
                   8880: </ul></div>
                   8881: </div>
1.23      wiz      8882: <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
1.4       rillig   8883: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8884: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8885: <p>Your package may also contain scripts with hardcoded paths to
                   8886:       other interpreters besides (or as well as) perl.  To correct the
                   8887:       full pathname to the script interpreter, you need to set the
                   8888:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8889:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8890: <pre class="programlisting">
                   8891: REPLACE_INTERPRETER+=   tcl
                   8892: REPLACE.tcl.old=        .*/bin/tclsh
                   8893: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8894: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8895: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8896:     </pre>
1.23      wiz      8897: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8898: <h3 class="title">Note</h3>
                   8899: <p>Before March 2006, these variables were called
                   8900:     <code class="varname">_REPLACE.*</code> and
                   8901:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8902: </div>
                   8903: </div>
1.23      wiz      8904: <div class="sect2" title="19.6.6. Packages installing perl modules">
1.1       dsieger  8905: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8906: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8907: <p>Makefiles of packages providing perl5 modules should include
                   8908:     the Makefile fragment
                   8909:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8910:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8911:     configuration for such modules as well as various hooks to tune
                   8912:     this configuration.  See comments in this file for
                   8913:     details.</p>
                   8914: <p>Perl5 modules will install into different places depending
                   8915:     on the version of perl used during the build process.  To
                   8916:     address this, pkgsrc will append lines to the
                   8917:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8918:     the installed <code class="filename">.packlist</code> file generated by
                   8919:     most perl5 modules.  This is invoked by defining
                   8920:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8921:     paths to packlist files, e.g.:</p>
                   8922: <pre class="programlisting">
                   8923: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8924:     </pre>
                   8925: <p>The variables <code class="varname">PERL5_SITELIB</code>,
                   8926:     <code class="varname">PERL5_SITEARCH</code>, and
                   8927:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8928:     in which perl5 modules may be installed, and may be used by
                   8929:     perl5 packages that don't have a packlist.  These three
                   8930:     variables are also substituted for in the
                   8931:     <code class="filename">PLIST</code>.</p>
                   8932: </div>
1.23      wiz      8933: <div class="sect2" title="19.6.7. Packages installing info files">
1.1       dsieger  8934: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8935: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8936: <p>Some packages install info files or use the
1.23      wiz      8937:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.1       dsieger  8938:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8939:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8940:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8941:     handle registration of the info files in the Info directory
1.23      wiz      8942:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8943:     files registration is either provided by the system, or by a
                   8944:     special purpose package automatically added as dependency if
                   8945:     needed.</p>
                   8946: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8947:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8948:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8949:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8950: <p>The info files for the package should be listed in the
                   8951:     package <code class="filename">PLIST</code>; however any split info files
                   8952:     need not be listed.</p>
1.23      wiz      8953: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8954:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8955:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8956:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8957:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8958:     variable in the package <code class="filename">Makefile</code>. By
                   8959:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8960:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8961:     does not match the required minimum, a build dependency on the
                   8962:     <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
                   8963:     be added automatically.</p>
                   8964: <p>The build and installation process of the software provided
                   8965:     by the package should not use the
1.10      hubertf  8966:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8967:     info files is the task of the package
                   8968:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8969:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8970: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8971:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8972:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8973:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8974: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8975:     no effect except the logging of a message. The script overriding
1.10      hubertf  8976:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8977:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8978:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8979: </div>
1.23      wiz      8980: <div class="sect2" title="19.6.8. Packages installing man pages">
1.1       dsieger  8981: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8982: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8983: <p>All packages that install manual pages should install them
                   8984:     into the same directory, so that there is one common place to look
                   8985:     for them. In pkgsrc, this place is
                   8986:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8987:     should be used in packages. The default for
                   8988:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8989:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8990:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
                   8991: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8992: <h3 class="title">Note</h3>
                   8993: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8994:     is far from complete.</p>
                   8995: </div>
                   8996: <p>The <code class="filename">PLIST</code> files can just use
                   8997:     <code class="filename">man/</code> as the top level directory for the man
                   8998:     page file entries, and the pkgsrc framework will convert as
                   8999:     needed. In all other places, the correct
                   9000:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9001: <p>Packages that are
                   9002:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      9003:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  9004:     <code class="filename">./configure</code>
                   9005:     --mandir switch to set where the man pages should be installed.
                   9006:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9007:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9008: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9009:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      9010:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  9011:     Or if the <code class="filename">./configure</code> script uses
                   9012:     a non-standard use of --mandir, you can set
                   9013:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  9014: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.1       dsieger  9015:     information on installation of compressed manual pages.</p>
                   9016: </div>
1.23      wiz      9017: <div class="sect2" title="19.6.9. Packages installing GConf data files">
1.1       dsieger  9018: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   9019: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  9020: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   9021:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  9022:     you need to take some extra steps to make sure they get registered
                   9023:     in the database:</p>
1.23      wiz      9024: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9025: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  9026:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   9027:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  9028:        deinstallation time, and tells the package where to install
1.7       rillig   9029:        GConf data files using some standard configure arguments.  It
1.1       dsieger  9030:        also disallows any access to the database directly from the
                   9031:        package.</p></li>
1.23      wiz      9032: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  9033:        <code class="filename">.schemas</code> files under
                   9034:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9035:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9036:        need to manually patch the package.</p></li>
1.23      wiz      9037: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  9038:        directory, as they will be handled automatically.  See
1.10      hubertf  9039:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.23      wiz      9040: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  9041:        your <code class="filename">Makefile</code> with a list of all
                   9042:        <code class="filename">.schemas</code> files installed by the package, if
                   9043:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      9044: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  9045:        your <code class="filename">Makefile</code> with a
                   9046:        list of all <code class="filename">.entries</code> files installed by the
                   9047:        package, if any. Names must not contain any directories in
                   9048:        them.</p></li>
                   9049: </ol></div>
                   9050: </div>
1.23      wiz      9051: <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
1.1       dsieger  9052: <div class="titlepage"><div><div><h3 class="title">
1.18      snj      9053: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  9054: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      9055:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  9056:     get registered in the database:</p>
1.23      wiz      9057: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9058: <li class="listitem"><p>Include
1.18      snj      9059:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9060:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  9061:        takes care of rebuilding the scrollkeeper database at
                   9062:        installation and deinstallation time, and disallows any access
                   9063:        to it directly from the package.</p></li>
1.23      wiz      9064: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9065:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9066:        will be handled automatically.</p></li>
1.23      wiz      9067: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      9068:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9069:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  9070: </ol></div>
                   9071: </div>
1.23      wiz      9072: <div class="sect2" title="19.6.11. Packages installing X11 fonts">
1.1       dsieger  9073: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9074: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9075: <p>If a package installs font files, you will need to rebuild
                   9076:     the fonts database in the directory where they get installed at
                   9077:     installation and deinstallation time.  This can be automatically
                   9078:     done by using the pkginstall framework.</p>
                   9079: <p>You can list the directories where fonts are installed in the
                   9080:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9081:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9082:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.1       dsieger  9083:     Also make sure that the database file
                   9084:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9085: <p>Note that you should not create new directories for fonts;
                   9086:     instead use the standard ones to avoid that the user needs to
                   9087:     manually configure his X server to find them.</p>
                   9088: </div>
1.23      wiz      9089: <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
1.1       dsieger  9090: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9091: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  9092: <p>If a package installs GTK2 immodules or loaders, you need to
                   9093:     take some extra steps to get them registered in the GTK2 database
                   9094:     properly:</p>
1.23      wiz      9095: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9096: <li class="listitem"><p>Include
1.1       dsieger  9097:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9098:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9099:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      9100: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  9101:       your package installs GTK2 immodules.</p></li>
1.23      wiz      9102: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  9103:       GTK2 loaders.</p></li>
1.23      wiz      9104: <li class="listitem">
1.1       dsieger  9105: <p>Patch the package to not touch any of the GTK2
                   9106:       databases directly.  These are:</p>
1.23      wiz      9107: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9108: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9109: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  9110: </ul></div>
                   9111: </li>
1.23      wiz      9112: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  9113:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9114:       directory, as they will be handled automatically.</p></li>
                   9115: </ol></div>
                   9116: </div>
1.23      wiz      9117: <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
1.1       dsieger  9118: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9119: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9120: <p>If a package installs SGML or XML data files that need to be
                   9121:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9122:     etc.), you need to take some extra steps:</p>
1.23      wiz      9123: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9124: <li class="listitem"><p>Include
1.1       dsieger  9125:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9126:        your <code class="filename">Makefile</code>, which takes care of
                   9127:        registering those files in system-wide catalogs at
                   9128:        installation and deinstallation time.</p></li>
1.23      wiz      9129: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9130:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9131: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9132:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9133: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9134:        to be added to the SGML catalog.  These come in groups of
                   9135:        three strings; see xmlcatmgr(1) for more information
                   9136:        (specifically, arguments recognized by the 'add' action).
                   9137:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9138: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9139:        to be added to the XML catalog.  These come in groups of three
                   9140:        strings; see xmlcatmgr(1) for more information (specifically,
                   9141:        arguments recognized by the 'add' action).  Note that you will
                   9142:        normally not use this variable.</p></li>
                   9143: </ol></div>
                   9144: </div>
1.23      wiz      9145: <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
1.1       dsieger  9146: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9147: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9148: <p>If a package provides extensions to the MIME database by
                   9149:     installing <code class="filename">.xml</code> files inside
                   9150:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9151:     need to take some extra steps to ensure that the database is kept
                   9152:     consistent with respect to these new files:</p>
1.23      wiz      9153: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9154: <li class="listitem"><p>Include
1.1       dsieger  9155:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9156:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9157:        this same directory, which is reserved for inclusion from
                   9158:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9159:        care of rebuilding the MIME database at installation and
                   9160:        deinstallation time, and disallows any access to it directly
                   9161:        from the package.</p></li>
1.23      wiz      9162: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9163:        <code class="filename">share/mime</code> directory,
                   9164:        <span class="emphasis"><em>except</em></span> for files saved under
                   9165:        <code class="filename">share/mime/packages</code>.  The former are
                   9166:        handled automatically by
                   9167:        the update-mime-database program, but the latter are
                   9168:        package-dependent and must be removed by the package that
                   9169:        installed them in the first place.</p></li>
1.23      wiz      9170: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9171:        from the PLIST.  They will be handled by the shared-mime-info
                   9172:        package.</p></li>
                   9173: </ol></div>
                   9174: </div>
1.23      wiz      9175: <div class="sect2" title="19.6.15. Packages using intltool">
1.1       dsieger  9176: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9177: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9178: <p>If a package uses intltool during its build, add
                   9179:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9180:     which forces it to use the intltool package provided by pkgsrc,
                   9181:     instead of the one bundled with the distribution file.</p>
                   9182: <p>This tracks intltool's build-time dependencies and uses the
                   9183:     latest available version; this way, the package benefits of any
                   9184:     bug fixes that may have appeared since it was released.</p>
                   9185: </div>
1.23      wiz      9186: <div class="sect2" title="19.6.16. Packages installing startup scripts">
1.1       dsieger  9187: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9188: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9189: <p>If a package contains a rc.d script, it won't be copied into
                   9190:     the startup directory by default, but you can enable it, by adding
                   9191:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9192:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9193:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9194:     it will automatically remove the scripts when the package is
                   9195:     deinstalled.</p>
                   9196: </div>
1.23      wiz      9197: <div class="sect2" title="19.6.17. Packages installing TeX modules">
1.1       dsieger  9198: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9199: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9200: <p>If a package installs TeX packages into the texmf tree,
                   9201:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9202:     updated.</p>
1.23      wiz      9203: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9204: <h3 class="title">Note</h3>
1.22      jakllsch 9205: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9206:     packages should install files
1.22      jakllsch 9207:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9208:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9209: </div>
1.23      wiz      9210: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9211: <li class="listitem"><p>Include
1.22      jakllsch 9212:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9213:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9214:       database at installation and deinstallation time.</p></li>
1.23      wiz      9215: <li class="listitem">
1.1       dsieger  9216: <p>If your package installs files into a texmf
                   9217:       tree other than the one
1.22      jakllsch 9218:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9219:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9220:       trees that need database update.</p>
                   9221: <p>If your package also installs font map files that need
1.10      hubertf  9222:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9223:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9224:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9225:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9226:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9227:       be run automatically at installation/deinstallation to
                   9228:       enable/disable font map files for TeX output
                   9229:       drivers.</p>
                   9230: </li>
1.23      wiz      9231: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9232:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9233:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9234: </ol></div>
                   9235: </div>
1.23      wiz      9236: <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
1.1       dsieger  9237: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9238: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  9239:     emulation</h3></div></div></div>
                   9240: <p>There are some packages that provide libraries and
                   9241:     executables for running binaries from a one operating system
                   9242:     on a different one (if the latter supports it).  One example
                   9243:     is running Linux binaries on NetBSD.</p>
                   9244: <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>
                   9245:     helps in extracting and packaging Linux rpm packages.</p>
                   9246: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9247:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9248:     if all libraries for each installed executable can be found by
                   9249:     the dynamic linker.  Since the standard dynamic linker is run,
                   9250:     this fails for emulation packages, because the libraries used
                   9251:     by the emulation are not in the standard directories.</p>
                   9252: </div>
1.23      wiz      9253: <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
1.1       dsieger  9254: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9255: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9256: <p>If a package installs images under the
                   9257:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9258:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9259:     database, you need to take some extra steps to make sure that the
                   9260:     shared theme directory is handled appropriately and that the cache
                   9261:     database is rebuilt:</p>
1.23      wiz      9262: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9263: <li class="listitem"><p>Include
1.1       dsieger  9264:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      9265: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  9266:        entry that refers to the theme cache.</p></li>
1.23      wiz      9267: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  9268:          directories from the <code class="filename">share/icons/hicolor</code>
                   9269:          hierarchy because they will be handled automatically.</p></li>
                   9270: </ol></div>
                   9271: <p>The best way to verify that the PLIST is correct with
                   9272:       respect to the last two points is to regenerate it using
1.10      hubertf  9273:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  9274: </div>
1.23      wiz      9275: <div class="sect2" title="19.6.20. Packages installing desktop files">
1.1       dsieger  9276: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9277: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  9278: <p>If a package installs <code class="filename">.desktop</code> files
                   9279:       under <code class="filename">share/applications</code> and these include
                   9280:       MIME information, you need to take extra steps to ensure that they
                   9281:       are registered into the MIME database:</p>
1.23      wiz      9282: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9283: <li class="listitem"><p>Include
1.1       dsieger  9284:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      9285: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  9286:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9287:          It will be handled automatically.</p></li>
                   9288: </ol></div>
                   9289: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  9290:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  9291:       print-PLIST</strong></span>.</p>
                   9292: </div>
                   9293: </div>
1.23      wiz      9294: <div class="sect1" title="19.7. Marking packages as having problems">
1.1       dsieger  9295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9296: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9297: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 9298:   immediately. In this case, one can plainly mark a package as broken.  For
                   9299:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9300:   reason why the package is broken (similar to the
                   9301:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9302:   the package will immediately be shown this message, and the build
                   9303:   will not be even tried.</p>
                   9304: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  9305:   intervals.</p>
                   9306: </div>
                   9307: </div>
1.23      wiz      9308: <div class="chapter" title="Chapter 20. Debugging">
1.1       dsieger  9309: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9310: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9311: <p>To check out all the gotchas when building a package, here are
                   9312:   the steps that I do in order to get a package working.  Please note
                   9313:   this is basically the same as what was explained in the previous
                   9314:   sections, only with some debugging aids.</p>
1.23      wiz      9315: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9316: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
                   9317: <li class="listitem">
1.1       dsieger  9318: <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>,
                   9319:       create a directory for a new package, change into it, then run
1.10      hubertf  9320:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  9321: <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>
                   9322: <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>
                   9323: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9324: </li>
1.23      wiz      9325: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9326: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9327: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9328: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  9329:       configure step to the package's
                   9330:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      9331: <li class="listitem">
1.1       dsieger  9332: <p>Make the package compile, doing multiple rounds of</p>
                   9333: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9334: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9335: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9336: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9337: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9338: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9339: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9340: <p>Doing this step as non-root user will ensure that no files
                   9341:       are modified that shouldn't be, especially during the build
1.10      hubertf  9342:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9343:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1       dsieger  9344:       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>
                   9345:       package.</p>
                   9346: </li>
1.23      wiz      9347: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9348:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
                   9349: <li class="listitem">
1.1       dsieger  9350: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9351: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9352: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9353: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9354: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9355: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9356: <p>You usually need to be <code class="username">root</code> to do
                   9357:       this.  Look if there are any files left:</p>
                   9358: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9359: <p>If this reveals any files that are missing in
                   9360:       <code class="filename">PLIST</code>, add them.</p>
                   9361: </li>
1.23      wiz      9362: <li class="listitem">
1.1       dsieger  9363: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9364:       package again and make a binary package:</p>
                   9365: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9366: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9367: </li>
1.23      wiz      9368: <li class="listitem">
1.1       dsieger  9369: <p>Delete the installed package:</p>
                   9370: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9371: </li>
1.23      wiz      9372: <li class="listitem">
1.10      hubertf  9373: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  9374:       command, which shouldn't find anything now:</p>
                   9375: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9376: </li>
1.23      wiz      9377: <li class="listitem">
1.1       dsieger  9378: <p>Reinstall the binary package:</p>
                   9379: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9380: </li>
1.23      wiz      9381: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9382: <li class="listitem">
1.10      hubertf  9383: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1       dsieger  9384:       reports:</p>
                   9385: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9386: </li>
1.23      wiz      9387: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1       dsieger  9388: </ul></div>
                   9389: </div>
1.23      wiz      9390: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.1       dsieger  9391: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9392: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9393: <div class="toc">
                   9394: <p><b>Table of Contents</b></p>
                   9395: <dl>
1.6       rillig   9396: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9397: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9398: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz      9399: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   9400: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      9401: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9402: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9403: </dl>
                   9404: </div>
1.23      wiz      9405: <div class="sect1" title="21.1. Submitting binary packages">
1.1       dsieger  9406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9407: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9408: <p>Our policy is that we accept binaries only from pkgsrc
                   9409:        developers to guarantee that the packages don't contain any
                   9410:        trojan horses etc. This is not to annoy anyone but rather to
                   9411:        protect our users! You're still free to put up your home-made
                   9412:        binary packages and tell the world where to get them. NetBSD
                   9413:        developers doing bulk builds and wanting to upload them please
1.10      hubertf  9414:        see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.1       dsieger  9415: </div>
1.23      wiz      9416: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.1       dsieger  9417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9418: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9419: <p>First, check that your package is complete, compiles and
1.10      hubertf  9420:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.29      dholland 9421:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1       dsieger  9422:        archive that contains all files that make up the package.
                   9423:        Finally, send this package to the pkgsrc bug tracking system,
1.29      dholland 9424:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1       dsieger  9425:        that, go to the web page
1.10      hubertf  9426:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21      snj      9427:        which contains some instructions and a link to a form where you
                   9428:        can submit packages.  The
                   9429:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
                   9430:        also available as a substitute for either of the above two tools.
                   9431:        </p>
1.1       dsieger  9432: <p>In the form of the problem report, the category should be
1.23      wiz      9433:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9434:        and version number, and the description field should contain a
                   9435:        short description of your package (contents of the COMMENT
                   9436:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      9437:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  9438: <p>If you want to submit several packages, please send a
                   9439:        separate PR for each one, it's easier for us to track things
                   9440:        that way.</p>
                   9441: <p>Alternatively, you can also import new packages into
1.23      wiz      9442:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.10      hubertf  9443:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger  9444:        for details.</p>
                   9445: </div>
1.23      wiz      9446: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.1       dsieger  9447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9448: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9449: <p>Please note all package additions, updates, moves, and
                   9450:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9451:        important to keep this file up to date and conforming to the
                   9452:        existing format, because it will be used by scripts to
1.10      hubertf  9453:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9454:        sites. Additionally, check the
                   9455:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9456:        for the package you updated or removed, in case it was mentioned
                   9457:        there.</p>
                   9458: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9459:        bumped, the change should appear in
                   9460:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9461:        related or otherwise relevant. Mass bumps that result from a
                   9462:        dependency being updated should not be mentioned. In all other
                   9463:        cases it's the developer's decision.</p>
                   9464: <p>There is a make target that helps in creating proper
1.10      hubertf  9465:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9466:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9467:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9468:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9469:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9470:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9471:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9472:   For new packages, or package moves or removals, set the
                   9473:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9474:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9475:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9476:   not the same as your NetBSD login name. The target also automatically
                   9477:   removes possibly existing entries for the package in the
                   9478:   <code class="filename">TODO</code> file. Don't forget to commit
                   9479:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
                   9480:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9481:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9482:   makes the cvs commands use the main repository.
                   9483:   </p>
1.1       dsieger  9484: </div>
1.33      wiz      9485: <div class="sect1" title="21.4. Committing: Adding a package to CVS">
1.1       dsieger  9486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33      wiz      9487: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  9488: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      9489:   access to the pkgsrc repository.</p>
                   9490: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9491: Start by adding the directory and then files in the directory. Don't
                   9492: forget to add the new package to the category's
                   9493: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9494: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9495: <pre class="programlisting">
                   9496: <code class="prompt">$</code> cd .../pkgsrc/category
                   9497: <code class="prompt">$</code> cvs add pkgname
                   9498: <code class="prompt">$</code> cd pkgname
                   9499: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9500: <code class="prompt">$</code> cvs add patches/p*
                   9501: <code class="prompt">$</code> cvs status | less
1.34      wiz      9502: <code class="prompt">$</code> cvs commit
1.33      wiz      9503: <code class="prompt">$</code> cd ..
                   9504: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      9505: <code class="prompt">$</code> cvs commit Makefile
1.33      wiz      9506: </pre>
1.1       dsieger  9507: <p>The commit message of the initial import should include part of the
                   9508:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9509:   what the package is/does.</p>
1.33      wiz      9510: <p>Also mention the new package in
                   9511: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9512: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9513: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  9514: </div>
1.23      wiz      9515: <div class="sect1" title="21.5. Updating a package to a newer version">
1.1       dsieger  9516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9517: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9518: <p>Please always put a concise, appropriate and relevant summary of the
                   9519:   changes between old and new versions into the commit log when updating
                   9520:   a package. There are various reasons for this:</p>
1.23      wiz      9521: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9522: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9523:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9524: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9525:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9526: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9527:   repository is very useful for people who read the pkgsrc-changes mailing
                   9528:   list, so that they can make tactical decisions about when to upgrade
                   9529:   the package.</p></li>
                   9530: </ul></div>
                   9531: <p>Please also recognize that, just because a new version of a package
                   9532:   has been released, it should not automatically be upgraded in the CVS
                   9533:   repository.  We prefer to be conservative in the packages that are
                   9534:   included in pkgsrc - development or beta packages are not really the
                   9535:   best thing for most places in which pkgsrc is used. Please use your
                   9536:   judgement about what should go into pkgsrc, and bear in mind that
                   9537:   stability is to be preferred above new and possibly untested features.</p>
                   9538: </div>
1.23      wiz      9539: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.1       dsieger  9540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20      snj      9541: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9542: <p>Renaming packages is not recommended.</p>
                   9543: <p>When renaming packages, be sure to fix any references to old name
                   9544:   in other Makefiles, options, buildlink files, etc.</p>
                   9545: <p>Also When renaming a package, please define
                   9546:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9547:   pattern(s) of the previous package name.
                   9548:   This may be repeated for multiple renames.
                   9549:   The new package would be an exact replacement.
                   9550: </p>
1.23      wiz      9551: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9552:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9553:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9554:   not be an exact replacement but is a suggestion for the replaced
                   9555:   functionality.</p>
                   9556: </div>
1.23      wiz      9557: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.20      snj      9558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9559: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9560: <p>It is preferred that packages are not renamed or moved, but if needed
                   9561:   please follow these steps.
                   9562: </p>
1.23      wiz      9563: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9564: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9565: <li class="listitem">
1.1       dsieger  9566: <p>Remove all CVS dirs.</p>
                   9567: <p>Alternatively to the first two steps you can also do:</p>
                   9568: <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>
                   9569: <p>and use that for further work.</p>
                   9570: </li>
1.23      wiz      9571: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9572: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9573: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9574: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      9575: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9576: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9577: for doing an update using pkgsrc building; for example, it can
1.29      dholland 9578: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20      snj      9579: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9580: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9581: it may have multiple matches, so the tool should also check on the
                   9582: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9583: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9584: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9585: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9586: place.</p></li>
1.23      wiz      9587: <li class="listitem">
1.1       dsieger  9588: <p>Check if any package depends on it:
                   9589: </p>
                   9590: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9591: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9592: </li>
1.23      wiz      9593: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9594: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9595: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9596: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9597: <li class="listitem">
1.1       dsieger  9598: <p>Commit the changed and removed files:</p>
                   9599: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9600: <p>(and any packages from step 5, of course).</p>
                   9601: </li>
                   9602: </ol></div>
                   9603: </div>
                   9604: </div>
1.23      wiz      9605: <div class="chapter" title="Chapter 22. Frequently Asked Questions">
1.1       dsieger  9606: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9607: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9608: <p>This section contains the answers to questions that may
                   9609:        arise when you are writing a package. If you don't find your
                   9610:        question answered here, first have a look in the other chapters,
                   9611:        and if you still don't have the answer, ask on the
                   9612:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.23      wiz      9613: <div class="qandaset" title="Frequently Asked Questions">
1.40    ! wiz      9614: <a name="idm19487552"></a><dl>
1.6       rillig   9615: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9616:        MAKEFLAGS, .MAKEFLAGS and
                   9617:        MAKE_FLAGS?</a>
                   9618: </dt>
1.6       rillig   9619: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9620:        MAKE, GMAKE and
                   9621:        MAKE_PROGRAM?</a>
                   9622: </dt>
1.6       rillig   9623: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9624:        CC, PKG_CC and
                   9625:        PKGSRC_COMPILER?</a>
                   9626: </dt>
1.6       rillig   9627: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9628:        BUILDLINK_LDFLAGS,
                   9629:        BUILDLINK_LDADD and
                   9630:        BUILDLINK_LIBS?</a>
                   9631: </dt>
1.6       rillig   9632: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9633:        VARNAME=BUILDLINK_PREFIX.foo
                   9634:        say it's empty?</a>
                   9635: </dt>
1.6       rillig   9636: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9637:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9638:        don't understand the := inside
                   9639:        it.</a>
                   9640: </dt>
1.6       rillig   9641: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9642:        developers?</a>
                   9643: </dt>
1.6       rillig   9644: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9645:        documentation?</a>
                   9646: </dt>
1.6       rillig   9647: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9648: do?</a>
                   9649: </dt>
                   9650: </dl>
1.23      wiz      9651: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  9652: <col align="left" width="1%">
1.23      wiz      9653: <col>
1.1       dsieger  9654: <tbody>
1.23      wiz      9655: <tr class="question" title="22.1.">
1.1       dsieger  9656: <td align="left" valign="top">
1.40    ! wiz      9657: <a name="devfaq.makeflags"></a><a name="idm19487168"></a><p><b>22.1.</b></p>
1.1       dsieger  9658: </td>
                   9659: <td align="left" valign="top"><p>What is the difference between
                   9660:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9661:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9662: </tr>
                   9663: <tr class="answer">
                   9664: <td align="left" valign="top"></td>
                   9665: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29      dholland 9666:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1       dsieger  9667:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9668:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9669:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9670: </tr>
1.23      wiz      9671: <tr class="question" title="22.2.">
1.1       dsieger  9672: <td align="left" valign="top">
1.40    ! wiz      9673: <a name="devfaq.make"></a><a name="idm19483200"></a><p><b>22.2.</b></p>
1.1       dsieger  9674: </td>
                   9675: <td align="left" valign="top"><p>What is the difference between
                   9676:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9677:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9678: </tr>
                   9679: <tr class="answer">
                   9680: <td align="left" valign="top"></td>
                   9681: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29      dholland 9682:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1       dsieger  9683:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9684:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9685:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9686:        Make program that is used for building the
                   9687:        package.</p></td>
                   9688: </tr>
1.23      wiz      9689: <tr class="question" title="22.3.">
1.1       dsieger  9690: <td align="left" valign="top">
1.40    ! wiz      9691: <a name="devfaq.cc"></a><a name="idm19478720"></a><p><b>22.3.</b></p>
1.1       dsieger  9692: </td>
                   9693: <td align="left" valign="top"><p>What is the difference between
                   9694:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9695:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9696: </tr>
                   9697: <tr class="answer">
                   9698: <td align="left" valign="top"></td>
                   9699: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9700:        compiler, which can be configured by the pkgsrc user.
                   9701:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9702:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9703:        path to a compiler, but the type of compiler that should be
                   9704:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9705:        information about the latter variable.</p></td>
                   9706: </tr>
1.23      wiz      9707: <tr class="question" title="22.4.">
1.1       dsieger  9708: <td align="left" valign="top">
1.40    ! wiz      9709: <a name="devfaq.bl3flags"></a><a name="idm19474624"></a><p><b>22.4.</b></p>
1.1       dsieger  9710: </td>
                   9711: <td align="left" valign="top"><p>What is the difference between
                   9712:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9713:        <code class="varname">BUILDLINK_LDADD</code> and
                   9714:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9715: </tr>
                   9716: <tr class="answer">
                   9717: <td align="left" valign="top"></td>
                   9718: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9719: </tr>
1.23      wiz      9720: <tr class="question" title="22.5.">
1.1       dsieger  9721: <td align="left" valign="top">
1.40    ! wiz      9722: <a name="devfaq.bl3prefix"></a><a name="idm19472320"></a><p><b>22.5.</b></p>
1.1       dsieger  9723: </td>
1.10      hubertf  9724: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9725:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9726:        say it's empty?</p></td>
                   9727: </tr>
                   9728: <tr class="answer">
                   9729: <td align="left" valign="top"></td>
                   9730: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9731:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9732:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9733:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9734:        command.</p></td>
                   9735: </tr>
1.23      wiz      9736: <tr class="question" title="22.6.">
1.1       dsieger  9737: <td align="left" valign="top">
1.40    ! wiz      9738: <a name="devfaq.master_sites"></a><a name="idm19469248"></a><p><b>22.6.</b></p>
1.1       dsieger  9739: </td>
                   9740: <td align="left" valign="top"><p>What does
                   9741:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9742:        don't understand the <code class="literal">:=</code> inside
                   9743:        it.</p></td>
                   9744: </tr>
                   9745: <tr class="answer">
                   9746: <td align="left" valign="top"></td>
                   9747: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9748:        assignment operator, like you might expect at first sight.
                   9749:        Instead, it is a degenerate form of
                   9750:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29      dholland 9751:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.1       dsieger  9752:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9753:        case of <code class="varname">MASTER_SITE_*</code>,
                   9754:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9755:        <em class="replaceable"><code>new_string</code></em> is
                   9756:        <code class="literal">package/</code>. That's where the
                   9757:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9758:        together.</p></td>
                   9759: </tr>
1.23      wiz      9760: <tr class="question" title="22.7.">
1.1       dsieger  9761: <td align="left" valign="top">
1.40    ! wiz      9762: <a name="devfaq.mailinglists"></a><a name="idm19452992"></a><p><b>22.7.</b></p>
1.1       dsieger  9763: </td>
                   9764: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9765:        developers?</p></td>
                   9766: </tr>
                   9767: <tr class="answer">
                   9768: <td align="left" valign="top"></td>
                   9769: <td align="left" valign="top"><div class="variablelist"><dl>
1.10      hubertf  9770: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1       dsieger  9771: <dd><p>This is a list for technical discussions related
                   9772:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9773:        pkgsrc infrastructure, proposed new features, questions related
                   9774:        to porting pkgsrc to a new platform, advice for maintaining a
                   9775:        package, patches that affect many packages, help requests moved
                   9776:        from pkgsrc-users when an infrastructure bug is found,
                   9777:        etc.</p></dd>
1.10      hubertf  9778: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1       dsieger  9779: <dd><p>All bug reports in category "pkg" sent with
1.29      dholland 9780:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1       dsieger  9781:        directly; use one of the other mailing
                   9782:        lists.</p></dd>
                   9783: </dl></div></td>
                   9784: </tr>
1.23      wiz      9785: <tr class="question" title="22.8.">
1.1       dsieger  9786: <td align="left" valign="top">
1.40    ! wiz      9787: <a name="devfaq.documentation"></a><a name="idm19449280"></a><p><b>22.8.</b></p>
1.1       dsieger  9788: </td>
                   9789: <td align="left" valign="top"><p>Where is the pkgsrc
                   9790:        documentation?</p></td>
                   9791: </tr>
                   9792: <tr class="answer">
                   9793: <td align="left" valign="top"></td>
                   9794: <td align="left" valign="top">
                   9795: <p>There are many places where you can find
                   9796:        documentation about pkgsrc:</p>
1.23      wiz      9797: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9798: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9799:        of chapters that explain large parts of pkgsrc, but some
                   9800:        chapters tend to be outdated. Which ones they are is hard to
                   9801:        say.</p></li>
1.23      wiz      9802: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1       dsieger  9803:        about certain features, announcements of new parts of the pkgsrc
                   9804:        infrastructure and sometimes even announcements that a certain
                   9805:        feature has been marked as obsolete. The benefit here is that
                   9806:        each message has a date appended to it.</p></li>
1.23      wiz      9807: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9808:        <code class="filename">mk/</code> directory start with a comment that
                   9809:        describes the purpose of the file and how it can be used by the
                   9810:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9811:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9812:        help</strong></span>.</p></li>
1.23      wiz      9813: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9814:        information, but they tend to be highly abbreviated, especially
                   9815:        for actions that occur often. Some contain a detailed
                   9816:        description of what has changed, but they are geared towards the
                   9817:        other pkgsrc developers, not towards an average pkgsrc user.
                   9818:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9819:        don't know what has been before, these messages may not be worth
                   9820:        too much to you.</p></li>
1.23      wiz      9821: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9822:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9823:        mind of the developer who wrote the code. To get this
1.10      hubertf  9824:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9825:        to see who has written it and ask on the
                   9826:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9827:        find your questions later (see above). To be sure that the
                   9828:        developer in charge reads the mail, you may CC him or
                   9829:        her.</p></li>
                   9830: </ul></div>
                   9831: </td>
                   9832: </tr>
1.23      wiz      9833: <tr class="question" title="22.9.">
1.1       dsieger  9834: <td align="left" valign="top">
1.40    ! wiz      9835: <a name="devfaq.too-much-time"></a><a name="idm19442752"></a><p><b>22.9.</b></p>
1.1       dsieger  9836: </td>
                   9837: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9838: do?</p></td>
                   9839: </tr>
                   9840: <tr class="answer">
                   9841: <td align="left" valign="top"></td>
                   9842: <td align="left" valign="top">
                   9843: <p>This is not really an FAQ yet, but here's the answer
                   9844: anyway.</p>
1.23      wiz      9845: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9846: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1       dsieger  9847:     <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
                   9848:     will tell you about newer versions of installed packages that are
                   9849:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9850: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9851:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9852:     cleanups and enhancements for pkgsrc that would be nice to
                   9853:     have.</p></li>
1.23      wiz      9854: <li class="listitem"><p>Review packages for which review was requested on
1.10      hubertf  9855:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1       dsieger  9856:     mailing list.</p></li>
                   9857: </ul></div>
                   9858: </td>
                   9859: </tr>
                   9860: </tbody>
                   9861: </table>
                   9862: </div>
                   9863: </div>
1.23      wiz      9864: <div class="chapter" title="Chapter 23. GNOME packaging and porting">
1.1       dsieger  9865: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9866: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9867: <div class="toc">
                   9868: <p><b>Table of Contents</b></p>
                   9869: <dl>
1.6       rillig   9870: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9871: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9872: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9873: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9874: </dl>
                   9875: </div>
1.10      hubertf  9876: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9877: site</a>:</p>
                   9878: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9879:   environment, an intuitive and attractive desktop for users, and the
                   9880:   GNOME development platform, an extensive framework for building
                   9881:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9882: <p>pkgsrc provides a seamless way to automatically build and install
                   9883: a complete GNOME environment <span class="emphasis"><em>under many different
                   9884: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9885: the most advanced build and packaging systems for GNOME due to its
                   9886: included technologies buildlink3, the wrappers and tools framework and
                   9887: automatic configuration file management.  Lots of efforts are put into
                   9888: achieving a completely clean deinstallation of installed software
                   9889: components.</p>
1.10      hubertf  9890: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9891: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9892: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9893: pkgsrc as its preferred packaging system, contributing lots of
                   9894: portability fixes to make GNOME build and install under it.</p>
                   9895: <p>This chapter is aimed at pkgsrc developers and other people
                   9896: interested in helping our GNOME porting and packaging efforts.  It
                   9897: provides instructions on how to manage the existing packages and some
                   9898: important information regarding their internals.</p>
1.23      wiz      9899: <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9900: <h3 class="title">We need your help!</h3>
                   9901: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9902:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9903:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9904:   work</a> list!  There is still a long way to go to get a
                   9905:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9906:   achieve it!</p>
                   9907: </div>
1.23      wiz      9908: <div class="sect1" title="23.1. Meta packages">
1.1       dsieger  9909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9910: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9911: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.23      wiz      9912: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9913: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.1       dsieger  9914:     the core GNOME desktop environment.  It only includes the necessary
                   9915:     bits to get it to boot correctly, although it may lack important
                   9916:     functionality for daily operation.  The idea behind this package is
                   9917:     to let end users build their own configurations on top of this one,
                   9918:     first installing this meta package to achieve a functional setup and
                   9919:     then adding individual applications.</p></li>
1.23      wiz      9920: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1       dsieger  9921:     complete installation of the GNOME platform and desktop as defined
                   9922:     by the GNOME project; this is based on the components distributed in
                   9923:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9924:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9925:     official FTP server.  Developer-only tools found in those
                   9926:     directories are not installed unless required by some other
                   9927:     component to work properly.  Similarly, packages from the bindings
                   9928:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9929:     in unless required as a dependency for an end-user component.  This
                   9930:     package "extends" <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
1.23      wiz      9931: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1       dsieger  9932:     Installs all the tools required to build a GNOME component when
                   9933:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9934:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9935: </ul></div>
                   9936: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9937: sorted in a way that eases updates: a package may depend on other
                   9938: packages listed before it but not on any listed after it.  It is very
                   9939: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9940: change it to alphabetical sorting!</em></span></p>
                   9941: </div>
1.23      wiz      9942: <div class="sect1" title="23.2. Packaging a GNOME application">
1.1       dsieger  9943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9944: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9945: <p>Almost all GNOME applications are written in C and use a common
                   9946: set of tools as their build system.  Things get different with the new
                   9947: bindings to other languages (such as Python), but the following will
                   9948: give you a general idea on the minimum required tools:</p>
1.23      wiz      9949: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9950: <li class="listitem">
1.1       dsieger  9951: <p>Almost all GNOME applications use the GNU Autotools as their
                   9952:     build system.  As a general rule you will need to tell this to your
                   9953:     package:</p>
                   9954: <pre class="programlisting">
                   9955: GNU_CONFIGURE=yes
                   9956: USE_LIBTOOL=yes
                   9957: USE_TOOLS+=gmake
                   9958: </pre>
                   9959: </li>
1.23      wiz      9960: <li class="listitem">
1.1       dsieger  9961: <p>If the package uses pkg-config to detect dependencies, add this
                   9962:     tool to the list of required utilities:</p>
                   9963: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   9964: <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
                   9965:     the end of the build process to ensure that you did not miss to
                   9966:     specify any dependency in your package and that the version
                   9967:     requirements are all correct.</p>
                   9968: </li>
1.23      wiz      9969: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9970:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9971:     to handle dependencies and to force the package to use the latest
                   9972:     available version.</p></li>
1.23      wiz      9973: <li class="listitem">
1.1       dsieger  9974: <p>If the package uses gtk-doc (a documentation generation
                   9975:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9976:     tool is rather big and the distfile should come with pregenerated
                   9977:     documentation anyway; if it does not, it is a bug that you ought to
                   9978:     report.  For such packages you should disable gtk-doc (unless it is
                   9979:     the default):</p>
                   9980: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9981: <p>The default location of installed HTML files
                   9982:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9983:     and should not be changed unless the package insists on installing
                   9984:     them somewhere else.  Otherwise programs as
1.10      hubertf  9985:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9986:     do that with an entry similar to:</p>
                   9987: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   9988: </li>
                   9989: </ul></div>
                   9990: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9991: files under the installation prefix to maintain databases.  In this
                   9992: context, shared means that those exact same directories and files are
                   9993: used among several different packages, leading to conflicts in the
                   9994: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9995: handle the most common cases, so you have to forget about using
                   9996: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9997: omitting shared files from them.  If you find yourself doing those,
                   9998: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9999: <p>The following table lists the common situations that result in
                   10000: using shared directories or files.  For each of them, the appropriate
                   10001: solution is given.  After applying the solution be sure to
                   10002: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  10003: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  10004: <div class="table">
1.6       rillig   10005: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  10006: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   10007: <colgroup>
                   10008: <col>
                   10009: <col>
                   10010: </colgroup>
                   10011: <thead><tr>
                   10012: <th>If the package...</th>
                   10013: <th>Then...</th>
                   10014: </tr></thead>
                   10015: <tbody>
                   10016: <tr>
                   10017: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18      snj      10018: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.1       dsieger  10019: </tr>
                   10020: <tr>
                   10021: <td>Installs icons under the
                   10022:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10023:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  10024: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.1       dsieger  10025: </tr>
                   10026: <tr>
                   10027: <td>Installs files under
                   10028:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  10029: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.1       dsieger  10030: </tr>
                   10031: <tr>
                   10032: <td>Installs <code class="filename">.desktop</code> files under
                   10033:         <code class="filename">share/applications</code> and these include MIME
                   10034:         information.</td>
1.10      hubertf  10035: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.1       dsieger  10036: </tr>
                   10037: </tbody>
                   10038: </table></div>
                   10039: </div>
                   10040: <br class="table-break">
                   10041: </div>
1.23      wiz      10042: <div class="sect1" title="23.3. Updating GNOME to a newer version">
1.1       dsieger  10043: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10044: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  10045: <p>When seeing GNOME as a whole, there are two kinds of
                   10046: updates:</p>
                   10047: <div class="variablelist"><dl>
                   10048: <dt><span class="term">Major update</span></dt>
                   10049: <dd>
                   10050: <p>Given that there is still a very long way for GNOME 3 (if it
                   10051:       ever appears), we consider a major update one that goes from a
                   10052:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10053:       where <code class="literal">Y</code> is even and greater than
                   10054:       <code class="literal">X</code>.  These are hard to achieve because they
                   10055:       introduce lots of changes in the components' code and almost all
                   10056:       GNOME distfiles are updated to newer versions.  Some of them can
                   10057:       even break API and ABI compatibility with the previous major
                   10058:       version series.  As a result, the update needs to be done all at
                   10059:       once to minimize breakage.</p>
                   10060: <p>A major update typically consists of around 80 package
                   10061:       updates and the addition of some new ones.</p>
                   10062: </dd>
                   10063: <dt><span class="term">Minor update</span></dt>
                   10064: <dd>
                   10065: <p>We consider a minor update one that goes from a
                   10066:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10067:       one where <code class="literal">Y</code> is greater than
                   10068:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10069:       not update all GNOME components, can be done in an incremental way
                   10070:       and do not break API nor ABI compatibility.</p>
                   10071: <p>A minor update typically consists of around 50 package
                   10072:       updates, although the numbers here may vary a lot.</p>
                   10073: </dd>
                   10074: </dl></div>
                   10075: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10076: release (either major or minor), the following steps should be
                   10077: followed:</p>
1.23      wiz      10078: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10079: <li class="listitem">
1.1       dsieger  10080: <p>Get a list of all the tarballs that form the new release by
                   10081:     using the following commands.  These will leave the full list of the
1.18      snj      10082:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  10083:     file:</p>
                   10084: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10085:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10086:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10087: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10088:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10089:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10090: </li>
1.23      wiz      10091: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  10092:     bump their version to the release you are updating them to.  The
                   10093:     three meta packages should be always consistent with versioning.
                   10094:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10095:     in them.</p></li>
1.23      wiz      10096: <li class="listitem">
1.1       dsieger  10097: <p>For each meta package, update all its
                   10098:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10099:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10100:     newer version (even if found in the FTP) because the meta packages
                   10101:     are supposed to list the exact versions that form a specific GNOME
                   10102:     release.  Exceptions are permitted here if a newer version solves a
                   10103:     serious issue in the overall desktop experience; these typically
                   10104:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10105:     from the developers.</p>
                   10106: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10107:     should be updated to the latest version available (if found in
                   10108:     pkgsrc).  This is the case, for example, of the dependencies on the
                   10109:     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>
                   10110: </li>
1.23      wiz      10111: <li class="listitem">
1.1       dsieger  10112: <p>Generate a patch from the modified meta packages and extract the
                   10113:     list of "new" lines.  This will provide you an outline on what
                   10114:     packages need to be updated in pkgsrc and in what order:</p>
                   10115: <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>
                   10116: </li>
1.23      wiz      10117: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  10118:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      10119: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  10120:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10121:     it in order.  For major desktop updates none of these should be
                   10122:     committed until the entire set is completed because there are chances
                   10123:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      10124: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  10125:     the tree one by one with appropriate log messages.  At the end,
                   10126:     commit the three meta package updates and all the corresponding
                   10127:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10128:     <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>
                   10129: </ol></div>
                   10130: </div>
1.23      wiz      10131: <div class="sect1" title="23.4. Patching guidelines">
1.1       dsieger  10132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10133: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  10134: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10135: packages.  Please, it is very important that you always, always,
                   10136: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  10137: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.1       dsieger  10138: their attention on portability issues and to ensure that future versions
                   10139: can be built out-of-the box on NetBSD.  The less custom patches in
                   10140: pkgsrc, the easier further updates are.  Those developers in charge of
                   10141: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  10142: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1       dsieger  10143: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10144: of them do.  Do not be short on your reports: always provide detailed
                   10145: explanations of the current failure, how it can be improved to achieve
                   10146: maximum portability and, if at all possible, provide a patch against CVS
                   10147: head.  The more verbose you are, the higher chances of your patch being
                   10148: accepted.</p>
                   10149: <p>Also, please avoid using preprocessor magic to fix portability
                   10150: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10151: GNOME to their operating system, the official GNOME sources are now
                   10152: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10153: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  10154: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.1       dsieger  10155: details.</p>
                   10156: </div>
                   10157: </div>
                   10158: </div>
1.23      wiz      10159: <div class="part" title="Part III. The pkgsrc infrastructure internals">
1.1       dsieger  10160: <div class="titlepage"><div><div><h1 class="title">
                   10161: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.23      wiz      10162: <div class="partintro" title="The pkgsrc infrastructure internals">
1.1       dsieger  10163: <div></div>
                   10164: <p>This part of the guide deals with everything
                   10165:        from the infrastructure that is behind the interfaces described
                   10166:        in the developer's guide. A casual package maintainer should not
                   10167:        need anything from this part.</p>
                   10168: <div class="toc">
                   10169: <p><b>Table of Contents</b></p>
                   10170: <dl>
1.6       rillig   10171: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10172: <dd><dl>
1.6       rillig   10173: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10174: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10175: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10176: <dd><dl>
1.6       rillig   10177: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10178: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10179: </dl></dd>
1.6       rillig   10180: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10181: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10182: <dd><dl>
1.6       rillig   10183: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10184: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10185: </dl></dd>
1.6       rillig   10186: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10187: <dd><dl>
1.23      wiz      10188: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10189: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1       dsieger  10190: </dl></dd>
                   10191: </dl></dd>
1.6       rillig   10192: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10193: <dd><dl>
1.6       rillig   10194: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10195: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10196: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10197: <dd><dl>
1.6       rillig   10198: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10199: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10200: </dl></dd>
                   10201: </dl></dd>
1.6       rillig   10202: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10203: <dd><dl>
1.6       rillig   10204: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10205: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10206: </dl></dd>
                   10207: </dl>
                   10208: </div>
                   10209: </div>
1.23      wiz      10210: <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
1.1       dsieger  10211: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10212: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10213: <div class="toc">
                   10214: <p><b>Table of Contents</b></p>
                   10215: <dl>
1.6       rillig   10216: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10217: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10218: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10219: <dd><dl>
1.6       rillig   10220: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10221: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10222: </dl></dd>
1.6       rillig   10223: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10224: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10225: <dd><dl>
1.6       rillig   10226: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10227: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10228: </dl></dd>
1.6       rillig   10229: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10230: <dd><dl>
1.23      wiz      10231: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10232: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1       dsieger  10233: </dl></dd>
                   10234: </dl>
                   10235: </div>
                   10236: <p>The pkgsrc infrastructure consists of many small Makefile
                   10237:        fragments. Each such fragment needs a properly specified
                   10238:        interface. This chapter explains how such an interface looks
                   10239:        like.</p>
1.23      wiz      10240: <div class="sect1" title="24.1. The meaning of variable definitions">
1.1       dsieger  10241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10242: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10243: <p>Whenever a variable is defined in the pkgsrc
                   10244:        infrastructure, the location and the way of definition provide
                   10245:        much information about the intended use of that variable.
                   10246:        Additionally, more documentation may be found in a header
                   10247:        comment or in this pkgsrc guide.</p>
                   10248: <p>A special file is
                   10249:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10250:        variables that are intended to be user-defined. They are either
                   10251:        defined using the <code class="literal">?=</code> operator or they are
                   10252:        left undefined because defining them to anything would
1.23      wiz      10253:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10254:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10255:        file.</p>
                   10256: <p>Outside this file, the following conventions apply:
                   10257:        Variables that are defined using the <code class="literal">?=</code>
                   10258:        operator may be overridden by a package.</p>
                   10259: <p>Variables that are defined using the <code class="literal">=</code>
                   10260:        operator may be used read-only at run-time.</p>
                   10261: <p>Variables whose name starts with an underscore must not be
                   10262:        accessed outside the pkgsrc infrastructure at all. They may
                   10263:        change without further notice.</p>
1.23      wiz      10264: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10265: <h3 class="title">Note</h3>
                   10266: <p>These conventions are currently not applied
                   10267:        consistently to the complete pkgsrc
                   10268:        infrastructure.</p>
                   10269: </div>
                   10270: </div>
1.23      wiz      10271: <div class="sect1" title="24.2. Avoiding problems before they arise">
1.1       dsieger  10272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10273: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10274: <p>All variables that contain lists of things should default
                   10275:        to being empty. Two examples that do not follow this rule are
                   10276:        <code class="varname">USE_LANGUAGES</code> and
                   10277:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10278:        modified using the <code class="literal">+=</code> operator in package
                   10279:        <code class="filename">Makefile</code>s (or other files included by
                   10280:        them), since there is no guarantee whether the variable is
                   10281:        already set or not, and what its value is. In the case of
1.23      wiz      10282:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10283:        the default value and just define it as in the following
                   10284:        example.</p>
                   10285: <pre class="programlisting">
                   10286: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10287: </pre>
                   10288: <p>Because of the selection of this default value, the same
                   10289:        value appears in many package Makefiles. Similarly for
                   10290:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10291:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10292:        doesn't stand out. Nevertheless it is mentioned in many
                   10293:        files.</p>
                   10294: </div>
1.23      wiz      10295: <div class="sect1" title="24.3. Variable evaluation">
1.1       dsieger  10296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10297: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.23      wiz      10298: <div class="sect2" title="24.3.1. At load time">
1.1       dsieger  10299: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10300: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10301: <p>Variable evaluation takes place either at load time or at
                   10302:        runtime, depending on the context in which they occur. The
                   10303:        contexts where variables are evaluated at load time are:</p>
1.23      wiz      10304: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   10305: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10306:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10307: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10308:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10309: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10310: </ul></div>
                   10311: <p>A special exception are references to the iteration
                   10312:        variables of <code class="literal">.for</code> loops, which are expanded
                   10313:        inline, no matter in which context they appear.</p>
                   10314: <p>As the values of variables may change during load time,
                   10315:        care must be taken not to evaluate them by accident. Typical
                   10316:        examples for variables that should not be evaluated at load time
                   10317:        are <code class="varname">DEPENDS</code> and
                   10318:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10319:        clear, here is an example:</p>
                   10320: <pre class="programlisting">
                   10321: CONFIGURE_ARGS=         # none
                   10322: CFLAGS=                 -O
                   10323: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10324: 
                   10325: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10326: 
                   10327: CFLAGS+=                -Wall
                   10328:        </pre>
                   10329: <p>This code shows how the use of the <code class="literal">:=</code>
                   10330:        operator can quickly lead to unexpected results. The first
                   10331:        paragraph is fairly common code. The second paragraph evaluates
                   10332:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10333:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10334:        <code class="literal">-Wall</code> is appended to the
                   10335:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10336:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10337:        paragraphs from above typically occur in completely unrelated
                   10338:        files.</p>
                   10339: </div>
1.23      wiz      10340: <div class="sect2" title="24.3.2. At runtime">
1.1       dsieger  10341: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10342: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10343: <p>After all the files have been loaded, the values of the
                   10344:        variables cannot be changed anymore. Variables that are used in
                   10345:        the shell commands are expanded at this point.</p>
                   10346: </div>
                   10347: </div>
1.23      wiz      10348: <div class="sect1" title="24.4. How can variables be specified?">
1.1       dsieger  10349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10350: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10351: <p>There are many ways in which the definition and use of a
                   10352:        variable can be restricted in order to detect bugs and
                   10353:        violations of the (mostly unwritten) policies. See the
                   10354:        <code class="literal">pkglint</code> developer's documentation for further
                   10355:        details.</p>
                   10356: </div>
1.23      wiz      10357: <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
1.1       dsieger  10358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10359: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10360: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10361:        of the following classes. Cases where a file falls into more
                   10362:        than one class should be avoided as it often leads to subtle
                   10363:        bugs.</p>
1.23      wiz      10364: <div class="sect2" title="24.5.1. Procedures with parameters">
1.1       dsieger  10365: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10366: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10367: <p>In a traditional imperative programming language some of
                   10368:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10369:        procedures. They take some input parameters and&mdash;after
                   10370:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10371:        variables in <code class="filename">Makefile</code>s have global scope
                   10372:        care must be taken not to use parameter names that have already
                   10373:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10374:        bad choice for a parameter name.</p>
                   10375: <p>Procedures are completely evaluated at preprocessing time.
                   10376:        That is, when calling a procedure all input parameters must be
                   10377:        completely resolvable. For example,
                   10378:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10379:        parameter since it is very likely that further text will be
                   10380:        added after calling the procedure, which would effectively apply
                   10381:        the procedure to only a part of the variable. Also, references
                   10382:        to other variables wit will be modified after calling the
                   10383:        procedure.</p>
                   10384: <p>A procedure can declare its output parameters either as
                   10385:        suitable for use in preprocessing directives or as only
                   10386:        available at runtime. The latter alternative is for variables
                   10387:        that contain references to other runtime variables.</p>
                   10388: <p>Procedures shall be written such that it is possible to
                   10389:        call the procedure more than once. That is, the file must not
                   10390:        contain multiple-inclusion guards.</p>
                   10391: <p>Examples for procedures are
                   10392:        <code class="filename">mk/bsd.options.mk</code> and
                   10393:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10394:        that the parameters are evaluated at load time, they should be
                   10395:        assigned using the <code class="literal">:=</code> operator, which should
                   10396:        be used only for this purpose.</p>
                   10397: </div>
1.23      wiz      10398: <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
1.1       dsieger  10399: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10400: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10401: <p>Action files take some input parameters and may define
                   10402:        runtime variables. They shall not define loadtime variables.
                   10403:        There are action files that are included implicitly by the
                   10404:        pkgsrc infrastructure, while other must be included
                   10405:        explicitly.</p>
                   10406: <p>An example for action files is
                   10407:        <code class="filename">mk/subst.mk</code>.</p>
                   10408: </div>
                   10409: </div>
1.23      wiz      10410: <div class="sect1" title="24.6. The order in which files are loaded">
1.1       dsieger  10411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10412: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10413: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10414:        a set of variable definitions, and include the file
                   10415:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10416:        Before that, they may also include various other
                   10417:        <code class="filename">*.mk</code> files if they need to query the
                   10418:        availability of certain features like the type of compiler or
                   10419:        the X11 implementation. Due to the heavy use of preprocessor
                   10420:        directives like <code class="literal">.if</code> and
                   10421:        <code class="literal">.for</code>, the order in which the files are loaded
                   10422:        matters.</p>
                   10423: <p>This section describes at which point the various files
                   10424:        are loaded and gives reasons for that order.</p>
1.23      wiz      10425: <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
1.1       dsieger  10426: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10427: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10428: </h3></div></div></div>
                   10429: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10430:        is to define some essential variables like
                   10431:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10432:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10433: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10434:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   10435:        After that, those variables
1.1       dsieger  10436:        that have not been overridden by the user are loaded from
                   10437:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10438: <p>After the user settings, the system settings and platform
                   10439:        settings are loaded, which may override the user
                   10440:        settings.</p>
                   10441: <p>Then, the tool definitions are loaded. The tool wrappers
                   10442:        are not yet in effect. This only happens when building a
                   10443:        package, so the proper variables must be used instead of the
                   10444:        direct tool names.</p>
                   10445: <p>As the last steps, some essential variables from the
                   10446:        wrapper and the package system flavor are loaded, as well as the
                   10447:        variables that have been cached in earlier phases of a package
                   10448:        build.</p>
                   10449: </div>
1.23      wiz      10450: <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
1.1       dsieger  10451: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10452: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10453: </h3></div></div></div>
                   10454: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10455: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10456:        loaded, which fill default values for those variables that have
                   10457:        not been defined by the package. These variables may later
                   10458:        be used even in unrelated files.</p>
                   10459: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10460:        provides the target <code class="literal">error-check</code> that is added
                   10461:        as a special dependency to all other targets that use
                   10462:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10463:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10464: <p>Then, the package-specific hacks from
                   10465:        <code class="filename">hacks.mk</code> are included.</p>
                   10466: <p>Then, various other files follow. Most of them don't have
                   10467:        any dependencies on what they need to have included before or
                   10468:        after them, though some do.</p>
                   10469: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10470:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10471:        restricts the use of these variables to all the files that have
                   10472:        been included before. Appearances in later files will be
                   10473:        silently ignored.</p>
                   10474: <p>Then, the files for the main targets are included, in the
                   10475:        order of later execution, though the actual order should not
                   10476:        matter.</p>
                   10477: <p>At last, some more files are included that don't set any
                   10478:        interesting variables but rather just define make targets to be
                   10479:        executed.</p>
                   10480: </div>
                   10481: </div>
                   10482: </div>
1.23      wiz      10483: <div class="chapter" title="Chapter 25. Regression tests">
1.1       dsieger  10484: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10485: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10486: <div class="toc">
                   10487: <p><b>Table of Contents</b></p>
                   10488: <dl>
1.6       rillig   10489: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10490: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10491: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10492: <dd><dl>
1.6       rillig   10493: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10494: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10495: </dl></dd>
                   10496: </dl>
                   10497: </div>
                   10498: <p>The pkgsrc infrastructure consists of a large codebase,
                   10499:        and there are many corners where every little bit of a file is
                   10500:        well thought out, making pkgsrc likely to fail as soon as
                   10501:        anything is changed near those parts. To prevent most changes
                   10502:        from breaking anything, a suite of regression tests should go
                   10503:        along with every important part of the pkgsrc infrastructure.
                   10504:        This chapter describes how regression tests work in pkgsrc and
                   10505:        how you can add new tests.</p>
1.23      wiz      10506: <div class="sect1" title="25.1. The regression tests framework">
1.1       dsieger  10507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10508: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10509: <p></p>
                   10510: </div>
1.23      wiz      10511: <div class="sect1" title="25.2. Running the regression tests">
1.1       dsieger  10512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10513: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10514: <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.10      hubertf  10515:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10516:        can simply run that command, which will run all tests in the
                   10517:        <code class="filename">regress</code> category.</p>
                   10518: </div>
1.23      wiz      10519: <div class="sect1" title="25.3. Adding a new regression test">
1.1       dsieger  10520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10521: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10522: <p>Every directory in the <code class="filename">regress</code>
                   10523:        category that contains a file called <code class="filename">spec</code>
                   10524:        is considered a regression test. This file is a shell program
1.10      hubertf  10525:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10526:        The following functions can be overridden to suit your
                   10527:        needs.</p>
1.23      wiz      10528: <div class="sect2" title="25.3.1. Overridable functions">
1.1       dsieger  10529: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10530: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10531: <p>These functions do not take any parameters. They are all
1.23      wiz      10532:        called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
1.1       dsieger  10533:        to check the exitcodes of any commands you run in the
                   10534:        test.</p>
                   10535: <div class="variablelist"><dl>
                   10536: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10537: <dd><p>This function prepares the environment for the
                   10538:        test. By default it does nothing.</p></dd>
                   10539: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10540: <dd><p>This function runs the actual test. By default,
                   10541:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10542:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10543:        error messages into the file
                   10544:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10545: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10546: <dd><p>This function is run after the test and is
                   10547:        typically used to compare the actual output from the one that is
                   10548:        expected. It can make use of the various helper functions from
                   10549:        the next section.</p></dd>
                   10550: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10551: <dd><p>This function cleans everything up after the
                   10552:        test has been run. By default it does nothing.</p></dd>
                   10553: </dl></div>
                   10554: </div>
1.23      wiz      10555: <div class="sect2" title="25.3.2. Helper functions">
1.1       dsieger  10556: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10557: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1       dsieger  10558: <div class="variablelist"><dl>
                   10559: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10560: <dd><p>This function compares the exitcode of the
1.10      hubertf  10561:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1       dsieger  10562:        If they differ, the test will fail.</p></dd>
                   10563: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10564: <dd><p>This function checks for each of its parameters
1.10      hubertf  10565:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1       dsieger  10566:        extended regular expression. If it does not, the test will
                   10567:        fail.</p></dd>
                   10568: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10569: <dd><p>This function checks for each of its parameters
1.10      hubertf  10570:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10571:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10572:        If any of the regular expressions matches, the test will
                   10573:        fail.</p></dd>
                   10574: </dl></div>
                   10575: </div>
                   10576: </div>
                   10577: </div>
1.23      wiz      10578: <div class="chapter" title="Chapter 26. Porting pkgsrc">
1.1       dsieger  10579: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10580: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10581: <div class="toc">
                   10582: <p><b>Table of Contents</b></p>
                   10583: <dl>
1.6       rillig   10584: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10585: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10586: </dl>
                   10587: </div>
                   10588: <p>The pkgsrc system has already been ported to many
                   10589:        operating systems, hardware architectures and compilers. This
                   10590:        chapter explains the necessary steps to make pkgsrc even more
                   10591:        portable.</p>
1.23      wiz      10592: <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
1.1       dsieger  10593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10594: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10595: <p>To port pkgsrc to a new operating system (called
                   10596:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10597:        following files:</p>
                   10598: <div class="variablelist"><dl>
                   10599: <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>
                   10600: <dd><p>This file contains some basic definitions, for
                   10601:        example the name of the C
                   10602:        compiler.</p></dd>
                   10603: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10604: <dd><p>Insert code that defines the variables
                   10605:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10606:        <code class="varname">LOWER_OS_VERSION</code>,
                   10607:        <code class="varname">LOWER_VENDOR</code>,
                   10608:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10609:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10610:        appear in this file.</p></dd>
                   10611: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10612: <dd><p>This file contains the platform-specific
                   10613:        definitions that are used by pkgsrc. Start by copying one of the
                   10614:        other files and edit it to your
                   10615:        needs.</p></dd>
                   10616: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10617: <dd><p>This file contains a list of directories,
                   10618:        together with their permission bits and ownership. These
                   10619:        directories will be created automatically with every package
                   10620:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10621:        be removed.</p></dd>
                   10622: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10623: <dd><p>Just copy one of the pre-existing x11.dist files
                   10624:        to your
                   10625:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10626: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10627: <dd><p>On some operating systems, the tools that are
                   10628:        provided with the base system are not good enough for pkgsrc.
1.29      dholland 10629:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.1       dsieger  10630:        narrow limit on the line length they can process. Therefore
                   10631:        pkgsrc brings its own tools, which can be enabled
                   10632:        here.</p></dd>
                   10633: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10634: <dd><p>This file defines the paths to all the tools
                   10635:        that are needed by one or the other package in pkgsrc, as well
                   10636:        as by pkgsrc itself. Find out where these tools are on your
                   10637:        platform and add them.</p></dd>
                   10638: </dl></div>
                   10639: <p>Now, you should be able to build some basic packages, like
                   10640:        <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>
                   10641: </div>
1.23      wiz      10642: <div class="sect1" title="26.2. Adding support for a new compiler">
1.1       dsieger  10643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10644: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10645: <p>TODO</p>
                   10646: </div>
                   10647: </div>
                   10648: </div>
1.23      wiz      10649: <div class="appendix" title="Appendix A. A simple example package: bison">
1.1       dsieger  10650: <div class="titlepage"><div><div><h2 class="title">
                   10651: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10652: <div class="toc">
                   10653: <p><b>Table of Contents</b></p>
                   10654: <dl>
                   10655: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10656: <dd><dl>
                   10657: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10658: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10659: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10660: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1       dsieger  10661: </dl></dd>
                   10662: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10663: </dl>
                   10664: </div>
                   10665: <p>We checked to find a piece of software that wasn't in the packages
                   10666:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10667:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10668:     present in the tree is beyond us, but it's useful for the purposes of
                   10669:     this exercise.</p>
1.23      wiz      10670: <div class="sect1" title="A.1. files">
1.1       dsieger  10671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10672: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.23      wiz      10673: <div class="sect2" title="A.1.1. Makefile">
1.1       dsieger  10674: <div class="titlepage"><div><div><h3 class="title">
                   10675: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10676: <pre class="programlisting">
                   10677: # $NetBSD$
                   10678: #
                   10679: 
                   10680: DISTNAME=       bison-1.25
                   10681: CATEGORIES=     devel
                   10682: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10683: 
1.29      dholland 10684: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10685: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10686: COMMENT=        GNU yacc clone
                   10687: 
                   10688: GNU_CONFIGURE=  yes
                   10689: INFO_FILES=     bison.info
                   10690: 
                   10691: .include "../../mk/bsd.pkg.mk"
                   10692: </pre>
                   10693: </div>
1.23      wiz      10694: <div class="sect2" title="A.1.2. DESCR">
1.1       dsieger  10695: <div class="titlepage"><div><div><h3 class="title">
                   10696: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10697: <pre class="programlisting">
                   10698: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.29      dholland 10699: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1       dsieger  10700: of the NetBSD source tree is beyond me.
                   10701: </pre>
                   10702: </div>
1.23      wiz      10703: <div class="sect2" title="A.1.3. PLIST">
1.1       dsieger  10704: <div class="titlepage"><div><div><h3 class="title">
                   10705: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10706: <pre class="programlisting">
                   10707: @comment $NetBSD$
                   10708: bin/bison
                   10709: man/man1/bison.1.gz
                   10710: share/bison.simple
                   10711: share/bison.hairy
                   10712: </pre>
                   10713: </div>
1.23      wiz      10714: <div class="sect2" title="A.1.4. Checking a package with pkglint">
1.1       dsieger  10715: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10716: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10717: </h3></div></div></div>
                   10718: <p>The NetBSD package system comes with
                   10719:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10720:        which helps to check the contents of these
                   10721:        files. After installation it is quite easy to use, just change to the
                   10722:        directory of the package you wish to examine and execute
1.10      hubertf  10723:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10724: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10725: looks fine.</pre>
                   10726: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10727:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10728:        -Wall</strong></span> for a very thorough check.</p>
                   10729: </div>
                   10730: </div>
1.23      wiz      10731: <div class="sect1" title="A.2. Steps for building, installing, packaging">
1.1       dsieger  10732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10733: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10734: <p>Create the directory where the package lives,
                   10735:       plus any auxiliary directories:</p>
                   10736: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10737: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10738: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10739: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10740: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  10741:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1       dsieger  10742:       then continue with fetching the distfile:</p>
                   10743: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10744: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10745: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10746: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10747: ftp: Error retrieving file: 500 Internal error
                   10748: 
                   10749: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10750: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10751: ftp: Error retrieving file: 500 Internal error
                   10752: 
                   10753: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10754: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10755: Successfully retrieved file.</pre>
                   10756: <p>Generate the checksum of the distfile into
                   10757:       <code class="filename">distinfo</code>:</p>
                   10758: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10759: <p>Now compile:</p>
                   10760: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10761: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10762: ===&gt;  Extracting for bison-1.25
                   10763: ===&gt;  Patching for bison-1.25
                   10764: ===&gt;   Ignoring empty patch directory
                   10765: ===&gt;  Configuring for bison-1.25
                   10766: creating cache ./config.cache
                   10767: checking for gcc... cc
                   10768: checking whether we are using GNU C... yes
                   10769: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10770: checking how to run the C preprocessor... cc -E
                   10771: checking for minix/config.h... no
                   10772: checking for POSIXized ISC... no
                   10773: checking whether cross-compiling... no
                   10774: checking for ANSI C header files... yes
                   10775: checking for string.h... yes
                   10776: checking for stdlib.h... yes
                   10777: checking for memory.h... yes
                   10778: checking for working const... yes
                   10779: checking for working alloca.h... no
                   10780: checking for alloca... yes
                   10781: checking for strerror... yes
                   10782: updating cache ./config.cache
                   10783: creating ./config.status
                   10784: creating Makefile
                   10785: ===&gt;  Building for bison-1.25
                   10786: 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
                   10787: 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
                   10788: 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
                   10789: 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
                   10790: 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
                   10791: 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
                   10792: 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
                   10793: 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
                   10794: 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
                   10795: 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
                   10796: 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
                   10797: 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
                   10798: 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
                   10799: 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
                   10800: 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
                   10801: 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
                   10802: 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
                   10803: 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
                   10804: 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
                   10805: 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
                   10806: 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
                   10807: 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
                   10808: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10809: rm -f bison.s1
                   10810: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10811: <p>Everything seems OK, so install the files:</p>
                   10812: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10813: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10814: ===&gt;  Installing for bison-1.25
                   10815: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10816: rm -f /usr/pkg/bin/bison
                   10817: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10818: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10819: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10820: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10821: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10822: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10823: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10824: ===&gt;  Registering installation for bison-1.25</pre>
                   10825: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10826:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10827:       binary package, do this now:</p>
                   10828: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10829: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10830: ===&gt;  Building package for bison-1.25
                   10831: Creating package bison-1.25.tgz
                   10832: Registering depends:.
                   10833: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10834: <p>Now that you don't need the source and object files
                   10835:       any more, clean up:</p>
                   10836: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10837: ===&gt;  Cleaning for bison-1.25</pre>
                   10838: </div>
                   10839: </div>
1.23      wiz      10840: <div class="appendix" title="Appendix B. Build logs">
1.1       dsieger  10841: <div class="titlepage"><div><div><h2 class="title">
                   10842: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10843: <div class="toc">
                   10844: <p><b>Table of Contents</b></p>
                   10845: <dl>
                   10846: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10847: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10848: </dl>
                   10849: </div>
1.23      wiz      10850: <div class="sect1" title="B.1. Building figlet">
1.1       dsieger  10851: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10852: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10854: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10855: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10856: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10857: =&gt; [172219 bytes]
                   10858: Connected to ftp.plig.net.
                   10859: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10860: 331 Guest login ok, send your complete e-mail address as password.
                   10861: 230-You are user #5 of 500 simultaneous users allowed.
                   10862: 230-
                   10863: 230-  ___ _             _ _
                   10864: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10865: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10866: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10867: 230-         |_|   |_|     |___|         |___|
                   10868: 230-
                   10869: 230-** Welcome to ftp.plig.org **
                   10870: 230-
                   10871: 230-Please note that all transfers from this FTP site are logged. If you
                   10872: 230-do not like this, please disconnect now.
                   10873: 230-
1.18      snj      10874: 230-This archive is available via
1.1       dsieger  10875: 230-
                   10876: 230-HTTP:  http://ftp.plig.org/
                   10877: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10878: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10879: 230-
                   10880: 230-Please email comments, bug reports and requests for packages to be
                   10881: 230-mirrored to ftp-admin@plig.org.
                   10882: 230-
                   10883: 230-
                   10884: 230 Logged in anonymously.
                   10885: Remote system type is UNIX.
                   10886: Using binary mode to transfer files.
                   10887: 200 Type okay.
                   10888: 250 "/pub" is new cwd.
                   10889: 250-"/pub/figlet" is new cwd.
                   10890: 250-
                   10891: 250-Welcome to the figlet archive at ftp.figlet.org
                   10892: 250-
                   10893: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10894: 250-
                   10895: 250-The official FIGlet web page is:
                   10896: 250-   http://www.figlet.org/
                   10897: 250-
                   10898: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10899: 250-contribute a font or something else, you can email us.
                   10900: 250
                   10901: 250 "/pub/figlet/program" is new cwd.
                   10902: 250 "/pub/figlet/program/unix" is new cwd.
                   10903: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10904: 502 Unimplemented command.
                   10905: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10906: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10907: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10908: 226 Transfer completed.
                   10909: 172219 bytes received in 00:02 (75.99 KB/s)
                   10910: 221 Goodbye.
                   10911: =&gt; Checksum OK for figlet221.tar.gz.
                   10912: ===&gt; Extracting for figlet-2.2.1nb2
                   10913: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10914: ===&gt; Patching for figlet-2.2.1nb2
                   10915: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10916: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10917: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10918: ===&gt; Configuring for figlet-2.2.1nb2
                   10919: ===&gt; Building for figlet-2.2.1nb2
                   10920: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10921: chmod a+x figlet
                   10922: gcc -O2 -o chkfont chkfont.c
                   10923: =&gt; Unwrapping files-to-be-installed.
                   10924: <code class="prompt">#</code>
                   10925: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10926: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10927: ===&gt; Installing for figlet-2.2.1nb2
                   10928: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10929: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10930: mkdir -p /usr/pkg/share/figlet
                   10931: cp figlet /usr/pkg/bin
                   10932: cp chkfont /usr/pkg/bin
                   10933: chmod 555 figlist showfigfonts
                   10934: cp figlist /usr/pkg/bin
                   10935: cp showfigfonts /usr/pkg/bin
                   10936: cp fonts/*.flf /usr/pkg/share/figlet
                   10937: cp fonts/*.flc /usr/pkg/share/figlet
                   10938: cp figlet.6 /usr/pkg/man/man6
                   10939: ===&gt; Registering installation for figlet-2.2.1nb2
                   10940: <code class="prompt">#</code></pre>
                   10941: </div>
1.23      wiz      10942: <div class="sect1" title="B.2. Packaging figlet">
1.1       dsieger  10943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10944: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10945: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10946: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10947: ===&gt; Packaging figlet-2.2.1nb2
                   10948: ===&gt; Building binary package for figlet-2.2.1nb2
                   10949: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10950: Using SrcDir value of /usr/pkg
                   10951: Registering depends:.
                   10952: <code class="prompt">#</code></pre>
                   10953: </div>
                   10954: </div>
1.23      wiz      10955: <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
1.1       dsieger  10956: <div class="titlepage"><div><div><h2 class="title">
                   10957: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10958: <div class="toc">
                   10959: <p><b>Table of Contents</b></p>
                   10960: <dl>
1.23      wiz      10961: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10962: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10963: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10964: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10965: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10966: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10967: source packages</a></span></dt>
                   10968: </dl>
                   10969: </div>
                   10970: <p>As in other big projects, the directory layout of pkgsrc
                   10971:        is quite complex for newbies. This chapter explains where you
                   10972:        find things on the FTP server. The base directory on
1.10      hubertf  10973:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1       dsieger  10974:        On other servers it may be different, but inside this directory,
                   10975:        everything should look the same, no matter on which server you
                   10976:        are. This directory contains some subdirectories, which are
                   10977:        explained below.</p>
1.23      wiz      10978: <div class="sect1" title="C.1. distfiles: The distributed source files">
1.1       dsieger  10979: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10980: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10981: <p>The directory <code class="filename">distfiles</code> contains lots
                   10982:        of archive files from all pkgsrc packages, which are mirrored
                   10983:        here. The subdirectories are called after their package names
                   10984:        and are used when the distributed files have names that don't
                   10985:        explicitly contain a version number or are otherwise too generic
                   10986:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10987: </div>
1.23      wiz      10988: <div class="sect1" title="C.2. misc: Miscellaneous things">
1.1       dsieger  10989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10990: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10991: <p>This directory contains things that individual pkgsrc
                   10992:        developers find worth publishing.</p>
                   10993: </div>
1.23      wiz      10994: <div class="sect1" title="C.3. packages: Binary packages">
1.1       dsieger  10995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10996: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10997: <p>This directory contains binary packages for the various
                   10998:        platforms that are supported by pkgsrc.
                   10999:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.23      wiz      11000: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   11001: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   11002:        operating system for which the packages have been built. The
1.10      hubertf  11003:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   11004:        command, so it may differ from the one you are used to
                   11005:        hear.</p></li>
1.23      wiz      11006: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   11007:        architecture of the platform for which the packages have been
1.10      hubertf  11008:        built. It also includes the <code class="varname">ABI</code> (Application
                   11009:        Binary Interface) for platforms that have several of
                   11010:        them.</p></li>
1.23      wiz      11011: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   11012:        the operating system. For version numbers that change often (for
                   11013:        example NetBSD-current), the often-changing part should be
                   11014:        replaced with an <code class="literal">x</code>, for example
                   11015:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      11016: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 11017:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   11018:        for a stable branch, or <code class="literal">head</code> for packages
                   11019:        built from the HEAD branch. The latter should only be used when
                   11020:        the packages are updated on a regular basis. Otherwise the date
                   11021:        from checking out pkgsrc should be appended, for example
                   11022:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   11023: </ul></div>
                   11024: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11025:        can quickly click through the directories on the
                   11026:        server and find the best binary packages for their machines. Since they
                   11027:        usually know the operating system and the hardware architecture, OPSYS
                   11028:        and ARCH are placed first. After these choices, they can select the
                   11029:        best combination of OSVERSION and TAG together, since it is usually the
                   11030:        case that packages stay compatible between different version of the
                   11031:        operating system.</p>
                   11032: <p>In each of these directories, there is a
                   11033:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  11034:        <code class="filename">All</code> which contains all binary packages.
                   11035:        Besides that, there are various category directories that
                   11036:        contain symbolic links to the real binary packages.</p>
                   11037: </div>
1.23      wiz      11038: <div class="sect1" title="C.4. reports: Bulk build reports">
1.1       dsieger  11039: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11040: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   11041: <p>Here are the reports from bulk builds, for those who want
                   11042:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      11043:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.8       rillig   11044: </div>
1.23      wiz      11045: <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
1.8       rillig   11046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11047: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11048: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11049: source packages</h2></div></div></div>
1.23      wiz      11050: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11051:        that is the files that define how to create binary packages from
                   11052:        source archives.</p>
                   11053: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11054:        snapshot of the CVS repository, which is updated regularly. The
                   11055:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11056:        directory, ready to be downloaded as a whole.</p>
                   11057: <p>In the directories for the quarterly branches, there is an
                   11058:        additional file called
1.22      jakllsch 11059:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1       dsieger  11060:        which contains the state of pkgsrc when it was branched.</p>
                   11061: </div>
                   11062: </div>
1.23      wiz      11063: <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
1.1       dsieger  11064: <div class="titlepage"><div><div><h2 class="title">
                   11065: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11066: <div class="toc">
                   11067: <p><b>Table of Contents</b></p>
                   11068: <dl>
                   11069: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   11070: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11071: </dl>
                   11072: </div>
                   11073: <p>This section contains information on editing the pkgsrc
                   11074:        guide itself.</p>
1.23      wiz      11075: <div class="sect1" title="D.1. Make targets">
1.1       dsieger  11076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11077: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11078: <p>The pkgsrc guide's source code is stored in
                   11079:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11080:        are created from it:</p>
1.23      wiz      11081: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   11082: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11083: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11084: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11085: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1       dsieger  11086:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      11087: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1       dsieger  11088:        PostScript version of the pkgsrc guide.</p></li>
                   11089: </ul></div>
                   11090: </div>
1.23      wiz      11091: <div class="sect1" title="D.2. Procedure">
1.1       dsieger  11092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11093: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   11094: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      11095: <div class="procedure"><ol class="procedure" type="1">
                   11096: <li class="step" title="Step 1"><p>Make sure you have the packages needed to
1.1       dsieger  11097:        regenerate the pkgsrc guide (and other XML-based NetBSD
                   11098:        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
                   11099:        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
                   11100:        PostScript and PDF versions. You will need both packages
                   11101:        installed, to make sure documentation is consistent across all
                   11102:        formats.</p></li>
1.23      wiz      11103: <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  11104:        right directory. All further steps will take place
                   11105:        here.</p></li>
1.23      wiz      11106: <li class="step" title="Step 3"><p>Edit the XML file(s) in
1.1       dsieger  11107:        <code class="filename">files/</code>.</p></li>
1.23      wiz      11108: <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  11109:        guide for valid XML and to build the final output files. If you
                   11110:        get any errors at this stage, you can just edit the files, as
                   11111:        there are only symbolic links in the working directory, pointing
                   11112:        to the files in <code class="filename">files/</code>.</p></li>
1.23      wiz      11113: <li class="step" title="Step 5"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  11114:        commit)</strong></span></p></li>
1.23      wiz      11115: <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  11116:        regenerate the output files with the proper RCS
                   11117:        Ids.</p></li>
1.23      wiz      11118: <li class="step" title="Step 7">
1.10      hubertf  11119: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  11120:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11121:        <code class="filename">htdocs</code>.</p>
1.23      wiz      11122: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  11123: <h3 class="title">Note</h3>
                   11124: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  11125:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11126:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  11127:        directory.</p>
                   11128: </div>
                   11129: </li>
                   11130: </ol></div>
                   11131: </div>
                   11132: </div>
                   11133: </div></body>
                   11134: </html>

CVSweb <webmaster@jp.NetBSD.org>