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

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>
                    352: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    353: </dl></dd>
1.23      wiz       354: <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    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    357: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz       358: <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    359: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    360: </dl></dd>
1.23      wiz       361: <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    362: <dd><dl>
                    363: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    364: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    365: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    367: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    368: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    369: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    370: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    371: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj       372: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig    373: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    374: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    375: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    376: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    377: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    378: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    379: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    380: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   381:     emulation</a></span></dt>
1.6       rillig    382: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    383: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   384: </dl></dd>
1.6       rillig    385: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   386: </dl></dd>
1.6       rillig    387: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    388: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   389: <dd><dl>
1.6       rillig    390: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    391: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    392: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    394: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj       395: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    396: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig    397: </dl></dd>
                    398: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    399: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    400: <dd><dl>
                    401: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    402: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    403: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    404: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   405: </dl></dd>
                    406: </dl></dd>
                    407: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    408: <dd><dl>
1.6       rillig    409: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.6       rillig    411: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    412: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    413: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   414: <dd><dl>
1.6       rillig    415: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    416: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   417: </dl></dd>
1.6       rillig    418: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    419: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   420: <dd><dl>
1.6       rillig    421: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    422: <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   423: </dl></dd>
1.6       rillig    424: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   425: <dd><dl>
1.23      wiz       426: <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>
                    427: <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   428: </dl></dd>
                    429: </dl></dd>
1.6       rillig    430: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   431: <dd><dl>
1.6       rillig    432: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    433: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    434: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   435: <dd><dl>
1.6       rillig    436: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    437: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   438: </dl></dd>
                    439: </dl></dd>
1.6       rillig    440: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   441: <dd><dl>
1.6       rillig    442: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    443: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   444: </dl></dd>
                    445: </dl></dd>
                    446: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    447: <dd><dl>
                    448: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    449: <dd><dl>
                    450: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    451: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    452: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       453: <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   454: </dl></dd>
                    455: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    456: </dl></dd>
                    457: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    458: <dd><dl>
                    459: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    460: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    461: </dl></dd>
                    462: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    463: <dd><dl>
1.23      wiz       464: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    465: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    467: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    468: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    469: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   470: source packages</a></span></dt>
                    471: </dl></dd>
                    472: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    473: <dd><dl>
                    474: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    475: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    476: </dl></dd>
                    477: </dl>
                    478: </div>
                    479: <div class="list-of-tables">
                    480: <p><b>List of Tables</b></p>
                    481: <dl>
                    482: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    483: </dt>
1.6       rillig    484: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   485: </dt>
1.6       rillig    486: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   487: </dt>
                    488: </dl>
                    489: </div>
1.23      wiz       490: <div class="chapter" title="Chapter 1. What is pkgsrc?">
1.1       dsieger   491: <div class="titlepage"><div><div><h2 class="title">
                    492: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    493: <div class="toc">
                    494: <p><b>Table of Contents</b></p>
                    495: <dl>
                    496: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    497: <dd><dl>
                    498: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    499: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    500: </dl></dd>
                    501: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    502: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    503: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    504: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    505: </dl>
                    506: </div>
1.23      wiz       507: <div class="sect1" title="1.1. Introduction">
1.1       dsieger   508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    509: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    510: <p>There is a lot of software freely available for Unix-based
                    511: systems, which is usually available in form of the source code. Before
                    512: such software can be used, it needs to be configured to the local
                    513: system, compiled and installed, and this is exactly what The NetBSD
                    514: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    515: to handle binary packages, so that not every user has to build the
                    516: packages for himself, which is a time-costly task.</p>
                    517: <p>pkgsrc currently contains several thousand packages,
                    518:       including:</p>
1.23      wiz       519: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    520: <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   521:          web server</p></li>
1.23      wiz       522: <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   523:          web browser</p></li>
1.23      wiz       524: <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   525:          Desktop Environment</p></li>
1.23      wiz       526: <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   527:          Desktop Environment</p></li>
                    528: </ul></div>
                    529: <p>...just to name a few.</p>
                    530: <p>pkgsrc has built-in support for handling varying dependencies,
                    531:       such as pthreads and X11, and extended features such as IPv6 support on
                    532:       a range of platforms.</p>
1.23      wiz       533: <div class="sect2" title="1.1.1. Why pkgsrc?">
1.1       dsieger   534: <div class="titlepage"><div><div><h3 class="title">
                    535: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    536: <p>
                    537: pkgsrc provides the following key features:
                    538: </p>
1.23      wiz       539: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    540: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   541:   and installation of binary packages. The source and latest
                    542:   patches are retrieved from a master or mirror download site, checksum
                    543:   verified, then built on your system. Support for binary-only
                    544:   distributions is available for both native platforms and NetBSD
                    545:   emulated platforms.</p></li>
1.23      wiz       546: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   547:   including binaries, libraries, man pages and other
                    548:   documentation.</p></li>
1.23      wiz       549: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1       dsieger   550:   are handled automatically. The configuration files of various
                    551:   packages are handled automatically during updates, so local changes
                    552:   are preserved.</p></li>
1.23      wiz       553: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   554:   consists of highly portable code. This allows the greatest speed of
1.25      spz       555:   development when porting to a new platform. This portability also
1.1       dsieger   556:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    557:   platforms</em></span>.</p></li>
1.23      wiz       558: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   559:   international encryption requirements and build-time options for a
                    560:   large number of packages are all set in a simple, central
                    561:   configuration file.</p></li>
1.23      wiz       562: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   563:   freely available under a BSD license, so you may extend and adapt
                    564:   pkgsrc to your needs. Support for local packages and patches is
                    565:   available right out of the box, so you can configure it specifically
                    566:   for your environment.</p></li>
                    567: </ul></div>
                    568: <p>The following principles are basic to pkgsrc:</p>
1.23      wiz       569: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    570: <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  571: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   572: them and to complain about them rather than to just install the package
                    573: and hope that it works. There are numerous checks in pkgsrc that try to
                    574: 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
                    575: of shell scripts), and post-installation checks (installed files,
                    576: references to shared libraries, script interpreters).</p></li>
1.23      wiz       577: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  578: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   579: pkgsrc has been ported to many operating systems. Care is taken that
                    580: packages behave the same on all platforms.</p></li>
                    581: </ul></div>
                    582: </div>
1.23      wiz       583: <div class="sect2" title="1.1.2. Supported platforms">
1.1       dsieger   584: <div class="titlepage"><div><div><h3 class="title">
                    585: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    586: <p>pkgsrc consists of both a source distribution and a binary
                    587: distribution for these operating systems. After retrieving the required
                    588: source or binaries, you can be up and running with pkgsrc in just
                    589: minutes!</p>
                    590: <p>pkgsrc was derived from FreeBSD's ports system, and
                    591:       initially developed for NetBSD only. Since then, pkgsrc has
                    592:       grown a lot, and now supports the following platforms:</p>
                    593: <div class="table">
                    594: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    595: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    596: <colgroup>
                    597: <col>
                    598: <col>
                    599: </colgroup>
                    600: <thead><tr>
                    601: <th>Platform</th>
                    602: <th>Date Support Added</th>
                    603: </tr></thead>
                    604: <tbody>
                    605: <tr>
1.10      hubertf   606: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   607: <td align="center">Aug 1997</td>
                    608: </tr>
                    609: <tr>
1.10      hubertf   610: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   611: <td align="center">Mar 1999</td>
                    612: </tr>
                    613: <tr>
1.10      hubertf   614: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   615: <td align="center">Jun 1999</td>
                    616: </tr>
                    617: <tr>
                    618: <td>
1.10      hubertf   619:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    620:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1       dsieger   621:         </td>
                    622: <td align="center">Oct 2001</td>
                    623: </tr>
                    624: <tr>
1.10      hubertf   625: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   626: <td align="center">Nov 2002</td>
                    627: </tr>
                    628: <tr>
1.10      hubertf   629: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   630: <td align="center">Nov 2002</td>
                    631: </tr>
                    632: <tr>
1.10      hubertf   633: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   634: <td align="center">Dec 2002</td>
                    635: </tr>
                    636: <tr>
                    637: <td>BSD/OS</td>
                    638: <td align="center">Dec 2003</td>
                    639: </tr>
                    640: <tr>
1.10      hubertf   641: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   642: <td align="center">Dec 2003</td>
                    643: </tr>
                    644: <tr>
                    645: <td>
1.10      hubertf   646:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   647:           (Microsoft Windows Services for Unix)
                    648:         </td>
                    649: <td align="center">Mar 2004</td>
                    650: </tr>
                    651: <tr>
1.10      hubertf   652: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   653: <td align="center">Oct 2004</td>
                    654: </tr>
                    655: <tr>
1.10      hubertf   656: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   657: <td align="center">Nov 2004</td>
                    658: </tr>
                    659: <tr>
1.10      hubertf   660: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   661: <td align="center">Apr 2007</td>
                    662: </tr>
1.23      wiz       663: <tr>
                    664: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    665: <td align="center">Sep 2010</td>
                    666: </tr>
1.1       dsieger   667: </tbody>
                    668: </table></div>
                    669: </div>
                    670: <br class="table-break">
                    671: </div>
                    672: </div>
1.23      wiz       673: <div class="sect1" title="1.2. Overview">
1.1       dsieger   674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    675: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    676: <p>This document is divided into three parts. The first,
1.10      hubertf   677:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   678:        describes how one can use one of the packages in the Package
                    679:        Collection, either by installing a precompiled binary package,
                    680:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   681:        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   682:        package so it can be easily built by other NetBSD users without
                    683:        knowing about the package's building details. The third part,
1.10      hubertf   684:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   685:        is intended for those who want to understand how pkgsrc is
                    686:        implemented.</p>
                    687: <p>This document is available in various formats:
1.10      hubertf   688:        <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   689: </div>
1.23      wiz       690: <div class="sect1" title="1.3. Terminology">
1.1       dsieger   691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    692: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       693: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    694:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   695:       terminology used within this document.</p>
                    696: <div class="variablelist"><dl>
                    697: <dt><span class="term">Package</span></dt>
                    698: <dd><p>A set of files and building instructions
                    699:            that describe what's necessary
                    700:            to build a certain piece of software using
                    701:             pkgsrc. Packages are traditionally stored under
                    702:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    703: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       704: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   705:          is part of the NetBSD operating system and can be bootstrapped
                    706:          to run on non-NetBSD operating systems as well.  It handles
                    707:          building (compiling), installing, and removing of
                    708:          packages.</p></dd>
                    709: <dt><span class="term">Distfile</span></dt>
                    710: <dd><p>This term describes the file or files that are
                    711:            provided by the author of the piece of software to
                    712:            distribute his work. All the changes necessary to build on
                    713:            NetBSD are reflected in the corresponding package. Usually
                    714:            the distfile is in the form of a compressed tar-archive,
                    715:            but other types are possible, too. Distfiles are usually
                    716:            stored below
                    717:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    718: <dt><span class="term">Port</span></dt>
                    719: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    720:            for what we call a package.
1.23      wiz       721:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   722:            architecture.</p></dd>
                    723: <dt><span class="term">Precompiled/binary package</span></dt>
                    724: <dd>
                    725: <p>A set of binaries built with pkgsrc from a distfile
                    726:            and stuffed together in a single <code class="filename">.tgz</code>
                    727:            file so it can be installed on machines of the same
                    728:            machine architecture without the need to
                    729:            recompile. Packages are usually generated in
                    730:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       731:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       732: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   733:            especially in the context of precompiled packages.</p>
                    734: </dd>
                    735: <dt><span class="term">Program</span></dt>
                    736: <dd><p>The piece of software to be installed which will be
                    737:          constructed from all the files in the distfile by the
                    738:          actions defined in the corresponding package.</p></dd>
                    739: </dl></div>
1.23      wiz       740: <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
1.1       dsieger   741: <div class="titlepage"><div><div><h3 class="title">
                    742: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
                    743: <div class="variablelist"><dl>
                    744: <dt><span class="term">pkgsrc users</span></dt>
                    745: <dd>
                    746: <p>The
                    747:        pkgsrc users are people who use the packages provided by pkgsrc.
                    748:        Typically they are system administrators. The people using the
1.23      wiz       749:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    750:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   751: <p>There are two kinds of pkgsrc users: Some only want to
                    752:        install pre-built binary packages. Others build the pkgsrc
                    753:        packages from source, either for installing them directly or for
1.10      hubertf   754:        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   755:        documentation.</p>
                    756: </dd>
                    757: <dt><span class="term">package maintainers</span></dt>
                    758: <dd><p>A
1.10      hubertf   759:        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   760: <dt><span class="term">infrastructure developers</span></dt>
                    761: <dd><p>These people are involved in all those files
                    762:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   763:        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   764:        too.</p></dd>
                    765: </dl></div>
                    766: </div>
                    767: </div>
1.23      wiz       768: <div class="sect1" title="1.4. Typography">
1.1       dsieger   769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    770: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    771: <p>When giving examples for commands, shell prompts are used to
                    772:       show if the command should/can be issued as root, or if
1.23      wiz       773:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.1       dsieger   774:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    775:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    776: </div>
                    777: </div>
1.23      wiz       778: <div class="part" title="Part I. The pkgsrc user's guide">
1.1       dsieger   779: <div class="titlepage"><div><div><h1 class="title">
                    780: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    781: <div class="toc">
                    782: <p><b>Table of Contents</b></p>
                    783: <dl>
                    784: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    785: <dd><dl>
                    786: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    787: <dd><dl>
                    788: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       789: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   790: </dl></dd>
                    791: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    792: <dd><dl>
                    793: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    794: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    795: </dl></dd>
                    796: </dl></dd>
                    797: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    798: <dd><dl>
                    799: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    800: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    801: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    802: <dd><dl>
                    803: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    804: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    805: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    806: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    807: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    808: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    809: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                    810: </dl></dd>
                    811: </dl></dd>
                    812: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    813: <dd><dl>
                    814: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    815: <dd><dl>
                    816: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    817: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    818: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    819: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    820: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    821: <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>
                    822: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    823: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    824: </dl></dd>
                    825: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    826: <dd><dl>
                    827: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    828: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    829: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    830: </dl></dd>
                    831: </dl></dd>
                    832: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    833: <dd><dl>
                    834: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    835: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    836: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    837: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   838: <dd><dl>
1.4       rillig    839: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       840: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    841: <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   842: </dl></dd>
1.4       rillig    843: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    844: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   845: </dl></dd>
                    846: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    847: <dd><dl>
                    848: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    849: <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    850: </dl></dd>
                    851: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    852: builds)</a></span></dt>
1.1       dsieger   853: <dd><dl>
1.6       rillig    854: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    855: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    856: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    857: <dd><dl>
                    858: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    859: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    860: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    861: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    862: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    863: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    864: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    865: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    866: </dl></dd>
                    867: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    868: <dd><dl>
                    869: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    870: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    871: </dl></dd>
1.6       rillig    872: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    873: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    876: <dd><dl>
1.23      wiz       877: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    878: <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    879: </dl></dd>
                    880: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    884: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    885: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    886: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    887: <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>
                    888: <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       889: <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    890: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       891: <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
                    892: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    893: <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    894: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    895: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    896: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       897: <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    898: <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       899: <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   900: </dl></dd>
                    901: </dl>
                    902: </div>
1.23      wiz       903: <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
1.1       dsieger   904: <div class="titlepage"><div><div><h2 class="title">
                    905: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    906: <div class="toc">
                    907: <p><b>Table of Contents</b></p>
                    908: <dl>
                    909: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    910: <dd><dl>
                    911: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       912: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   913: </dl></dd>
                    914: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    915: <dd><dl>
                    916: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    917: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    918: </dl></dd>
                    919: </dl>
                    920: </div>
                    921: <p>Before you download and extract the files, you need to decide
                    922: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    923: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    924: free to install the sources and binary packages wherever you want in
                    925: your filesystem, provided that the pathname does not contain white-space
                    926: or other characters that are interpreted specially by the shell and some
                    927: other programs. A safe bet is to use only letters, digits, underscores
                    928: and dashes.</p>
1.23      wiz       929: <div class="sect1" title="2.1. Getting pkgsrc for the first time">
1.1       dsieger   930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    931: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    932: <p>Before you download any pkgsrc files, you should decide
                    933:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    934:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    935:        quarterly basis from the current branch and only gets modified
                    936:        for security updates. The names of the stable branches are built
                    937:        from the year and the quarter, for example
1.21      snj       938:        <code class="literal">2009Q1</code>.</p>
1.1       dsieger   939: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       940:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    941:        Both ways are described here.</p>
                    942: <div class="sect2" title="2.1.1. As tar file">
1.1       dsieger   943: <div class="titlepage"><div><div><h3 class="title">
                    944: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    945: <p>The primary download location for all pkgsrc files is
1.10      hubertf   946:        <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   947:        number of subdirectories for different purposes, which are
1.10      hubertf   948:        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   949: <p>The tar file for the current branch is in the directory
1.10      hubertf   950:        <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   951:        It is autogenerated daily.</p>
1.21      snj       952: <p>The tar file for the stable branch 2009Q1 is in the
                    953:        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    954: <p>To download a pkgsrc stable tarball, run:</p>
                    955: <pre class="screen">
1.22      jakllsch  956: <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>
                    957: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12      weinem    958:        stable branch to be downloaded, for example, 
1.23      wiz       959:        <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</p>
1.12      weinem    960: <p>Then, extract it with:</p>
1.22      jakllsch  961: <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    962: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    963:        in <code class="filename">/usr/</code> and all the package source will be 
                    964:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    965: <p>To download pkgsrc-current, run:</p>
                    966: <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   967: </div>
1.23      wiz       968: <div class="sect2" title="2.1.2. Via anonymous CVS">
1.1       dsieger   969: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz       970: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    971: <p>To fetch a specific pkgsrc stable branch, run:</p>
                    972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
                    973: </pre>
                    974: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
                    975:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
                    976: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    977:        in your <code class="filename">/usr/</code> directory and all the package source 
                    978:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    979: <p>To fetch the pkgsrc current branch, run:</p>
                    980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger   981: </pre>
1.29      dholland  982: <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       983: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
                    984: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
                    985: </pre>
                    986: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    987:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    988:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    989: <pre class="programlisting">
                    990: # set CVS remote shell command
                    991: CVS_RSH=ssh
                    992: export CVS_RSH
                    993: </pre>
                    994: <p>By default, CVS doesn't do things like most people would expect it to do.
                    995:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                    996:        in your home directory and saving the following lines to it.
                    997:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                    998:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig    999: <pre class="programlisting">
                   1000: # recommended CVS configuration file from the pkgsrc guide
1.23      wiz      1001: cvs -q -z3
1.2       rillig   1002: checkout -P
1.4       rillig   1003: update -dP
                   1004: diff -upN
1.2       rillig   1005: rdiff -u
1.23      wiz      1006: release -d
1.2       rillig   1007: </pre>
1.1       dsieger  1008: </div>
                   1009: </div>
1.23      wiz      1010: <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1.1       dsieger  1011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1012: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1013: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1014:        (which also works if you have first installed it via a tar
                   1015:        file). It saves bandwidth and hard disk activity, compared to
                   1016:        downloading the tar file again.</p>
1.23      wiz      1017: <div class="sect2" title="2.2.1. Via tar files">
1.1       dsieger  1018: <div class="titlepage"><div><div><h3 class="title">
                   1019: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.23      wiz      1020: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1021: <h3 class="title">Warning</h3>
                   1022: <p>When updating from a tar file, you first need to
                   1023:        completely remove the old pkgsrc directory. Otherwise those
                   1024:        files that have been removed from pkgsrc in the mean time will
                   1025:        not be removed on your local disk, resulting in inconsistencies.
                   1026:        When removing the old files, any changes that you have done to
                   1027:        the pkgsrc files will be lost after updating. Therefore updating
                   1028:        via CVS is strongly recommended.</p>
                   1029: </div>
                   1030: <p>Note that by default the distfiles and the binary packages
                   1031:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1032:        before updating. You can also configure pkgsrc to use other than
                   1033:        the default directories by setting the
                   1034:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1035:        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  1036: <p>To update pkgsrc from a tar file, download the tar file as
                   1037:        explained above. Then, make sure that you have not made any
                   1038:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1039:        directory and extract the new tar file. Done.</p>
                   1040: </div>
1.23      wiz      1041: <div class="sect2" title="2.2.2. Via CVS">
1.1       dsieger  1042: <div class="titlepage"><div><div><h3 class="title">
                   1043: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25      spz      1044: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1045: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1046: </pre>
                   1047: <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>
                   1048: <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>
                   1049: </pre>
1.23      wiz      1050: <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1.1       dsieger  1051: <div class="titlepage"><div><div><h4 class="title">
                   1052: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1053: <p>When updating pkgsrc, the CVS program keeps track of the
                   1054:        branch you selected. But if you, for whatever reason, want to
                   1055:        switch from the stable branch to the current one, you can do it
1.23      wiz      1056:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1057:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1058:        back to the stable branch, add the
1.23      wiz      1059:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1.1       dsieger  1060: </div>
1.23      wiz      1061: <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1.1       dsieger  1062: <div class="titlepage"><div><div><h4 class="title">
                   1063: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1064: <p>When you update pkgsrc, the CVS program will only touch
                   1065:        those files that are registered in the CVS repository. That
                   1066:        means that any packages that you created on your own will stay
                   1067:        unmodified. If you change files that are managed by CVS, later
                   1068:        updates will try to merge your changes with those that have been
                   1069:        done by others. See the CVS manual, chapter
1.23      wiz      1070:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1071: </div>
                   1072: </div>
                   1073: </div>
                   1074: </div>
1.23      wiz      1075: <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1.1       dsieger  1076: <div class="titlepage"><div><div><h2 class="title">
                   1077: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1078: <div class="toc">
                   1079: <p><b>Table of Contents</b></p>
                   1080: <dl>
                   1081: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1082: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1083: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1084: <dd><dl>
                   1085: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1086: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1087: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1088: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1089: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1090: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1091: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                   1092: </dl></dd>
                   1093: </dl>
                   1094: </div>
1.23      wiz      1095: <div class="sect1" title="3.1. Binary distribution">
1.1       dsieger  1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1097: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1098: <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  1099: </div>
1.23      wiz      1100: <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1.1       dsieger  1101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1102: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1104: <pre class="screen">
                   1105: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1108:     </pre>
1.10      hubertf  1109: <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  1110:     pkgsrc before bootstrapping. The given
1.10      hubertf  1111:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.1       dsieger  1112:     <code class="filename">/usr/pkg</code> for the
                   1113:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1114:     and <code class="filename">/var/db/pkg</code> for the package database
                   1115:     directory where pkgsrc will do its internal bookkeeping.
                   1116:     However, these can also be set using command-line
                   1117:     arguments.</p>
1.23      wiz      1118: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1119: <h3 class="title">Note</h3>
1.10      hubertf  1120: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1121:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1122:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1123:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1124: </div>
                   1125: </div>
1.23      wiz      1126: <div class="sect1" title="3.3. Platform-specific notes">
1.1       dsieger  1127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1128: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1129: <p>Here are some platform-specific notes you should be aware of.</p>
1.23      wiz      1130: <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1.1       dsieger  1131: <div class="titlepage"><div><div><h3 class="title">
                   1132: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.22      jakllsch 1133: <p>Darwin 5.x and up are supported. Before you start, you
                   1134:       will need to download and install the Mac OS X Developer Tools
                   1135:       from Apple's Developer Connection. See
                   1136:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1137:       for details.  Also, make sure you install X11 (an optional
                   1138:       package included with the Developer Tools) if you intend to
                   1139:       build packages that use the X11 Window System.</p>
1.1       dsieger  1140: </div>
1.23      wiz      1141: <div class="sect2" title="3.3.2. FreeBSD">
1.1       dsieger  1142: <div class="titlepage"><div><div><h3 class="title">
                   1143: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.29      dholland 1144: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1       dsieger  1145:       other versions may work.</p>
                   1146: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1147:       with the FreeBSD userland tools. There are several steps:</p>
1.23      wiz      1148: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1149: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1       dsieger  1150:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1151:          recommended that you choose a different location (e.g.
                   1152:          <code class="filename">/usr/pkgdb</code>) by
                   1153:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1154: <li class="listitem">
1.1       dsieger  1155: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1156:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1157: <pre class="screen">
                   1158: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1159: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1160: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1161: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1162: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1163:          </pre>
                   1164: </li>
1.23      wiz      1165: <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  1166:          <code class="filename">/etc/mk.conf.example</code> file
                   1167:          when you use the bootstrap script.</p></li>
                   1168: </ol></div>
                   1169: </div>
1.23      wiz      1170: <div class="sect2" title="3.3.3. Interix">
1.1       dsieger  1171: <div class="titlepage"><div><div><h3 class="title">
                   1172: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
                   1173: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1174:       providing a Unix-like environment with a tighter kernel integration than
                   1175:       available with Cygwin.  It is part of the Windows Services for Unix
                   1176:       package, available for free for any licensed copy of Windows 2000, XP
1.10      hubertf  1177:       (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  1178: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1179:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1180:       of pthreads, but other parts of libc may also be lacking.)</p>
1.24      wiz      1181: <p>Services for Unix Applications (aka SUA) is an integrated
                   1182:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1183:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1184:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1185:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1186:       work as well. The Interix 5.x subsystem has not yet been tested
                   1187:       with pkgsrc.</p>
1.23      wiz      1188: <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1.1       dsieger  1189: <div class="titlepage"><div><div><h4 class="title">
                   1190: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
                   1191: <p>At an absolute minimum, the following packages must be installed from
                   1192:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.23      wiz      1193: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1194: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1195: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1196: <li class="listitem"><p>Remote Connectivity</p></li>
                   1197: <li class="listitem"><p>Interix SDK</p></li>
1.1       dsieger  1198: </ul></div>
                   1199: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1200:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1201:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1202:        pkgsrc (or from a binary package).</p>
                   1203: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1204:        not need to be installed, but Remote Connectivity itself should be
                   1205:        installed in order to have a working inetd.</p>
                   1206: <p>During installation you may be asked whether to enable setuid
                   1207:        behavior for Interix programs, and whether to make pathnames default to
                   1208:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1209:        enabled.  (Without case-sensitivity, a large number of packages including
                   1210:        perl will not build.)</p>
                   1211: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1212:        works (via the Data Execution Prevention feature).  In order to use
                   1213:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1214:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1215:        must be installed.  Hotfixes are available from Microsoft through a
1.14      jmcneill 1216:        support contract; however, Debian Interix Port has made most Interix
                   1217:        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  1218: <p>In addition to the hotfix noted above, it may be necessary to
                   1219:        disable Data Execution Prevention entirely to make Interix functional.
                   1220:        This may happen only with certain types of CPUs; the cause is not fully
                   1221:        understood at this time.  If gcc or other applications still segfault
                   1222:        repeatedly after installing one of the hotfixes note above, the
                   1223:        following option can be added to the appropriate "boot.ini" line on the
                   1224:        Windows boot drive:  /NoExecute=AlwaysOff
                   1225:        (WARNING, this will disable DEP completely, which may be a security
                   1226:        risk if applications are often run as a user in the Administrators
                   1227:        group!)</p>
                   1228: </div>
1.23      wiz      1229: <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1.1       dsieger  1230: <div class="titlepage"><div><div><h4 class="title">
                   1231: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
                   1232: <p>If SFU is already installed and you wish to alter these settings to work
                   1233:        with pkgsrc, note the following things.</p>
1.23      wiz      1234: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1235: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1       dsieger  1236:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1237:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.23      wiz      1238: <li class="listitem">
1.1       dsieger  1239: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1240:            change the following registry key:</p>
                   1241: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1242: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1243: </li>
1.23      wiz      1244: <li class="listitem">
1.1       dsieger  1245: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1246:            following registry key:</p>
                   1247: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1248: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1249: </li>
                   1250: </ul></div>
                   1251: </div>
1.23      wiz      1252: <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1.1       dsieger  1253: <div class="titlepage"><div><div><h4 class="title">
                   1254: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
                   1255: <p>The package manager (either the pkgsrc "su" user, or the user
                   1256:        running "pkg_add") must be a member of the local Administrators
                   1257:        group.  Such a user must also be used to run the bootstrap.  This is
                   1258:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1259: <p>The package manager should use a umask of 002.  "make install" will
                   1260:        automatically complain if this is not the case.  This ensures that
                   1261:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1262: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1263:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1264:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1265:        the same time as the pkgsrc packages, ensure that you use the proper
                   1266:        pkg_* tools for each type of binary package.</p>
                   1267: <p>The TERM setting used for DOS-type console windows (including those
                   1268:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1269:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1270:        entry provides adequate emulation in most cases:</p>
                   1271: <pre class="programlisting">
                   1272: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1273:        </pre>
                   1274: </div>
1.23      wiz      1275: <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1.1       dsieger  1276: <div class="titlepage"><div><div><h4 class="title">
                   1277: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
                   1278: <p>Though Interix suffices as a familiar and flexible substitute
                   1279:        for a full Unix-like platform, it has some drawbacks that should
                   1280:        be noted for those desiring to make the most of Interix.</p>
1.23      wiz      1281: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1282: <li class="listitem">
1.1       dsieger  1283: <p><span class="strong"><strong>X11:</strong></span></p>
                   1284: <p>Interix comes with the standard set of X11R6 client libraries,
                   1285:          and can run X11 based applications, but it does
                   1286:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.10      hubertf  1287:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1288:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1       dsieger  1289:          (available in a trimmed version for Interix from Interop Systems as the
1.10      hubertf  1290:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1       dsieger  1291:          and the free X11 server included with
1.10      hubertf  1292:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1       dsieger  1293: </li>
1.23      wiz      1294: <li class="listitem">
1.1       dsieger  1295: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1296: <p>Because Interix runs in a completely different NT subsystem from
                   1297:          Win32 applications, it does not currently support various X11
                   1298:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1299:          Most interactive applications to a local X server will run
                   1300:          reasonably fast, but full motion video and other graphics
                   1301:          intensive applications may require a faster-than-expected CPU.</p>
                   1302: </li>
1.23      wiz      1303: <li class="listitem">
1.1       dsieger  1304: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1305: <p>Interix has no native support for audio output.  For audio
1.10      hubertf  1306:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1       dsieger  1307:          audio system on Interix.  Unlike on most platforms, the
                   1308:          <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  1309:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1       dsieger  1310:          server component.  To output audio via an Interix host, the
                   1311:          <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
                   1312:          must also be installed.</p>
                   1313: </li>
1.23      wiz      1314: <li class="listitem">
1.1       dsieger  1315: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1316: <p>Direct device access is not currently supported in Interix, so it
                   1317:          is not currently possible to access CD/DVD drives, USB devices,
                   1318:          or SCSI devices through non-filesystem means.  Among other things,
                   1319:          this makes it impossible to use Interix directly for CD/DVD
                   1320:          burning.</p>
                   1321: </li>
1.23      wiz      1322: <li class="listitem">
1.1       dsieger  1323: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1324: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1325:          drives are also not directly accessible in Interix.  However,
                   1326:          support is in work to make tape drive access possible by using
                   1327:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1328:          esound server).</p>
                   1329: </li>
                   1330: </ul></div>
                   1331: </div>
1.23      wiz      1332: <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1.1       dsieger  1333: <div class="titlepage"><div><div><h4 class="title">
                   1334: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
                   1335: <p>It is not necessary, in general, to have a "root" user on the
                   1336:        Windows system; any member of the local Administrators group will
                   1337:        suffice.  However, some packages currently assume that the user
                   1338:        named "root" is the privileged user.  To accommodate these, you
                   1339:        may create such a user; make sure it is in the local group
                   1340:        Administrators (or your language equivalent).</p>
1.10      hubertf  1341: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1       dsieger  1342:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1343:        time being, install packages as the local Administrator (or
                   1344:        your language equivalent), or run the following command after
                   1345:        installing a package to work around the issue:</p>
                   1346: <pre class="screen">
                   1347: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1348:        </pre>
                   1349: </div>
                   1350: </div>
1.23      wiz      1351: <div class="sect2" title="3.3.4. IRIX">
1.1       dsieger  1352: <div class="titlepage"><div><div><h3 class="title">
                   1353: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
                   1354: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1355:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1356:       according to your preference.  If you do not have a license for the MIPSpro
1.10      hubertf  1357:       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  1358: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29      dholland 1359:       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  1360:       etc.</p>
                   1361: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1362:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1363:        you start out using "abi=n32", that's what all your packages will be built
                   1364:        with.</p>
                   1365: <p>Therefore, please make sure that you have no conflicting
                   1366:       <code class="varname">CFLAGS</code> in your environment or the
1.10      hubertf  1367:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1368:       try to link n32 object files with lib64 or vice versa.  Check your
                   1369:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1370: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1371:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1372:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1373:       link over a network-mounted file system.</p>
                   1374: <p>The bootstrapping process should set all the right options for programs such
                   1375:       as imake(1), but you may want to set some options depending on your local
                   1376:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1377:       course, your compiler's man pages for details.</p>
                   1378: <p>If you are using SGI's MIPSPro compiler, please set
                   1379: 
                   1380:       </p>
                   1381: <pre class="programlisting">
                   1382: PKGSRC_COMPILER=        mipspro
                   1383:       </pre>
                   1384: <p>
                   1385: 
1.10      hubertf  1386:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1387:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1388:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1389:       default.</p>
                   1390: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1391:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1392:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1393:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1394:       '--preserve-path' flag.</p>
                   1395: </div>
1.23      wiz      1396: <div class="sect2" title="3.3.5. Linux">
1.1       dsieger  1397: <div class="titlepage"><div><div><h3 class="title">
                   1398: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
                   1399: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1400:       either libtermcap or libcurses (libncurses).  Installing the
                   1401:       distributions libncurses-dev package (or equivalent) should fix
                   1402:       the problem.</p>
                   1403: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1404:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1405:       i386 have been tested.</p>
                   1406: <p>To bootstrap using icc, assuming the default icc installation
                   1407:       directory:</p>
                   1408: <pre class="programlisting">
1.30    ! wiz      1409: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
        !          1410: ac_cv___attribute__=yes ./bootstrap
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.30    ! wiz      1414: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
        !          1415: </div>
        !          1416: <p>icc supports __attribute__, but the GNU configure test uses a nested
        !          1417:       function, which icc does not support. #undef'ing __attribute__ has the
        !          1418:       unfortunate side-effect of breaking many of the Linux header files, which
        !          1419:       cannot be compiled properly without __attribute__. The test must be
        !          1420:       overridden so that __attribute__ is assumed supported by the
        !          1421:       compiler.</p>
        !          1422: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
        !          1423:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
        !          1424: <pre class="programlisting">
        !          1425: PKGSRC_COMPILER=        icc
        !          1426:       </pre>
        !          1427: <p>The default installation directory for icc is
        !          1428:       <code class="filename">/opt/intel_cc_80</code>, which
        !          1429:       is also the pkgsrc default. If you have installed it into a different
        !          1430:       directory, set <code class="varname">ICCBASE</code> in
        !          1431:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1432: <pre class="programlisting">
1.30    ! wiz      1433: ICCBASE=                /opt/icc
1.1       dsieger  1434:       </pre>
                   1435: <p>pkgsrc uses the static linking method of the runtime libraries
                   1436:       provided by icc, so binaries can be run on other systems which do not
                   1437:       have the shared libraries installed.</p>
                   1438: <p>Libtool, however, extracts a list of libraries from the
1.29      dholland 1439:       <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  1440:       records it, throwing away the -Bstatic and -Bdynamic options
                   1441:       interspersed between the libraries.  This means that
                   1442:       libtool-linked C++ shared libraries will have a runtime
                   1443:       dependency on the icc libraries until this is fixed in
                   1444:       libtool.</p>
                   1445: </div>
1.23      wiz      1446: <div class="sect2" title="3.3.6. OpenBSD">
1.1       dsieger  1447: <div class="titlepage"><div><div><h3 class="title">
                   1448: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.29      dholland 1449: <p>OpenBSD 5.1 has been tested and supported,
                   1450:       other versions may work.</p>
1.1       dsieger  1451: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1452:       with the OpenBSD userland tools. There are several steps:</p>
1.23      wiz      1453: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1454: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1       dsieger  1455:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1456:          recommended that you choose a different location (e.g.
                   1457:          <code class="filename">/usr/pkgdb</code>) by
                   1458:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1459: <li class="listitem">
1.1       dsieger  1460: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1461:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1462: <pre class="screen">
                   1463: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1464: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1465: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1466: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1467: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1468:          </pre>
                   1469: </li>
1.23      wiz      1470: <li class="listitem">
1.10      hubertf  1471: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1472:          <code class="filename">/etc/mk.conf.example</code> file
                   1473:          when you use the bootstrap script. OpenBSD's make program uses
1.10      hubertf  1474:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1475:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1476:          of the file with:</p>
                   1477: <pre class="programlisting">
                   1478: .ifdef BSD_PKG_MK
                   1479: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1480: .else
                   1481: # OpenBSD stuff
                   1482: .endif
                   1483:          </pre>
                   1484: </li>
                   1485: </ol></div>
                   1486: </div>
1.23      wiz      1487: <div class="sect2" title="3.3.7. Solaris">
1.1       dsieger  1488: <div class="titlepage"><div><div><h3 class="title">
                   1489: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
                   1490: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
                   1491:       You will need a working C compiler. Both gcc 2.95.3 and
                   1492:       Sun WorkShop 5 have been tested.</p>
                   1493: <p>The following packages are required on Solaris 8 for the bootstrap
                   1494:       process and to build packages.</p>
1.23      wiz      1495: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1496: <li class="listitem"><p>SUNWsprot</p></li>
                   1497: <li class="listitem"><p>SUNWarc</p></li>
                   1498: <li class="listitem"><p>SUNWbtool</p></li>
                   1499: <li class="listitem"><p>SUNWtoo</p></li>
                   1500: <li class="listitem"><p>SUNWlibm</p></li>
1.1       dsieger  1501: </ul></div>
                   1502: <p>Please note that the use of GNU binutils on Solaris is
                   1503:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1504: <p>Whichever compiler you use, please ensure the compiler tools and
                   1505:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1506:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1507:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.23      wiz      1508: <div class="sect3" title="3.3.7.1. If you are using gcc">
1.1       dsieger  1509: <div class="titlepage"><div><div><h4 class="title">
                   1510: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
                   1511: <p>It makes life much simpler if you only use the same gcc consistently
                   1512:        for building all packages.</p>
                   1513: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1514:        then either build gcc from
                   1515:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
                   1516:        package, then remove gcc used during bootstrapping.</p>
1.10      hubertf  1517: <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  1518: </div>
1.23      wiz      1519: <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1.1       dsieger  1520: <div class="titlepage"><div><div><h4 class="title">
                   1521: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
                   1522: <p>You will need at least the following packages installed (from WorkShop
                   1523:        5.0)</p>
1.23      wiz      1524: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1525: <li class="listitem"><p>SPROcc
1.1       dsieger  1526:          - Sun WorkShop Compiler C 5.0</p></li>
1.23      wiz      1527: <li class="listitem"><p>SPROcpl
1.1       dsieger  1528:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.23      wiz      1529: <li class="listitem"><p>SPROild
1.1       dsieger  1530:          - Sun WorkShop Incremental Linker</p></li>
1.23      wiz      1531: <li class="listitem"><p>SPROlang
1.1       dsieger  1532:          - Sun WorkShop Compilers common components</p></li>
                   1533: </ul></div>
                   1534: <p>You should set the following variables in your
1.10      hubertf  1535:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1536: <pre class="programlisting">
                   1537: CC=     cc
                   1538: CXX=    CC
                   1539: CPP=    cc -E
                   1540: CXXCPP= CC -E
                   1541: </pre>
1.23      wiz      1542: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1543: <h3 class="title">Note</h3>
                   1544: <p>The <code class="varname">CPP</code> setting might break some
                   1545:        packages that use the C preprocessor for processing things other
                   1546:        than C source code.</p>
                   1547: </div>
                   1548: </div>
1.23      wiz      1549: <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1.1       dsieger  1550: <div class="titlepage"><div><div><h4 class="title">
                   1551: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
                   1552: <p>To build 64-bit packages, you just need to have the
1.10      hubertf  1553:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1554: <pre class="programlisting">
                   1555: PKGSRC_COMPILER=        sunpro
                   1556: ABI=                    64
                   1557: </pre>
1.23      wiz      1558: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1559: <h3 class="title">Note</h3>
                   1560: <p>This setting has been tested for the SPARC
                   1561:        architecture. Intel and AMD machines need some more
                   1562:        work.</p>
                   1563: </div>
                   1564: </div>
1.23      wiz      1565: <div class="sect3" title="3.3.7.4. Common problems">
1.1       dsieger  1566: <div class="titlepage"><div><div><h4 class="title">
                   1567: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10      hubertf  1568: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1       dsieger  1569:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1570:       The workaround is to use another shell for the configure
                   1571:       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  1572:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1573: <pre class="programlisting">
                   1574: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1575: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1576:       </pre>
                   1577: <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>
                   1578: </div>
                   1579: </div>
                   1580: </div>
                   1581: </div>
1.23      wiz      1582: <div class="chapter" title="Chapter 4. Using pkgsrc">
1.1       dsieger  1583: <div class="titlepage"><div><div><h2 class="title">
                   1584: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1585: <div class="toc">
                   1586: <p><b>Table of Contents</b></p>
                   1587: <dl>
                   1588: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1589: <dd><dl>
                   1590: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1591: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1592: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1593: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1594: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1595: <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>
                   1596: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1597: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1598: </dl></dd>
                   1599: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1600: <dd><dl>
                   1601: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1602: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1603: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1604: </dl></dd>
                   1605: </dl>
                   1606: </div>
                   1607: <p>Basically, there are two ways of using pkgsrc. The first
                   1608: is to only install the package tools and to use binary packages
1.23      wiz      1609: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1610: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1611: of pkgsrc, too. Then you are able to build your own packages,
                   1612: and you can still use binary packages from someone else.</p>
1.23      wiz      1613: <div class="sect1" title="4.1. Using binary packages">
1.1       dsieger  1614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1615: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1616: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1617:   server and its mirrors, there are collections of binary packages,
                   1618:   ready to be installed. These binary packages have been built using the
                   1619:   default settings for the directories, that is:</p>
1.23      wiz      1620: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1621: <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>
                   1622: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1623: <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   1624: </ul></div>
                   1625: <p>If you cannot use these directories for whatever reasons (maybe
                   1626:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1627:   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      1628: <div class="sect2" title="4.1.1. Finding binary packages">
1.1       dsieger  1629: <div class="titlepage"><div><div><h3 class="title">
                   1630: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1631: <p>To install binary packages, you first need to know from where
                   1632:     to get them. The first place where you should look is on the main
1.10      hubertf  1633:     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   1634: <p>This directory contains binary packages for multiple
                   1635:     platforms. First, select your operating system. (Ignore the
                   1636:     directories with version numbers attached to it, they just exist for
                   1637:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1638:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1639: <p>In this directory, you often find a file called
                   1640:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1641:     management tools. If the file is missing, it is likely that your
                   1642:     operating system already provides those tools. Download the file and
                   1643:     extract it in the <code class="filename">/</code> directory. It will create
                   1644:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1645:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1646:     (the database of installed packages).</p>
1.1       dsieger  1647: </div>
1.23      wiz      1648: <div class="sect2" title="4.1.2. Installing binary packages">
1.1       dsieger  1649: <div class="titlepage"><div><div><h3 class="title">
                   1650: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1651: <p>In the directory from the last section, there is a
                   1652:     subdirectory called <code class="filename">All</code>, which contains all the
                   1653:     binary packages that are available for the platform, excluding those
                   1654:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1655:     medium you are using).</p>
1.9       rillig   1656: <p>To install packages directly from an FTP or HTTP server, run
                   1657:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1658:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1659: <pre class="screen">
                   1660: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1661: <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>
                   1662: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1663: </pre>
                   1664: <p>Instead of URLs, you can also use local paths, for example if
                   1665:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1666:     repository. If you want to install packages from multiple sources,
                   1667:     you can separate them by a semicolon in
                   1668:     <code class="varname">PKG_PATH</code>.</p>
                   1669: <p>After these preparations, installing a package is very
                   1670:     easy:</p>
                   1671: <pre class="screen">
                   1672: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1673: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1674: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1675: </pre>
1.1       dsieger  1676: <p>Note that any prerequisite packages needed to run the
                   1677:     package in question will be installed, too, assuming they are
                   1678:     present where you install from.</p>
1.23      wiz      1679: <p>Adding packages might install vulnerable packages.
                   1680:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1681:     regularly, especially after installing new packages, and verify
                   1682:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1683: <p>After you've installed packages, be sure to have
                   1684:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1685:     <code class="varname">PATH</code> so you can actually start the just
                   1686:     installed program.</p>
                   1687: </div>
1.23      wiz      1688: <div class="sect2" title="4.1.3. Deinstalling packages">
1.1       dsieger  1689: <div class="titlepage"><div><div><h3 class="title">
                   1690: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1691: <p>To deinstall a package, it does not matter whether it was
                   1692:     installed from source code or from a binary package. The
1.10      hubertf  1693:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1694:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1695:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1696:     name can be given with or without version number. Wildcards can
                   1697:     also be used to deinstall a set of packages, for example
                   1698:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1699:     so that the shell does not expand them before
                   1700:     <code class="literal">pkg_delete</code> sees them.</p>
                   1701: <p>The <code class="option">-r</code> option is very powerful: it
                   1702:     removes all the packages that require the package in question
                   1703:     and then removes the package itself. For example:
                   1704: 
                   1705:     </p>
                   1706: <pre class="screen">
                   1707: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1708:     </pre>
                   1709: <p>
                   1710: 
                   1711:     will remove jpeg and all the packages that used it; this allows
                   1712:     upgrading the jpeg package.</p>
                   1713: </div>
1.23      wiz      1714: <div class="sect2" title="4.1.4. Getting information about installed packages">
1.1       dsieger  1715: <div class="titlepage"><div><div><h3 class="title">
                   1716: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1717: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1718:     installed packages or binary package files.</p>
                   1719: </div>
1.23      wiz      1720: <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1.1       dsieger  1721: <div class="titlepage"><div><div><h3 class="title">
                   1722: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1723: <p>
                   1724:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1725:       known security vulnerabilities to packages which are (or have been)
                   1726:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1727:       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  1728:     </p>
                   1729: <p>
1.22      jakllsch 1730:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1731:       this list can be downloaded
                   1732:       automatically, and a security audit of all packages installed on a system
                   1733:       can take place.
                   1734:     </p>
                   1735: <p>
1.22      jakllsch 1736:       There are two components to auditing.  The first
                   1737:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1738:       is for downloading
1.1       dsieger  1739:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1740:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1741:       installed packages are vulnerable.  If a package is vulnerable, you
                   1742:       will see output similar to the following:
                   1743:     </p>
                   1744: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1745:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1746: <p>
1.22      jakllsch 1747:       You may wish to have the
1.10      hubertf  1748:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1749:       file downloaded daily so that
                   1750:       it remains current.  This may be done by adding an appropriate entry
1.29      dholland 1751:       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 1752:       </p>
                   1753: <pre class="screen">
                   1754: # download vulnerabilities file
                   1755: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1756:       </pre>
                   1757: <p>
                   1758:       will update the vulnerability list every day at 3AM. You may wish to do
                   1759:       this more often than once a day.
                   1760: 
                   1761:       In addition, you may wish to run the package audit from the daily
                   1762:       security script.  This may be accomplished by adding the following
                   1763:       line to <code class="filename">/etc/security.local</code>:
                   1764:       </p>
                   1765: <pre class="screen">
                   1766: /usr/sbin/pkg_admin audit
                   1767:       </pre>
                   1768: <p>
1.1       dsieger  1769:     </p>
                   1770: </div>
1.23      wiz      1771: <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1.1       dsieger  1772: <div class="titlepage"><div><div><h3 class="title">
                   1773: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1774: <p>
1.12      weinem   1775:       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      1776:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1777:       argument to check if your packages are up-to-date, e.g.
                   1778:     </p>
                   1779: <pre class="screen">
                   1780: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1781: ...
                   1782: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1783:     </pre>
1.10      hubertf  1784: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1785:     package on your system and rebuild any dependencies.
                   1786:     </p>
                   1787: </div>
1.23      wiz      1788: <div class="sect2" title="4.1.7. Other administrative functions">
1.1       dsieger  1789: <div class="titlepage"><div><div><h3 class="title">
                   1790: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1791: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1792:     administrative functions on the package system.</p>
                   1793: </div>
1.23      wiz      1794: <div class="sect2" title="4.1.8. A word of warning">
1.1       dsieger  1795: <div class="titlepage"><div><div><h3 class="title">
                   1796: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1797: <p>Please pay very careful attention to the warnings
1.29      dholland 1798:     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  1799:     inherent dangers of installing binary packages which you did
                   1800:     not create yourself, and the security holes that can be
                   1801:     introduced onto your system by indiscriminate adding of such
                   1802:     files.</p>
                   1803: <p>The same warning of course applies to every package you
                   1804:     install from source when you haven't completely read and
                   1805:     understood the source code of the package, the compiler that
                   1806:     is used to build the package and all the other tools that are
                   1807:     involved.</p>
                   1808: </div>
                   1809: </div>
1.23      wiz      1810: <div class="sect1" title="4.2. Building packages from source">
1.1       dsieger  1811: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1812: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1813: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1814:   directory now contains a set of packages, organized into
                   1815:   categories. You can browse the online index of packages, or run
1.10      hubertf  1816:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1817:   directory to build local <code class="filename">README.html</code> files for
                   1818:   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>
                   1819: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1820:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1821:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1822:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1823:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1824:   system (inside a chroot is an exception). </p>
                   1825: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1826:   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  1827:   instructions how to create your own packages.</p>
1.23      wiz      1828: <div class="sect2" title="4.2.1. Requirements">
1.1       dsieger  1829: <div class="titlepage"><div><div><h3 class="title">
                   1830: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1831: <p>To build packages from source, you need a working C
                   1832:     compiler. On NetBSD, you need to install the
1.23      wiz      1833:     <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  1834:     sets. If you want to build X11-related packages, the
1.23      wiz      1835:     <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  1836:     sets are required, too.</p>
                   1837: </div>
1.23      wiz      1838: <div class="sect2" title="4.2.2. Fetching distfiles">
1.1       dsieger  1839: <div class="titlepage"><div><div><h3 class="title">
                   1840: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1841: <p>The first step for building a package is downloading the
                   1842:     distfiles (i.e. the unmodified source). If they have not yet been
                   1843:     downloaded, pkgsrc will fetch them automatically.</p>
                   1844: <p>If you have all files that you need in the
                   1845:     <code class="filename">distfiles</code> directory,
                   1846:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1847:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1848:     </p>
                   1849: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1850: <p>
1.10      hubertf  1851:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1852: <p>By default a list of distribution sites will be randomly
                   1853:     intermixed to prevent huge load on servers which holding popular
                   1854:     packages (for example, SourceForge.net mirrors). Thus, every
                   1855:     time when you need to fetch yet another distfile all the mirrors
                   1856:     will be tried in new (random) order. You can turn this feature
                   1857:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1858:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1859: <p>You can overwrite some of the major distribution sites to
                   1860:     fit to sites that are close to your own.  By setting one or two
                   1861:     variables you can modify the order in which the master sites are
                   1862:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1863:     delimited list of domain suffixes.
                   1864:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1865:     contains a whitespace delimited list of regular expressions.  It
                   1866:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1867:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1868:     some examples.  This may save some of your bandwidth and
                   1869:     time.</p>
                   1870: <p>You can change these settings either in your shell's environment, or,
                   1871:     if you want to keep the settings, by editing the
1.10      hubertf  1872:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1873:     and adding the definitions there.</p>
                   1874: <p>
                   1875:       If a package depends on many other packages (such as
                   1876:       <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
                   1877:       alternate between periods of
                   1878:       downloading source, and compiling. To ensure you have all the source
                   1879:       downloaded initially you can run the command:
                   1880:       </p>
                   1881: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1882: <p>
                   1883:       which will output and run a set of shell commands to fetch the
                   1884:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1885:       also choose to download the files manually.
                   1886:     </p>
                   1887: </div>
1.23      wiz      1888: <div class="sect2" title="4.2.3. How to build and install">
1.1       dsieger  1889: <div class="titlepage"><div><div><h3 class="title">
                   1890: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1891: <p>
                   1892:       Once the software has downloaded, any patches will be applied, then it
                   1893:       will be compiled for you. This may take some time depending on your
                   1894:       computer, and how many other packages the software depends on and their
                   1895:       compile time.
                   1896:     </p>
1.23      wiz      1897: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1898: <h3 class="title">Note</h3>
                   1899: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1900:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1901:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1902: </div>
                   1903: <p>For example, type</p>
                   1904: <pre class="screen">
                   1905: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1906: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1907:     </pre>
                   1908: <p>at the shell prompt to build the various components of the
                   1909:     package.</p>
                   1910: <p>The next stage is to actually install the newly compiled
                   1911:     program onto your system. Do this by entering:
                   1912: 
                   1913:     </p>
                   1914: <pre class="screen">
                   1915: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1916:     </pre>
                   1917: <p>
                   1918: 
                   1919:     while you are still in the directory for whatever package you
                   1920:     are installing.</p>
                   1921: <p>Installing the package on your system may require you to
                   1922:     be root.  However, pkgsrc has a
                   1923:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1924:     to only become root for the actual installation step.</p>
                   1925: <p>That's it, the software should now be installed and setup for use.
                   1926:     You can now enter:
                   1927: 
                   1928:     </p>
                   1929: <pre class="screen">
                   1930: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1931:     </pre>
                   1932: <p>
                   1933: 
                   1934:     to remove the compiled files in the work directory, as you shouldn't need
                   1935:     them any more. If other packages were also added to your system
                   1936:     (dependencies) to allow your program to compile, you can tidy these up
                   1937:     also with the command:</p>
                   1938: <pre class="screen">
                   1939: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1940:     </pre>
                   1941: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1942:     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  1943: <p>The program is installed under the default root of the
                   1944:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1945:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1946:     variable in your environment, and it will use that value as the
                   1947:     root of your packages tree. So, to use
                   1948:     <code class="filename">/usr/local</code>, set
                   1949:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1950:     Please note that you should use a directory which is dedicated to
                   1951:     packages and not shared with other programs (i.e., do not try and
                   1952:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1953:     to add any of your own files or directories (such as
                   1954:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1955:     <code class="filename">pkgsrc/</code>) below the
                   1956:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1957:     conflicts between programs and other files installed by the
                   1958:     package system and whatever else may have been installed
                   1959:     there.</p>
1.10      hubertf  1960: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1961:     alter some configuration options at build time.  Have a look at
                   1962:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1963:     of what will be set there by default.  Environment variables such
                   1964:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1965:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1966:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1967: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1968:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1969:     or being installed. This may be for debugging purposes, or out of
                   1970:     simple curiosity. A number of utility values have been added to
                   1971:     help with this.</p>
1.23      wiz      1972: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1973: <li class="listitem">
1.29      dholland 1974: <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  1975:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1976:        information will be displayed. For example,</p>
                   1977: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1978: <p>will show all the commands that are invoked, up to and
1.23      wiz      1979:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1980: </li>
1.23      wiz      1981: <li class="listitem">
1.29      dholland 1982: <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  1983:        definition, then the <code class="varname">VARNAME</code> definition
                   1984:        should be used, in conjunction with the show-var
1.29      dholland 1985:        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  1986:        variable <code class="varname">LOCALBASE</code>:</p>
                   1987: <pre class="screen">
                   1988: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1989: /usr/pkg
                   1990: <code class="prompt">%</code>
                   1991:        </pre>
                   1992: </li>
                   1993: </ol></div>
                   1994: <p>If you want to install a binary package that you've either
                   1995:     created yourself (see next section), that you put into
                   1996:     pkgsrc/packages manually or that is located on a remote FTP
                   1997:     server, you can use the "bin-install" target. This target will
1.29      dholland 1998:     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  1999:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  2000:     sites searched is kept in the variable
                   2001:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.29      dholland 2002:     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  2003:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2004:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2005:     details.</p>
                   2006: <p>A final word of warning: If you set up a system that has a
                   2007:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2008:     set that before any packages are installed, as you cannot use
                   2009:     several directories for the same purpose. Doing so will result in
                   2010:     pkgsrc not being able to properly detect your installed packages,
                   2011:     and fail miserably. Note also that precompiled binary packages are
                   2012:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2013:     <code class="filename">/usr/pkg</code>, and that you should
                   2014:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2015:     <code class="varname">LOCALBASE</code>.</p>
                   2016: </div>
                   2017: </div>
                   2018: </div>
1.23      wiz      2019: <div class="chapter" title="Chapter 5. Configuring pkgsrc">
1.1       dsieger  2020: <div class="titlepage"><div><div><h2 class="title">
                   2021: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2022: <div class="toc">
                   2023: <p><b>Table of Contents</b></p>
                   2024: <dl>
                   2025: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2026: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   2027: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2028: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2029: <dd><dl>
1.4       rillig   2030: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz      2031: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2032: <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  2033: </dl></dd>
1.4       rillig   2034: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2035: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2036: </dl>
                   2037: </div>
1.4       rillig   2038: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2039: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2040: that file depends on the installation. On NetBSD, when you use
1.29      dholland 2041: <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  2042: <code class="filename">/etc/</code>. In all other cases the default location is
                   2043: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2044: bootstrap program to install the binary packages.</p>
                   2045: <p>During the bootstrap, an example configuration file is created. To
                   2046: use that, you have to create the directory
                   2047: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2048: there.</p>
                   2049: <p>The format of the configuration file is that of the usual
                   2050: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2051: is done by setting variables in this file. Note that you can define all
                   2052: kinds of variables, and no special error checking (for example for
                   2053: spelling mistakes) takes place, so you have to try it out to see if it
                   2054: works.</p>
1.23      wiz      2055: <div class="sect1" title="5.1. General configuration">
1.1       dsieger  2056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2057: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2058: <p>In this section, you can find some variables that apply to all
                   2059:     pkgsrc packages. A complete list of the variables that can be
                   2060:     configured by the user is available in
                   2061:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2062:     comments that describe each variable's intent.</p>
1.23      wiz      2063: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2064: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  2065:            packages will be installed. The default is
                   2066:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2067:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      2068: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2069:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  2070:            installed. The default is
                   2071:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      2072: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  2073:            X11 is installed on the system. The default is
                   2074:            <code class="filename">/usr/X11R6</code>.</p></li>
1.23      wiz      2075: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  2076:            downloaded copies of the original source distributions used
                   2077:            for building pkgsrc packages. The default is
                   2078:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      2079: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  2080:            database about installed packages is stored.  The default is
                   2081:            <code class="filename">/var/db/pkg</code>.</p></li>
1.23      wiz      2082: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  2083:            If set, override the packages'
                   2084:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      2085: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  2086:            Backup location(s) for distribution files and patch files
                   2087:            if not found locally or in
                   2088:            <code class="filename">${MASTER_SITES}</code> or
                   2089:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2090:            The defaults are
1.25      spz      2091:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1       dsieger  2092:            and
                   2093:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      2094: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  2095:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2096:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      2097:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2098:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2099: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 2100:            List of acceptable licenses. License names are case-sensitive.
                   2101:            Whenever you try to build a package whose license is not in this
                   2102:            list, you will get an error message. If the license condition is
                   2103:            simple enough, the error message will include specific
                   2104:            instructions on how to change this variable.</p></li>
1.1       dsieger  2105: </ul></div>
                   2106: </div>
1.23      wiz      2107: <div class="sect1" title="5.2. Variables affecting the build process">
1.1       dsieger  2108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2109: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2110: <p>XXX
                   2111:       </p>
1.23      wiz      2112: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2113: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  2114:            directory for the binary packages. The default is
                   2115:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      2116: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  2117:            The top level directory where, if defined, the separate
                   2118:            working directories will get created, and symbolically
                   2119:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2120:            This is useful for building packages on several
                   2121:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2122:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2123:            is local to every architecture. (It should be noted that
                   2124:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 2125:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2126:            root of the pkgsrc tree. It is possible to have many
                   2127:            pkgsrc tree instances.)</p></li>
1.23      wiz      2128: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  2129:            Directory for local patches that aren't part of pkgsrc.
1.10      hubertf  2130:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2131:            information.</p></li>
1.23      wiz      2132: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  2133:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2134:            BSD-style Makefile. If this is not set,
                   2135:            <code class="varname">MAKECONF</code> is set to
                   2136:            <code class="filename">/dev/null</code> to avoid picking up
                   2137:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23      wiz      2138: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger  2139:            By default, dependencies are only installed, and no binary
                   2140:            package is created for them. You can set this variable to
                   2141:            <code class="literal">package</code> to automatically create binary
                   2142:            packages after installing dependencies.</p></li>
                   2143: </ul></div>
                   2144: </div>
1.23      wiz      2145: <div class="sect1" title="5.3. Variables affecting the installation process">
1.1       dsieger  2146: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   2147: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24      wiz      2148: <p>Most packages support installation into a
1.4       rillig   2149:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2150:     to be built, before the actual filesystem is touched. DESTDIR
                   2151:     support exists in two variations:</p>
1.23      wiz      2152: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2153: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      2154:       installation and packaging is still run as root.</p></li>
                   2155: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2156:       build, installation and packaging as normal user. Root
                   2157:       privileges are only needed to add packages.</p></li>
                   2158: </ul></div>
                   2159: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                   2160:     you can set
                   2161:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                   2162:     so it's preferable to convert a package to DESTDIR instead.</p>
1.4       rillig   2163: <p>DESTDIR support changes the behaviour of various targets
                   2164:     slightly. To install a package after building it, use
                   2165:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2166:     <code class="literal">install</code> don't do that any
                   2167:     longer. <code class="literal">package-install</code> can be used as
                   2168:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2169:     will ask for the root password to install the package and fail,
                   2170:     <code class="literal">package-install</code> will ask again.</p>
                   2171: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2172:     clean</code></strong> needs to be run as root.</p>
1.17      imil     2173: <p>Considering the <code class="filename">foo/bar</code> package,
                   2174:     DESTDIR full support can be tested using the following commands
                   2175: 
                   2176: </p>
                   2177: <pre class="programlisting">
                   2178: <code class="prompt">$</code> id
                   2179: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2180: <code class="prompt">$</code> mkdir $HOME/packages
                   2181: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2182: </pre>
                   2183: <p>
                   2184: 
                   2185:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2186:     should be needed
                   2187: 
                   2188: </p>
                   2189: <pre class="programlisting">
1.20      snj      2190: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17      imil     2191: </pre>
                   2192: <p>
                   2193: 
                   2194:     Create a package without root privileges
                   2195: 
                   2196: </p>
                   2197: <pre class="programlisting">
1.20      snj      2198: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17      imil     2199: </pre>
                   2200: <p>
                   2201: 
                   2202:     For the following command, you must be able to gain root
1.29      dholland 2203:     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     2204: 
                   2205: </p>
                   2206: <pre class="programlisting">
1.20      snj      2207: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17      imil     2208: </pre>
                   2209: <p>
                   2210: 
                   2211:     Then, as a simple user
                   2212: 
                   2213: </p>
                   2214: <pre class="programlisting">
                   2215: <code class="prompt">$</code> make clean
                   2216: </pre>
                   2217: <p>
                   2218: 
                   2219:     </p>
1.4       rillig   2220: </div>
1.23      wiz      2221: <div class="sect1" title="5.4. Selecting and configuring the compiler">
1.4       rillig   2222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2223: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.23      wiz      2224: <div class="sect2" title="5.4.1. Selecting the compiler">
1.1       dsieger  2225: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2226: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2227: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2228:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2229: <div class="variablelist"><dl>
                   2230: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2231: <dd>
                   2232: <p>This is a list of values specifying the chain of
                   2233:          compilers to invoke when building packages.  Valid values
                   2234:          are:</p>
1.23      wiz      2235: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2236: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  2237:            distributed C/C++ (chainable)</p></li>
1.23      wiz      2238: <li class="listitem"><p><code class="varname">ccache</code>:
1.1       dsieger  2239:            compiler cache (chainable)</p></li>
1.23      wiz      2240: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  2241:            GNU C/C++ Compiler</p></li>
1.23      wiz      2242: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2243:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23      wiz      2244: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2245:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      2246: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  2247:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2248: </ul></div>
                   2249: <p>The default is
1.23      wiz      2250:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  2251:          <code class="varname">ccache</code> and/or
                   2252:          <code class="varname">distcc</code> with an appropriate
                   2253:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      2254:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  2255:          variable should always be terminated with a value for
                   2256:          a real compiler.  Note that only one real compiler
1.23      wiz      2257:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  2258:          is not allowed).</p>
                   2259: </dd>
                   2260: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2261: <dd><p>This specifies the minimum version of GCC to use
                   2262:          when building packages.  If the system GCC doesn't
                   2263:          satisfy this requirement, then pkgsrc will build and
                   2264:          install one of the GCC packages to use instead.</p></dd>
                   2265: </dl></div>
                   2266: </div>
1.23      wiz      2267: <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
1.1       dsieger  2268: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2269: <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  2270: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2271:        please make sure to use the <code class="literal">+=</code> operator
                   2272:        instead of the <code class="literal">=</code> operator:</p>
                   2273: <pre class="programlisting">
                   2274: CFLAGS+=        -your -flags
                   2275: </pre>
                   2276: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      2277:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  2278:        need to add their own flags.  You may want to take a look
                   2279:        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      2280:        package if you're interested in optimization specifically
                   2281:        for the current CPU. </p>
1.1       dsieger  2282: </div>
1.23      wiz      2283: <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
1.1       dsieger  2284: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2285: <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  2286: <p>If you want to pass flags to the linker, both in the configure
                   2287: step and the build step, you can do this in two ways.  Either set
                   2288: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2289: between the two is that <code class="varname">LIBS</code> will be appended to
                   2290: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2291: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2292: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2293: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2294: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2295: settings, use the <code class="literal">+=</code> operator:</p>
                   2296: <pre class="programlisting">
                   2297: LDFLAGS+=        -your -linkerflags
                   2298: </pre>
                   2299: </div>
                   2300: </div>
1.23      wiz      2301: <div class="sect1" title="5.5. Developer/advanced settings">
1.1       dsieger  2302: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2303: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2304: <p>XXX
                   2305:       </p>
1.23      wiz      2306: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2307: <li class="listitem">
1.1       dsieger  2308: <p><code class="varname">PKG_DEVELOPER</code>:
                   2309:            Run some sanity checks that package developers want:
                   2310:            </p>
1.23      wiz      2311: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2312: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  2313:              fuzz</p></li>
1.23      wiz      2314: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  2315:              binaries will find their shared libs.</p></li>
                   2316: </ul></div>
                   2317: <p>
                   2318:        </p>
                   2319: </li>
1.23      wiz      2320: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  2321:        of debugging output which is displayed whilst making and
                   2322:        installing the package.  The default value for this is 0,
                   2323:        which will not display the commands as they are executed
                   2324:        (normal, default, quiet operation); the value 1 will display
                   2325:        all shell commands before their invocation, and the value 2
                   2326:        will display both the shell commands before their invocation,
1.10      hubertf  2327:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger  2328:        -x</strong></span> will be displayed.</p></li>
                   2329: </ul></div>
                   2330: <p>
                   2331:     </p>
                   2332: </div>
1.23      wiz      2333: <div class="sect1" title="5.6. Selecting Build Options">
1.1       dsieger  2334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2335: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2336: <p>Some packages have build time options, usually to select
                   2337:     between different dependencies, enable optional support for big
                   2338:     dependencies or enable experimental features.</p>
                   2339: <p>To see which options, if any, a package supports, and which
1.10      hubertf  2340:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2341:     show-options</strong></span>, for example:</p>
                   2342: <pre class="programlisting">
                   2343:     The following options are supported by this package:
                   2344:         ssl      Enable SSL support.
                   2345:     Exactly one of the following gecko options is required:
                   2346:         firefox  Use firefox as gecko rendering engine.
                   2347:         mozilla  Use mozilla as gecko rendering engine.
                   2348:     At most one of the following database options may be selected:
                   2349:         mysql    Enable support for MySQL database.
                   2350:         pgsql    Enable support for PostgreSQL database.
                   2351: 
                   2352:     These options are enabled by default: firefox
                   2353:     These options are currently enabled: mozilla ssl
                   2354: </pre>
                   2355: <p>The following variables can be defined in
1.10      hubertf  2356:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2357:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2358:     which can be used to select or disable options for all packages
                   2359:     that support them, and
                   2360:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2361:     which can be used to select or disable options specifically for
                   2362:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      2363:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2364:     are disabled. A few examples:</p>
                   2365: <pre class="screen">
1.10      hubertf  2366: <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  2367: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2368: PKG_OPTIONS.kdebase=    debug -sasl
                   2369: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2370: <p>It is important to note that options that were specifically
1.18      snj      2371:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   2372:     you do not wish to include the option.  If you are unsure you can view
                   2373:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2374: <p>The following settings are consulted in the order given, and
                   2375:     the last setting that selects or disables an option is
                   2376:     used:</p>
1.23      wiz      2377: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2378: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2379:       maintainer</p></li>
1.23      wiz      2380: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2381:       variables (see below)</p></li>
1.23      wiz      2382: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2383: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  2384: </ol></div>
                   2385: <p>For groups of mutually exclusive options, the last option
                   2386:     selected is used, all others are automatically disabled.  If an
                   2387:     option of the group is explicitly disabled, the previously
                   2388:     selected option, if any, is used.  It is an error if no option
                   2389:     from a required group of options is selected, and building the
                   2390:     package will fail.</p>
                   2391: <p>Before the options framework was introduced, build options
                   2392:     were selected by setting a variable (often named
                   2393:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2394:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2395:     transition to the options framework for the user, these legacy
                   2396:     variables are converted to the appropriate options setting
                   2397:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2398:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2399:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2400:     directly.  Support for the legacy variables will be removed
                   2401:     eventually.</p>
                   2402: </div>
                   2403: </div>
1.23      wiz      2404: <div class="chapter" title="Chapter 6. Creating binary packages">
1.1       dsieger  2405: <div class="titlepage"><div><div><h2 class="title">
                   2406: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2407: <div class="toc">
                   2408: <p><b>Table of Contents</b></p>
                   2409: <dl>
                   2410: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2411: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2412: </dl>
                   2413: </div>
1.23      wiz      2414: <div class="sect1" title="6.1. Building a single binary package">
1.1       dsieger  2415: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2416: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2417: <p>Once you have built and installed a package, you can create
                   2418:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29      dholland 2419:     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  2420:     the same package on a group of hosts and wasting CPU time. It also
                   2421:     provides a simple means for others to install your package, should
                   2422:     you distribute it.</p>
                   2423: <p>To create a binary package, change into the appropriate
1.10      hubertf  2424:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2425:     package</strong></span>:</p>
                   2426: <pre class="screen">
                   2427: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2428: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2429:     </pre>
                   2430: <p>This will build and install your package (if not already done),
                   2431:     and then build a binary package from what was installed. You can
1.10      hubertf  2432:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2433:     it. Binary packages are created by default in
                   2434:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2435:     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  2436:     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  2437: <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  2438:     such a binary package.</p>
                   2439: </div>
1.23      wiz      2440: <div class="sect1" title="6.2. Settings for creation of binary packages">
1.1       dsieger  2441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2442: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2443: <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   2444: </div>
                   2445: </div>
1.23      wiz      2446: <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
1.6       rillig   2447: <div class="titlepage"><div><div><h2 class="title">
                   2448: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2449: builds)</h2></div></div></div>
                   2450: <div class="toc">
                   2451: <p><b>Table of Contents</b></p>
                   2452: <dl>
                   2453: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2454: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2455: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2456: <dd><dl>
                   2457: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2458: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2459: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2460: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2461: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2462: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2463: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2464: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2465: </dl></dd>
                   2466: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig   2467: <dd><dl>
                   2468: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2469: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2470: </dl></dd>
1.6       rillig   2471: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2472: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2473: </dl>
                   2474: </div>
                   2475: <p>When you have multiple machines that should run the same packages,
                   2476: it is wasted time if they all build their packages themselves from
                   2477: source. There are two ways of getting a set of binary packages: The old
                   2478: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2479: system. This chapter describes how to set them up so that the packages
                   2480: are most likely to be usable later.</p>
1.23      wiz      2481: <div class="sect1" title="7.1. Think first, build later">
1.6       rillig   2482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2483: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2484: <p>Since a bulk build takes several days or even weeks to finish, you
                   2485: should think about the setup before you start everything. Pay attention
                   2486: to at least the following points:</p>
1.23      wiz      2487: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2488: <li class="listitem">
1.6       rillig   2489: <p>If you want to upload the binary packages to
                   2490: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2491: packages:</p>
1.23      wiz      2492: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2493: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6       rillig   2494: by a NetBSD developer on a trusted machine (that is, where you and only
                   2495: you have root access).</p></li>
1.23      wiz      2496: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21      snj      2497: the stable branches (like 2009Q1), so that users browsing the available
1.6       rillig   2498: collections can see at a glance how old the packages
                   2499: are.</p></li>
1.23      wiz      2500: <li class="listitem"><p>The packages must be built as root, since some packages
1.6       rillig   2501: require set-uid binaries at runtime, and creating those packages as
                   2502: unprivileged user doesn't work well at the moment.</p></li>
                   2503: </ul></div>
                   2504: </li>
1.23      wiz      2505: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6       rillig   2506: your system. Most bulk builds run as root, so they should be run at least
                   2507: in a chroot environment or something even more restrictive, depending on
                   2508: what the operating system provides. There have been numerous cases where
                   2509: certain packages tried to install files outside the
                   2510: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2511: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2512: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2513: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2514: that you don't need any package during the build.</p></li>
                   2515: </ul></div>
                   2516: </div>
1.23      wiz      2517: <div class="sect1" title="7.2. Requirements of a bulk build">
1.6       rillig   2518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2519: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2520: <p>A complete bulk build requires lots of disk space. Some of the
                   2521: disk space can be read-only, some other must be writable. Some can be on
                   2522: remote filesystems (such as NFS) and some should be local. Some can be
                   2523: temporary filesystems, others must survive a sudden reboot.</p>
1.23      wiz      2524: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2525: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2526: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2527: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2528: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2529: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2530: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6       rillig   2531: </ul></div>
1.1       dsieger  2532: </div>
1.23      wiz      2533: <div class="sect1" title="7.3. Running an old-style bulk build">
1.1       dsieger  2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2535: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.23      wiz      2536: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15      rillig   2537: <h3 class="title">Note</h3>
                   2538: <p>There are two ways of doing a bulk build. The old-style
1.23      wiz      2539: one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
1.15      rillig   2540: way.</p>
1.6       rillig   2541: </div>
1.23      wiz      2542: <div class="sect2" title="7.3.1. Configuration">
1.1       dsieger  2543: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2544: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.23      wiz      2545: <div class="sect3" title="7.3.1.1. build.conf">
1.1       dsieger  2546: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2547: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2548: </h4></div></div></div>
                   2549: <p>The <code class="filename">build.conf</code> file is the main
                   2550:        configuration file for bulk builds. You can configure how your
                   2551:        copy of pkgsrc is kept up to date, how the distfiles are
                   2552:        downloaded, how the packages are built and how the report is
                   2553:        generated. You can find an annotated example file in
                   2554:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2555:        it, copy <code class="filename">build.conf-example</code> to
                   2556:        <code class="filename">build.conf</code> and edit it, following the
                   2557:        comments in that file.</p>
                   2558: </div>
1.23      wiz      2559: <div class="sect3" title="7.3.1.2. mk.conf">
1.1       dsieger  2560: <div class="titlepage"><div><div><h4 class="title">
1.10      hubertf  2561: <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   2562: </h4></div></div></div>
1.10      hubertf  2563: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2564:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2565:        details of the default settings. You will want to ensure that
                   2566:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22      jakllsch 2567:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4       rillig   2568:        completely bypasses the license check.</p>
1.1       dsieger  2569: <pre class="programlisting">
                   2570: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2571: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2572: BSDSRCDIR=      /usr/src
                   2573: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2574: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2575: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2576: PKG_DEVELOPER?= yes
1.22      jakllsch 2577: SKIP_LICENSE_CHECK=    yes
1.1       dsieger  2578: </pre>
                   2579: <p>Some options that are especially useful for bulk builds
                   2580:        can be found at the top lines of the file
                   2581:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2582:        options of these are briefly described here.</p>
1.23      wiz      2583: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2584: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1       dsieger  2585:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23      wiz      2586:          <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
                   2587: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1       dsieger  2588:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2589:          to the directory where all log files are created. Otherwise the
                   2590:          log files are created in the pkgsrc directory.</p></li>
1.23      wiz      2591: <li class="listitem"><p>Another important variable is
1.1       dsieger  2592:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2593:          should be always available while building other
                   2594:          packages.</p></li>
                   2595: </ul></div>
                   2596: <p>Some other options are scattered in the pkgsrc
                   2597:        infrastructure:</p>
1.23      wiz      2598: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2599: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2600:          should be set to <code class="literal">yes</code>. The purpose of the
                   2601:          bulk builds is creating binary packages, no matter if they
                   2602:          are vulnerable or not. Leaving this variable unset would
                   2603:          prevent the bulk build system from even trying to build
                   2604:          them, so possible building errors would not show
                   2605:          up.</p></li>
                   2606: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1       dsieger  2607:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23      wiz      2608:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
1.1       dsieger  2609:          matches the <code class="filename">PLIST</code>.</p></li>
1.23      wiz      2610: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1       dsieger  2611:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23      wiz      2612:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
                   2613:          <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
1.1       dsieger  2614:          interpreter.</p></li>
1.23      wiz      2615: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2616:          set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
1.1       dsieger  2617:          package's self-test before installing it. Note that some
1.23      wiz      2618:          packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
1.1       dsieger  2619:          numbers, so you need to assure that the machine on which you
                   2620:          are doing the bulk builds is not completely idle. Otherwise
                   2621:          some test programs will seem to hang, while they are just
                   2622:          waiting for new random data to be
                   2623:          available.</p></li>
                   2624: </ul></div>
                   2625: </div>
1.23      wiz      2626: <div class="sect3" title="7.3.1.3. pre-build.local">
1.1       dsieger  2627: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2628: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2629: </h4></div></div></div>
                   2630: <p>It is possible to configure the bulk build to perform
                   2631:        certain site-specific tasks at the end of the pre-build
                   2632:        stage.  If the file
                   2633:        <code class="filename">pre-build.local</code> exists in
                   2634:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29      dholland 2635:        (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  2636:        stage.  An example use of
                   2637:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2638: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2639:        &gt; misc/openoffice/$BROKENF</pre>
                   2640: <p>to prevent the system from trying to build a particular package
                   2641:        which requires nearly 3 GB of disk space.</p>
                   2642: </div>
                   2643: </div>
1.23      wiz      2644: <div class="sect2" title="7.3.2. Other environmental considerations">
1.1       dsieger  2645: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2646: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2647: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2648:       deleted at the start of bulk builds, make sure your login
                   2649:       shell is placed somewhere else. Either drop it into
                   2650:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2651:       shell in the passwd file), or (re-)install it via
1.29      dholland 2652:       <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  2653:       you can login after a reboot (remember that your current
                   2654:       process won't die if the package is removed, you just can't
                   2655:       start any new instances of the shell any more).  Also, if you
                   2656:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2657:       version of ssh for some reason, be sure to install ssh before
                   2658:       starting it from <code class="filename">rc.local</code>:</p>
                   2659: <pre class="programlisting">
                   2660: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2661: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2662:   /usr/pkg/etc/rc.d/sshd
                   2663: fi
                   2664: </pre>
                   2665: <p>Not doing so will result in you being not able to log in
                   2666:       via ssh after the bulk build is finished or if the machine
                   2667:       gets rebooted or crashes. You have been warned! :)</p>
                   2668: </div>
1.23      wiz      2669: <div class="sect2" title="7.3.3. Operation">
1.1       dsieger  2670: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2671: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2672: <p>Make sure you don't need any of the packages still
                   2673:       installed.</p>
1.23      wiz      2674: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  2675: <h3 class="title">Warning</h3>
                   2676: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2677:        configuration files and some more files from
                   2678:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2679:        possibly other locations will be removed! So don't run a bulk
                   2680:        build with privileges that might harm your
                   2681:        system.</em></span></p>
                   2682: </div>
                   2683: <p>Be sure to remove all other things that might
                   2684:       interfere with builds, like some libs installed in
                   2685:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2686: <pre class="screen">
                   2687: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2688: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2689:       </pre>
                   2690: <p>If for some reason your last build didn't complete (power
                   2691:       failure, system panic, ...), you can continue it by
                   2692:       running:</p>
                   2693: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2694: <p>At the end of the bulk build, you will get a summary via mail,
                   2695:       and find build logs in the directory specified by
                   2696:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2697:       file.</p>
                   2698: </div>
1.23      wiz      2699: <div class="sect2" title="7.3.4. What it does">
1.1       dsieger  2700: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2701: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2702: <p>The bulk builds consist of three steps:</p>
                   2703: <div class="variablelist"><dl>
                   2704: <dt><span class="term">1. pre-build</span></dt>
                   2705: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2706:            cleans out any broken distfiles, and removes all
                   2707:            packages installed.</p></dd>
                   2708: <dt><span class="term">2. the bulk build</span></dt>
1.23      wiz      2709: <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
1.1       dsieger  2710:            an optimised order in which packages will be
                   2711:            built. Packages that don't require other packages will
                   2712:            be built first, and packages with many dependencies will
                   2713:            be built later.</p></dd>
                   2714: <dt><span class="term">3. post-build</span></dt>
                   2715: <dd><p>Generates a report that's placed in the directory
                   2716:            specified in the <code class="filename">build.conf</code> file
                   2717:            named <code class="filename">broken.html</code>, a short version
                   2718:            of that report will also be mailed to the build's
                   2719:            admin.</p></dd>
                   2720: </dl></div>
                   2721: <p>During the build, a list of broken packages will be compiled
                   2722:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2723:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2724:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2725:       of broken builds can be found in the package's
                   2726:       directory. These files are used by the bulk-targets to mark
                   2727:       broken builds to not waste time trying to rebuild them, and
                   2728:       they can be used to debug these broken package builds
                   2729:       later.</p>
                   2730: </div>
1.23      wiz      2731: <div class="sect2" title="7.3.5. Disk space requirements">
1.1       dsieger  2732: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2733: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2734: <p>Currently, roughly the following requirements are valid for
                   2735:       NetBSD 2.0/i386:</p>
1.23      wiz      2736: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2737: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
                   2738: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2739: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1       dsieger  2740: </ul></div>
                   2741: <p>Note that all pkgs will be de-installed as soon as they are
                   2742:       turned into a binary package, and that sources are removed,
                   2743:       so there is no excessively huge demand to disk
                   2744:       space. Afterwards, if the package is needed again, it will
1.29      dholland 2745:       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  2746:       there are no cycles wasted by recompiling.</p>
                   2747: </div>
1.23      wiz      2748: <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
1.1       dsieger  2749: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2750: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2751: <p>If you don't want all the packages nuked from a machine
                   2752:       (rendering it useless for anything but pkg compiling), there
                   2753:       is the possibility of doing the package bulk build inside a
                   2754:       chroot environment.</p>
                   2755: <p>The first step is to set up a chroot sandbox,
                   2756:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2757:       using null mounts, or manually.</p>
                   2758: <p>There is a shell script called
                   2759:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2760:       up the sandbox environment using null mounts. It will also
                   2761:       create a script called <code class="filename">sandbox</code> in the
                   2762:       root of the sandbox environment, which will allow the null
1.10      hubertf  2763:       mounts to be activated using the <span class="command"><strong>sandbox
1.1       dsieger  2764:       mount</strong></span> command and deactivated using the
1.10      hubertf  2765:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1       dsieger  2766: <p>To set up a sandbox environment by hand, after extracting all
1.10      hubertf  2767:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1       dsieger  2768:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2769:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2770:       are present and properly configured:</p>
1.23      wiz      2771: <div class="procedure"><ol class="procedure" type="1">
                   2772: <li class="step" title="Step 1">
1.1       dsieger  2773: <p>Kernel</p>
                   2774: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2775: </li>
1.23      wiz      2776: <li class="step" title="Step 2">
1.1       dsieger  2777: <p><code class="filename">/dev/*</code></p>
                   2778: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2779: </li>
1.23      wiz      2780: <li class="step" title="Step 3">
1.1       dsieger  2781: <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>
                   2782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2783: </li>
1.23      wiz      2784: <li class="step" title="Step 4">
1.1       dsieger  2785: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2786: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2787: </li>
1.23      wiz      2788: <li class="step" title="Step 5">
1.1       dsieger  2789: <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>
                   2790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2791: </li>
1.23      wiz      2792: <li class="step" title="Step 6">
1.1       dsieger  2793: <p><code class="filename">/usr/src</code> (system sources,
1.14      jmcneill 2794:          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  2795: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2796:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2797: </li>
1.23      wiz      2798: <li class="step" title="Step 7">
1.1       dsieger  2799: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2801: </li>
1.23      wiz      2802: <li class="step" title="Step 8">
1.1       dsieger  2803: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2805: </li>
1.23      wiz      2806: <li class="step" title="Step 9">
1.1       dsieger  2807: <p>Checkout pkgsrc via cvs into
                   2808:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2809: <pre class="screen">
                   2810: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2811: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2812:          </pre>
                   2813: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2814:          you do development in, as this will likely cause problems!</p>
                   2815: </li>
1.23      wiz      2816: <li class="step" title="Step 10"><p>Make
1.1       dsieger  2817:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2818:          <code class="filename">.../distfiles</code> point somewhere
                   2819:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.23      wiz      2820: <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>
                   2821: <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  2822: </ol></div>
                   2823: <p>When the chroot sandbox is set up, you can start
                   2824:       the build with the following steps:</p>
                   2825: <pre class="screen">
                   2826: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2827: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2828:       </pre>
                   2829: <p>This will just jump inside the sandbox and start building.  At
                   2830:        the end of the build, mail will be sent with the results of
                   2831:        the build. Created binary pkgs will be in
                   2832:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2833:       (wherever that points/mounts to/from).</p>
                   2834: </div>
1.23      wiz      2835: <div class="sect2" title="7.3.7. Building a partial set of packages">
1.1       dsieger  2836: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2837: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2838: <p>In addition to building a complete set of all packages in
                   2839:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2840:       may be used to build a subset of the packages contained in
                   2841:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.10      hubertf  2842:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.23      wiz      2843: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2844: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
                   2845: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
                   2846: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
                   2847: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1       dsieger  2848: </ul></div>
                   2849: <p>will define the set of packages which should be built.
                   2850:       The bulk build code will also include any packages which are
                   2851:       needed as dependencies for the explicitly listed packages.</p>
                   2852: <p>One use of this is to do a bulk build with
                   2853:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2854:       periodically to have a complete set of the binary packages
                   2855:       needed for your site available without the overhead of
                   2856:       building extra packages that are not needed.</p>
                   2857: </div>
1.23      wiz      2858: <div class="sect2" title="7.3.8. Uploading results of a bulk build">
1.1       dsieger  2859: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2860: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2861: <p>This section describes how pkgsrc developers can upload binary
                   2862:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2863: <p>If you would like to automatically create checksum files for the
                   2864:       binary packages you intend to upload, remember to set
                   2865:       <code class="varname">MKSUMS=yes</code> in your
                   2866:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2867: <p>If you would like to PGP sign the checksum files (highly
                   2868:       recommended!), remember to set
                   2869:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2870:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2871:       your GPG password to sign the files before uploading everything.</p>
                   2872: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2873:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2874:       file, i.e. adjust it to something like one of the following:</p>
1.25      spz      2875: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
                   2876: <p>Please use appropriate values for "20xxQy" (the branch),
                   2877:       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1       dsieger  2878:       is different from your local login, write your login directly
                   2879:       into the variable, e.g. my local account is "feyrer", but for my
                   2880:       login "hubertf", I use:</p>
1.25      spz      2881: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1       dsieger  2882: <p>A separate <code class="filename">upload</code> directory is used
                   2883:       here to allow "closing" the directory during upload. To do
                   2884:       so, run the following command on ftp.NetBSD.org next:</p>
1.25      spz      2885: <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  2886: <p>Before uploading the binary pkgs, ssh authentication needs
                   2887:       to be set up. This example shows how to set up temporary keys
                   2888:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2889:       (assuming that no keys should be present there usually):</p>
                   2890: <pre class="screen">
                   2891: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2892: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25      spz      2893: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
                   2894: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1       dsieger  2895:       </pre>
1.25      spz      2896: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1       dsieger  2897:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25      spz      2898:       file on ftp.NetBSD.org. You should remove the key after the
1.1       dsieger  2899:       upload is done!</p>
                   2900: <p>Next, test if your ssh connection really works:</p>
                   2901: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2902: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2903: <p>Now after all this works, you can exit the sandbox and start
                   2904:       the upload:</p>
                   2905: <pre class="screen">
                   2906: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2907: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2908: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2909:       </pre>
1.29      dholland 2910: <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
                   2911:       <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  2912:       upload. The upload script will take care of not uploading
1.23      wiz      2913:       restricted packages.</p>
1.1       dsieger  2914: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2915: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2916:       Gdd:x! </pre>
                   2917: <p>Use whatever is needed to remove the key you've entered
                   2918:       before! Last, move the uploaded packages out of the
                   2919:       <code class="filename">upload</code> directory to have them accessible
                   2920:       to everyone:</p>
                   2921: <pre class="screen">
1.25      spz      2922: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1       dsieger  2923: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2924: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25      spz      2925: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
                   2926: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1       dsieger  2927:       </pre>
                   2928: </div>
                   2929: </div>
1.23      wiz      2930: <div class="sect1" title="7.4. Running a pbulk-style bulk build">
1.1       dsieger  2931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2932: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2933: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.23      wiz      2934: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2935: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2936: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2937: </ul></div>
1.23      wiz      2938: <div class="sect2" title="7.4.1. Preparation">
1.15      rillig   2939: <div class="titlepage"><div><div><h3 class="title">
                   2940: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
                   2941: <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>
                   2942: <pre class="screen">
                   2943: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2944: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   2945: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   2946: </pre>
                   2947: <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      2948: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2949: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   2950: <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>
                   2951: <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>
                   2952: <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>
                   2953: <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   2954: </ul></div>
                   2955: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   2956: <pre class="screen">
                   2957: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   2958: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   2959: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   2960: </pre>
                   2961: <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>
                   2962: </div>
1.23      wiz      2963: <div class="sect2" title="7.4.2. Configuration">
1.6       rillig   2964: <div class="titlepage"><div><div><h3 class="title">
1.15      rillig   2965: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14      jmcneill 2966: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15      rillig   2967: <p>TODO: continue writing</p>
1.6       rillig   2968: </div>
                   2969: </div>
1.23      wiz      2970: <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
1.6       rillig   2971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2972: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2973: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2974:     create a CD-ROM set of the resulting binary packages to assist
                   2975:     in installing packages on other machines.  The
                   2976:     <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
                   2977:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2978:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2979:     way that keeps all the dependencies for a given package on the same
                   2980:     CD as that package.</p>
1.23      wiz      2981: <div class="sect2" title="7.5.1. Example of cdpack">
1.1       dsieger  2982: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2983: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2984: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2985:       man page. The following short example assumes that the binary
                   2986:       packages are left in
                   2987:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2988:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2989:       hold the ISO 9660 images.</p>
                   2990: <pre class="screen">
                   2991: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2992: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2993: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2994:       </pre>
                   2995: <p>If you wish to include a common set of files
                   2996:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2997:       etc.) on each CD in the collection, then you need to create a
                   2998:       directory which contains these files. e.g.</p>
                   2999: <pre class="screen">
                   3000: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   3001: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3002: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3003: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3004: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3005: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   3006: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3007:       </pre>
                   3008: <p>Now create the images:</p>
                   3009: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   3010: <p>Each image will contain <code class="filename">README</code>,
                   3011:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3012:       in their root directories.</p>
                   3013: </div>
                   3014: </div>
                   3015: </div>
1.23      wiz      3016: <div class="chapter" title="Chapter 8. Directory layout of the installed files">
1.1       dsieger  3017: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3018: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  3019: <div class="toc">
                   3020: <p><b>Table of Contents</b></p>
                   3021: <dl>
1.23      wiz      3022: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3023: <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  3024: </dl>
                   3025: </div>
                   3026: <p>The files that are installed by pkgsrc are organized in a way that
                   3027: is similar to what you find in the <code class="filename">/usr</code> directory
                   3028: of the base system. But some details are different. This is because
                   3029: pkgsrc initially came from FreeBSD and had adopted its file system
                   3030: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3031: which operating system you are using pkgsrc with, you can expect the
                   3032: same layout for pkgsrc.</p>
                   3033: <p>There are mainly four root directories for pkgsrc, which are all
                   3034: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3035: When pkgsrc has been installed as root, the default locations
                   3036: are:</p>
                   3037: <pre class="programlisting">
                   3038: LOCALBASE=              /usr/pkg
                   3039: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3040: VARBASE=                /var
                   3041: PKG_DBDIR=              /var/db/pkg
                   3042: </pre>
                   3043: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3044: user), the default locations are:</p>
                   3045: <pre class="programlisting">
                   3046: LOCALBASE=              ${HOME}/pkg
                   3047: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3048: VARBASE=                ${HOME}/pkg/var
                   3049: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3050: </pre>
                   3051: <p>What these four directories are for, and what they look like is
                   3052: explained below.</p>
1.23      wiz      3053: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3054: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  3055: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      3056: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  3057: the well-known subdirectories like <code class="filename">bin</code>,
                   3058: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3059: <code class="filename">share</code> and
                   3060: <code class="filename">sbin</code>.</p></li>
1.23      wiz      3061: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  3062: <code class="filename">/var</code> in the base system. Some programs (especially
                   3063: games, network daemons) need write access to it during normal
                   3064: operation.</p></li>
1.23      wiz      3065: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  3066: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  3067: 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  3068: itself.</p></li>
                   3069: </ul></div>
1.23      wiz      3070: <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
1.1       dsieger  3071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3072: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3073: </h2></div></div></div>
                   3074: <p>The following directories exist in a typical pkgsrc installation
                   3075: in <code class="filename">${LOCALBASE}</code>.</p>
                   3076: <div class="variablelist"><dl>
                   3077: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3078: <dd><p>Contains executable programs that are intended to be
                   3079: directly used by the end user.</p></dd>
                   3080: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3081: <dd><p>Contains files for the emulation layers of various other
                   3082: operating systems, especially for
                   3083: NetBSD.</p></dd>
                   3084: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3085: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3086: <dd><p>Contains
                   3087: the configuration files.</p></dd>
                   3088: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3089: <dd><p>Contains headers for the C and C++ programming
                   3090: languages.</p></dd>
                   3091: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3092: <dd><p>Contains GNU info files of various
                   3093: packages.</p></dd>
                   3094: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3095: <dd><p>Contains shared and static
                   3096: libraries.</p></dd>
                   3097: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3098: <dd><p>Contains data files that don't change after
                   3099: installation. Other data files belong into
                   3100: <code class="filename">${VARBASE}</code>.</p></dd>
                   3101: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3102: <dd><p>Contains programs that are not intended to be used by
                   3103: end users, such as helper programs or network
                   3104: daemons.</p></dd>
                   3105: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3106: <dd><p>Contains programs that are intended to be executed as
                   3107: CGI scripts by a web server.</p></dd>
                   3108: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3109: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3110: <dd><p>Contains brief
                   3111: documentation in form of manual pages.</p></dd>
                   3112: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3113: <dd><p>Contains programs that are intended to be used only by
                   3114: the super-user.</p></dd>
                   3115: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3116: <dd><p>Contains platform-independent data files that don't
                   3117: change after installation.</p></dd>
                   3118: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3119: <dd><p>Contains documentation files provided by the
                   3120: packages.</p></dd>
                   3121: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3122: <dd><p>Contains example files provided by the packages. Among
                   3123: others, the original configuration files are saved here and copied to
                   3124: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3125: installation.</p></dd>
                   3126: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3127: <dd><p>Contains the original files for rc.d
                   3128: scripts.</p></dd>
                   3129: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3130: <code class="filename">${VARBASE}</code>)</span></dt>
                   3131: <dd><p>Contains files
                   3132: that may be modified after
                   3133: installation.</p></dd>
                   3134: </dl></div>
                   3135: </div>
1.23      wiz      3136: <div class="sect1" title="8.2. File system layout in ${VARBASE}">
1.1       dsieger  3137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3138: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3139: </h2></div></div></div>
                   3140: <div class="variablelist"><dl>
                   3141: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3142: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3143: <dd><p>Contains
                   3144: information about the currently installed
                   3145: packages.</p></dd>
                   3146: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3147: <dd><p>Contains highscore
                   3148: files.</p></dd>
                   3149: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3150: <dd><p>Contains log files.</p></dd>
                   3151: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3152: <dd><p>Contains informational files about daemons that are
                   3153: currently running.</p></dd>
                   3154: </dl></div>
                   3155: </div>
                   3156: </div>
1.23      wiz      3157: <div class="chapter" title="Chapter 9. Frequently Asked Questions">
1.1       dsieger  3158: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3159: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3160: <div class="toc">
                   3161: <p><b>Table of Contents</b></p>
                   3162: <dl>
1.6       rillig   3163: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3164: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3165: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3166: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3167: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3168: <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>
                   3169: <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      3170: <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   3171: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz      3172: <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
                   3173: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                   3174: <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   3175: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3176: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3177: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz      3178: <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   3179: <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      3180: <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  3181: </dl>
                   3182: </div>
                   3183: <p>This section contains hints, tips &amp; tricks on special things in
                   3184: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3185: it contains items for both pkgsrc users and developers.</p>
1.23      wiz      3186: <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
1.1       dsieger  3187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3188: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3189: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.23      wiz      3190: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3191: <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  3192:          This is a general purpose list for most issues regarding
                   3193:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3194:          for pkgsrc configuration, unexpected build failures, using
                   3195:          particular packages, upgrading pkgsrc installations,
                   3196:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3197:          proposals for changes that impact the pkgsrc user community,
                   3198:          e.g. major infrastructure changes, new features, package
                   3199:          removals, etc., may also be posted.</p></li>
1.23      wiz      3200: <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  3201:          A list where the results of pkgsrc bulk builds are sent and
                   3202:          discussed.</p></li>
1.23      wiz      3203: <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  3204:          This list is for those who are interested in getting a
                   3205:          commit message for every change committed to pkgsrc. It is
                   3206:          also available in digest form, meaning one daily message
                   3207:          containing all commit messages for changes to the package
                   3208:          source tree in that 24 hour period.</p></li>
                   3209: </ul></div>
                   3210: <p>To subscribe, do:</p>
                   3211: <pre class="programlisting">
                   3212: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3213: </pre>
                   3214: <p>Archives for all these mailing lists are available from
1.10      hubertf  3215: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  3216: </div>
1.23      wiz      3217: <div class="sect1" title="9.2. Where's the pkgviews documentation?">
1.1       dsieger  3218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3219: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3220: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3221: pkgviews User's guide in
                   3222: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3223: </div>
1.23      wiz      3224: <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
1.1       dsieger  3225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3226: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3227: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3228: a number of useful utilities for both users and developers of pkgsrc.  This
                   3229: section attempts only to make the reader aware of the utilities and when
                   3230: they might be useful, and not to duplicate the documentation that comes
                   3231: with each package.</p>
                   3232: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.23      wiz      3233: <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  3234:       Symlinks for use by buildlink.</p></li></ul></div>
                   3235: <p>OS tool augmentation (automatically installed when needed):</p>
1.23      wiz      3236: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3237: <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  3238:       Calculates various kinds of checksums (including SHA1).</p></li>
1.23      wiz      3239: <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  3240:       Compatibility library for pkgsrc tools.</p></li>
1.23      wiz      3241: <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  3242:       non-BSD systems due to lack of native mtree.</p></li>
1.23      wiz      3243: <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  3244:       Up-to-date replacement for
                   3245:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3246:       systems where pkg_install is not present.</p></li>
                   3247: </ul></div>
                   3248: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.23      wiz      3249: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3250: <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  3251:       Create a binary package from an
1.10      hubertf  3252:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  3253:       save the old package.</p></li>
1.23      wiz      3254: <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  3255:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3256:       from multiple locations. It currently supports the following
                   3257:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23      wiz      3258: <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  3259:       packages someplace else (enabled by default).</p></li>
1.23      wiz      3260: <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  3261:       the best compiler flags to optimise code for your current
1.23      wiz      3262:       CPU and compiler. </p></li>
1.1       dsieger  3263: </ul></div>
                   3264: <p>Utilities for keeping track of installed packages, being up to date,
                   3265: etc:</p>
1.23      wiz      3266: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3267: <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  3268:       packages whose installed versions do not match the latest pkgsrc
                   3269:       entries.</p></li>
1.23      wiz      3270: <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  3271:       dependency graphs of packages, to aid in choosing a strategy for
                   3272:       updating.</p></li>
1.23      wiz      3273: <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  3274:       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      3275: <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   3276:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23      wiz      3277: <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  3278:       does various checks on the complete pkgsrc system.</p></li>
1.23      wiz      3279: <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  3280:       packages you have installed.</p></li>
                   3281: </ul></div>
                   3282: <p>Utilities for people maintaining or creating individual packages:</p>
1.23      wiz      3283: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3284: <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  3285:       making and maintaining patches for a package (includes pkgdiff,
                   3286:       pkgvi, mkpatches, etc.).</p></li>
1.23      wiz      3287: <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  3288:       <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
                   3289:       converting to pkgsrc.</p></li>
1.23      wiz      3290: <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  3291:       pkgsrc to a Solaris package.</p></li>
                   3292: </ul></div>
                   3293: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3294: utilities)</p>
1.23      wiz      3295: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3296: <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  3297:       packages in a chrooted area.</p></li>
1.23      wiz      3298: <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  3299:       kernel version for chrooted cross builds.</p></li>
                   3300: </ul></div>
                   3301: </div>
1.23      wiz      3302: <div class="sect1" title="9.4. How to use pkgsrc as non-root">
1.1       dsieger  3303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3304: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3305: <p>If you want to use pkgsrc as non-root user, you can set some
                   3306: variables to make pkgsrc work under these conditions.  At the very least,
1.23      wiz      3307: 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  3308: will turn on unprivileged mode and set multiple related variables to allow
                   3309: installation of packages as non-root.</p>
                   3310: <p>In case the defaults are not enough, you may want to tune some other
                   3311: variables used.  For example, if the automatic user/group detection leads
                   3312: to incorrect values (or not the ones you would like to use), you can change
                   3313: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3314: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3315: <p>As regards bootstrapping, please note that the
1.10      hubertf  3316: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23      wiz      3317: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.1       dsieger  3318: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3319: installation targets.  These directories can be overridden by the
1.23      wiz      3320: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.1       dsieger  3321: that allow finer tuning of the tree layout.</p>
                   3322: </div>
1.23      wiz      3323: <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
1.1       dsieger  3324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3325: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3326: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3327: enable this feature by adding the option
                   3328: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  3329: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3330: distfile is found, pkgsrc will try to resume it.</p>
                   3331: <p>You can also
1.29      dholland 3332: 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  3333: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3334: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3335: by using the value manual.  A value of custom disables the system defaults
                   3336: and dependency tracking for the fetch program.  In that case you have to
                   3337: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3338: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3339: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  3340: <p>For example, if you want to use
1.16      jnemeth  3341: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  3342: like:</p>
                   3343: <pre class="programlisting">
1.16      jnemeth  3344: FETCH_USING=   wget
1.1       dsieger  3345: </pre>
                   3346: </div>
1.23      wiz      3347: <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
1.1       dsieger  3348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3349: <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   3350: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3351: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3352: you will have to add the following line into
1.10      hubertf  3353: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3354: <pre class="programlisting">
1.4       rillig   3355: X11_TYPE=modular
1.1       dsieger  3356: </pre>
1.23      wiz      3357: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  3358: <h3 class="title">Note</h3>
1.4       rillig   3359: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3360: </p>
1.1       dsieger  3361: </div>
                   3362: </div>
1.23      wiz      3363: <div class="sect1" title="9.7. How to fetch files from behind a firewall">
1.1       dsieger  3364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3365: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3366: <p>If you are sitting behind a firewall which does not allow direct
                   3367: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3368: relevant proxy hosts.  This is done using an environment variable in the
                   3369: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      3370: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  3371: port 80 as the proxy port number.  So the proxy environment variables
                   3372: are:</p>
                   3373: <pre class="programlisting">
                   3374: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3375: http_proxy=http://orpheus.amdahl.com:80/
                   3376: </pre>
                   3377: </div>
1.23      wiz      3378: <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
1.1       dsieger  3379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  3380: <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  3381: <p>This depends on which utility is used to retrieve distfiles.  From
                   3382: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3383: the first available command from the following list:</p>
1.23      wiz      3384: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3385: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3386: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  3387: </ul></div>
                   3388: <p>On a default NetBSD installation, this will be
                   3389: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3390: connections first, and falls back to active connections if the server
                   3391: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  3392: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3393: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3394: <p>Having that option present will prevent
                   3395: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3396: transfers.</p>
                   3397: </div>
1.23      wiz      3398: <div class="sect1" title="9.9. How to fetch all distfiles at once">
1.1       dsieger  3399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3400: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3401: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  3402: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      3403: 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  3404: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  3405: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  3406: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3407: resulting list to your machine at work/school and use it there.  If you
1.29      dholland 3408: 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  3409: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3410: URL:</p>
                   3411: <p>At home:</p>
                   3412: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3413: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3414: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3415: <p>At work:</p>
                   3416: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3417: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3418: home.</p>
                   3419: <p>If you have a machine running NetBSD, and you want to get
                   3420: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3421: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  3422: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  3423: directly by running:</p>
                   3424: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3425: <p>If you even decide to ignore
                   3426: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3427: by running:</p>
                   3428: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3429: </div>
1.23      wiz      3430: <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  3431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3432: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                   3433: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3434: <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>
                   3435: package, you get the error from make that it doesn't know how to make
                   3436: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      3437: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  3438: the NetBSD base distribution on your machine.  It is recommended to do
                   3439: that to format man pages.</p>
                   3440: <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
                   3441: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  3442: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3443: </div>
1.23      wiz      3444: <div class="sect1" title="9.11. What does &#8220;Could not find bsd.own.mk&#8221; mean?">
1.1       dsieger  3445: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3446: <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  3447: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3448: when you installed your NetBSD machine.  Please get and install it, by
                   3449: extracting it in <code class="filename">/</code>:</p>
                   3450: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3451: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3452: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  3453: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  3454: -r</strong></span>).</p>
                   3455: </div>
1.23      wiz      3456: <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
1.1       dsieger  3457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3458: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3459: <p>When installing packages as non-root user and using the just-in-time
1.29      dholland 3460: <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  3461: password for each required package installed.  To avoid this, the sudo
                   3462: package can be used, which does password caching over a limited time.  To
                   3463: use it, install sudo (either as binary package or from
                   3464: <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  3465: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3466: <span class="emphasis"><em>after</em></span> the definition of the
                   3467: <code class="varname">LOCALBASE</code> variable:</p>
                   3468: <pre class="programlisting">
                   3469: .if exists(${LOCALBASE}/bin/sudo)
                   3470: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3471: .endif
                   3472: </pre>
                   3473: </div>
1.23      wiz      3474: <div class="sect1" title="9.13. How do I change the location of configuration files?">
1.1       dsieger  3475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3476: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3477: <p>As the system administrator, you can choose where configuration files
                   3478: are installed.  The default settings make all these files go into
                   3479: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3480: be suboptimal depending on your expectations (e.g., a read-only,
                   3481: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3482: configuration of the provided packages).</p>
                   3483: <p>In order to change the defaults, you can modify the
                   3484: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3485: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3486: directory; some common examples include <code class="filename">/etc</code> or
                   3487: <code class="filename">/etc/pkg</code>.</p>
                   3488: <p>Furthermore, you can change this value on a per-package basis by
                   3489: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3490: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3491: package you would like to modify, that is, the contents of
                   3492: <code class="varname">PKGBASE</code>.</p>
                   3493: <p>Note that after changing these settings, you must rebuild and
                   3494: reinstall any affected packages.</p>
                   3495: </div>
1.23      wiz      3496: <div class="sect1" title="9.14. Automated security checks">
1.1       dsieger  3497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3498: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3499: <p>Please be aware that there can often be bugs in third-party software,
                   3500: and some of these bugs can leave a machine vulnerable to exploitation by
                   3501: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3502: maintains a database of known-exploits to packages which have at one time
                   3503: been included in pkgsrc.  The database can be downloaded automatically, and
                   3504: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3505: do this, refer to the following two tools (installed as part of the
                   3506: <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      3507: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3508: <li class="listitem">
1.20      snj      3509: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3510:     download a list of the security vulnerabilities information.  This list
1.25      spz      3511:     is kept up to date by the pkgsrc security team, and is distributed
                   3512:     from the NetBSD ftp server:</p>
                   3513: <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  3514: </li>
1.23      wiz      3515: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3516:     current machine, checking each known vulnerability.  If a
1.1       dsieger  3517:     vulnerable package is installed, it will be shown by output to stdout,
                   3518:     including a description of the type of vulnerability, and a URL
                   3519:     containing more information.</p></li>
                   3520: </ol></div>
1.14      jmcneill 3521: <p>Use of these tools is strongly recommended!  After
1.23      wiz      3522: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.1       dsieger  3523: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14      jmcneill 3524: pkg_install</code></strong>.</p>
1.1       dsieger  3525: <p>If this package is installed, pkgsrc builds will use it to
1.10      hubertf  3526: 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  3527: check.</p>
                   3528: </div>
1.23      wiz      3529: <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
1.1       dsieger  3530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3531: <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  3532: <p>When you add your own preferences to the
                   3533:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3534:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3535:        environment variables to the <code class="filename">./configure</code>
1.29      dholland 3536:        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  3537:        <code class="varname">CFLAGS</code> from the environment variable by
                   3538:        overriding them in the <code class="filename">Makefile</code>s of their
                   3539:        package.</p>
                   3540: <p>Currently there is no solution to this problem. If you
                   3541:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3542:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3543:        directory and then inspect any <code class="filename">Makefile</code> and
                   3544:        <code class="filename">Makefile.in</code> for whether they define
                   3545:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3546:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  3547:        programmers write so bad code that it only works for the
                   3548:        specific combination of <code class="varname">CFLAGS</code> they have
                   3549:        chosen.</p>
                   3550: </div>
1.23      wiz      3551: <div class="sect1" title="9.16. A package does not build. What shall I do?">
1.1       dsieger  3552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3553: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3554: <div class="procedure"><ol class="procedure" type="1">
                   3555: <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  3556:        case that occurs often is that people only update pkgsrc in
                   3557:        parts, because of performance reasons. Since pkgsrc is one large
                   3558:        system, not a collection of many small systems, there are
                   3559:        sometimes changes that only work when the whole pkgsrc tree is
                   3560:        updated.</p></li>
1.23      wiz      3561: <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
                   3562:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3563:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  3564:        files.</p></li>
1.23      wiz      3565: <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3566:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3567:        verify this.</p></li>
1.23      wiz      3568: <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
1.1       dsieger  3569:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3570: </ol></div>
                   3571: </div>
1.23      wiz      3572: <div class="sect1" title="9.17. What does &#8220;Makefile appears to contain unresolved cvs/rcs/??? merge conflicts&#8221; mean?">
1.1       dsieger  3573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3574: <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  3575: <p>You have modified a file from pkgsrc, and someone else has
                   3576: modified that same file afterwards in the CVS repository. Both changes
                   3577: are in the same region of the file, so when you updated pkgsrc, the
                   3578: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3579: file. Because of these markers, the file is no longer a valid
                   3580: <code class="filename">Makefile</code>.</p>
                   3581: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3582: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3583: -dP</strong></span> in that directory to download the current version.</p>
                   3584: </div>
                   3585: </div>
                   3586: </div>
1.23      wiz      3587: <div class="part" title="Part II. The pkgsrc developer's guide">
1.1       dsieger  3588: <div class="titlepage"><div><div><h1 class="title">
                   3589: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.23      wiz      3590: <div class="partintro" title="The pkgsrc developer's guide">
1.1       dsieger  3591: <div></div>
                   3592: <p>This part of the book deals with creating and
1.23      wiz      3593:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3594:        guide on creating a new package. The remaining chapters are more
                   3595:        like a reference manual for pkgsrc.</p>
                   3596: <div class="toc">
                   3597: <p><b>Table of Contents</b></p>
                   3598: <dl>
1.6       rillig   3599: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3600: <dd><dl>
1.6       rillig   3601: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3602: <dd><dl>
1.6       rillig   3603: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3604: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3605: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3606: </dl></dd>
1.6       rillig   3607: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3608: <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>
                   3609: </dl></dd>
                   3610: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3611: <dd><dl>
1.23      wiz      3612: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3613: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   3614: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3615: <dd><dl>
                   3616: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3617: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3618: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3619: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3620: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3621: </dl></dd>
                   3622: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3623: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3624: <dd><dl>
                   3625: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3626: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3627: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3628: </dl></dd>
1.23      wiz      3629: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3630: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   3631: </dl></dd>
1.23      wiz      3632: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3633: <dd><dl>
                   3634: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      3635: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   3636: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3637: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3638: <dd><dl>
                   3639: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3640: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3641: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3642: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3643: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3644: </dl></dd>
                   3645: </dl></dd>
                   3646: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3647: <dd><dl>
                   3648: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      3649: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3650: <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   3651: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3652: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      3653: <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   3654: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3655: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3656: </dl></dd>
                   3657: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3658: <dd><dl>
                   3659: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      3660: <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   3661: <dd><dl>
                   3662: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      3663: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3664:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3665:       and
                   3666:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3667:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3668: </dl></dd>
1.23      wiz      3669: <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   3670: <dd><dl>
1.23      wiz      3671: <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   3672: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3673: </dl></dd>
                   3674: </dl></dd>
                   3675: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3676: <dd><dl>
                   3677: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3678: <dd><dl>
                   3679: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3680: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3681: </dl></dd>
                   3682: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3683: <dd><dl>
1.23      wiz      3684: <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   3685: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3686: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3687: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3688: </dl></dd>
                   3689: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3690: <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>
                   3691: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3692: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3693: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3694: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3695: <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>
                   3696: </dl></dd>
                   3697: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3698: <dd><dl>
                   3699: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      3700: <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   3701: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3702: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3703: </dl></dd>
                   3704: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3705: <dd><dl>
                   3706: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3707: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3708: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3709: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      3710: <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   3711: <dd><dl>
                   3712: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3713: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3714: </dl></dd>
1.23      wiz      3715: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3716: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3717: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3718: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3719: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3720: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3721: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3722: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3723: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3724: <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   3725: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3726: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3727: </dl></dd>
                   3728: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3729: <dd><dl>
                   3730: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3731: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3732: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3733: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3734: </dl></dd>
                   3735: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3736: <dd><dl>
                   3737: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3738: <dd><dl>
                   3739: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      3740: <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   3741: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3742: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3744: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3745: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3746: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3747: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3748: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3749: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3750: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3751: </dl></dd>
1.23      wiz      3752: <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   3753: <dd><dl>
                   3754: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3755: <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>
                   3756: </dl></dd>
1.23      wiz      3757: <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   3758: <dd><dl>
                   3759: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3762: </dl></dd>
                   3763: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3764: <dd><dl>
                   3765: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3767: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3768: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3769: </dl></dd>
1.23      wiz      3770: <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   3771: <dd><dl>
                   3772: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3773: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      3774: <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   3775: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3776: </dl></dd>
1.23      wiz      3777: <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   3778: <dd><dl>
                   3779: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3780: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3781: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3782: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3783: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3784: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3785: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3786: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3787: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      3788: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   3789: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3790: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3791: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3792: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3793: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3794: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3795: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3796: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3797:     emulation</a></span></dt>
1.6       rillig   3798: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3799: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3800: </dl></dd>
1.6       rillig   3801: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3802: </dl></dd>
1.6       rillig   3803: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3804: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3805: <dd><dl>
1.6       rillig   3806: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3807: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3808: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3809: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3810: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      3811: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3812: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig   3813: </dl></dd>
                   3814: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3815: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3816: <dd><dl>
                   3817: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3818: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3819: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3820: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3821: </dl></dd>
                   3822: </dl>
                   3823: </div>
                   3824: </div>
1.23      wiz      3825: <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
1.1       dsieger  3826: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3827: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3828: <div class="toc">
                   3829: <p><b>Table of Contents</b></p>
                   3830: <dl>
1.6       rillig   3831: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3832: <dd><dl>
1.6       rillig   3833: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3834: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3835: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3836: </dl></dd>
1.6       rillig   3837: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3838: <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  3839: </dl>
                   3840: </div>
                   3841: <p>When you find a package that is not yet in pkgsrc, you
                   3842: most likely have a URL from where you can download the source
                   3843: code. Starting with this URL, creating a package involves only a
                   3844: few steps.</p>
1.23      wiz      3845: <div class="procedure"><ol class="procedure" type="1">
                   3846: <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>
                   3847: <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3848: category in which you want to place your package. You can also create a
                   3849: directory of your own (maybe called <code class="filename">local</code>). In that
                   3850: category directory, create another directory for your package and change
                   3851: into it.</p></li>
1.23      wiz      3852: <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3853: you for a URL. Enter the URL of the distribution file (in most cases a
                   3854: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3855: of your package are created automatically. The distribution file is
                   3856: extracted automatically to fill in some details in the
                   3857: <code class="filename">Makefile</code> that would otherwise have to be done
                   3858: manually.</p></li>
1.23      wiz      3859: <li class="step" title="Step 4">
1.1       dsieger  3860: <p>Examine the extracted files to determine the dependencies of
                   3861: your package. Ideally, this is mentioned in some
                   3862: <code class="filename">README</code> file, but things may differ. For each of
                   3863: these dependencies, look where it exists in pkgsrc, and if there is a
                   3864: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3865: line to your package <code class="filename">Makefile</code> which includes that
                   3866: file just before the last line. If the
1.25      spz      3867: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3868: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3869: <p>If you just need binaries from a package, add a
1.1       dsieger  3870: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3871: version of the dependency and where it can be found in pkgsrc. This line
                   3872: should be placed in the third paragraph. If the dependency is only
                   3873: needed for building the package, but not when using it, use
                   3874: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3875: Your package may then look like this:</p>
                   3876: <pre class="programlisting">
                   3877: [...]
                   3878: 
                   3879: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3880: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3881: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3882: 
                   3883: [...]
                   3884: 
                   3885: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3886: .include "../../devel/glib2/buildlink3.mk"
                   3887: .include "../../mk/bsd.pkg.mk"
                   3888: </pre>
                   3889: </li>
1.23      wiz      3890: <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   3891: 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  3892: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3893: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3894: -e</strong></span>, which outputs additional
                   3895: explanations.</p></li>
1.23      wiz      3896: <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3897: 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  3898: over there, you can hopefully continue here.</p></li>
1.23      wiz      3899: <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3900: directory from the extracted files. Besides these files, a lot of cache
                   3901: files and other system information has been saved in the working
                   3902: directory, which may become wrong after you edited the
                   3903: <code class="filename">Makefile</code>.</p></li>
1.23      wiz      3904: <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10      hubertf  3905: 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      3906: <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
1.10      hubertf  3907: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3908: everything works.</p></li>
1.23      wiz      3909: <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3910: contains a list of the files that are installed by the package, is
1.10      hubertf  3911: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3912: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3913: the file using your preferred text editor to see if the list of
                   3914: files looks plausible.</p></li>
1.23      wiz      3915: <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3916: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.23      wiz      3917: <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3918: has been registered in the database of installed files, but with an
1.10      hubertf  3919: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3920: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3921: registered with the list of files from
                   3922: <code class="filename">PLIST</code>.</p></li>
1.23      wiz      3923: <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3924: package from the set of installed files.</p></li>
                   3925: </ol></div>
1.23      wiz      3926: <div class="sect1" title="10.1. Common types of packages">
1.1       dsieger  3927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3928: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.23      wiz      3929: <div class="sect2" title="10.1.1. Perl modules">
1.1       dsieger  3930: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3931: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3932: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3933: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3934: </div>
1.23      wiz      3935: <div class="sect2" title="10.1.2. KDE applications">
1.1       dsieger  3936: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3937: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  3938: <p>KDE applications should always include
                   3939: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3940: settings that are typical of KDE packages.</p>
                   3941: </div>
1.23      wiz      3942: <div class="sect2" title="10.1.3. Python modules and programs">
1.17      imil     3943: <div class="titlepage"><div><div><h3 class="title">
                   3944: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3945: <p>Python modules and programs packages are easily created using a
                   3946: set of predefined variables.</p>
1.23      wiz      3947: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3948: easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3949: If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
                   3950: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
1.17      imil     3951: pkgsrc will make use of this framework.
1.23      wiz      3952: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3953: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
1.17      imil     3954: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3955: to the name of the script.</p>
                   3956: <p>
                   3957: If the default Python versions are not supported by the software, set the
                   3958: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   3959: the software is known to work with, from the most recent to the older
                   3960: one, e.g.
                   3961: </p>
                   3962: <pre class="programlisting">
1.22      jakllsch 3963: PYTHON_VERSIONS_ACCEPTED=       25 24
1.17      imil     3964: </pre>
                   3965: <p>
                   3966: If the packaged software is a Python module, include
1.23      wiz      3967: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
1.17      imil     3968: In this case, the package directory should be called
1.23      wiz      3969: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3970: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3971: </p>
                   3972: <pre class="programlisting">
                   3973: DISTNAME=   foopymodule-1.2.10
                   3974: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3975: </pre>
                   3976: <p>If it is an application, also include
1.23      wiz      3977: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
                   3978: before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
1.17      imil     3979: <p>If the packaged software, either it is an application or a module, is
                   3980: egg-aware, you only need to include
1.23      wiz      3981: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
1.17      imil     3982: <p>In order to correctly set the path to the Python interpreter, use the
                   3983: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   3984: that must be corrected. For example :
                   3985: </p>
                   3986: <pre class="programlisting">
                   3987: REPLACE_PYTHON=   ${WRKSRC}/*.py
                   3988: </pre>
                   3989: </div>
1.1       dsieger  3990: </div>
1.23      wiz      3991: <div class="sect1" title="10.2. Examples">
1.1       dsieger  3992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3993: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.23      wiz      3994: <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
1.1       dsieger  3995: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3996: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.23      wiz      3997: <div class="sect3" title="10.2.1.1. The initial package">
1.1       dsieger  3998: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3999: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  4000: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      4001: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  4002: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      4003: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  4004: <pre class="programlisting">
                   4005: <code class="prompt">$</code> mkdir www/nvu
                   4006: <code class="prompt">$</code> cd www/nvu
                   4007: </pre>
                   4008: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  4009: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  4010: <pre class="programlisting">
                   4011: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4012: </pre>
                   4013: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4014: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      4015: 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  4016: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4017: <code class="varname">COMMENT</code> fields. Then the package
                   4018: <code class="filename">Makefile</code> looked like that:</p>
                   4019: <pre class="programlisting">
                   4020: # $NetBSD$
                   4021: #
                   4022: 
                   4023: DISTNAME=       nvu-1.0-sources
                   4024: PKGNAME=        nvu-1.0
                   4025: CATEGORIES=     www
                   4026: MASTER_SITES=   http://cvs.nvu.com/download/
                   4027: EXTRACT_SUFX=   .tar.bz2
                   4028: 
                   4029: MAINTAINER=     rillig@NetBSD.org
                   4030: HOMEPAGE=       http://cvs.nvu.com/
                   4031: COMMENT=        Web Authoring System
                   4032: 
                   4033: # url2pkg-marker (please do not remove this line.)
                   4034: .include "../../mk/bsd.pkg.mk"
                   4035: </pre>
                   4036: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4037: source archive:</p>
                   4038: <pre class="programlisting">
                   4039: url2pkg&gt; Running "make makesum" ...
                   4040: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4041: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4042: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4043: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4044: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4045: url2pkg&gt; Running "make extract" ...
                   4046: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4047: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4048: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4049: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4050: ===&gt; Installing dependencies for nvu-1.0
                   4051: ===&gt; Overriding tools for nvu-1.0
                   4052: ===&gt; Extracting for nvu-1.0
                   4053: url2pkg&gt; Adjusting the Makefile.
                   4054: 
                   4055: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4056: 
                   4057: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4058: </pre>
                   4059: </div>
1.23      wiz      4060: <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
1.1       dsieger  4061: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4062: <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  4063: <p>Now that the package has been extracted, let's see what's inside
                   4064: it. The package has a <code class="filename">README.txt</code>, but that only
                   4065: says something about mozilla, so it's probably useless for seeing what
                   4066: dependencies this package has. But since there is a GNU configure script
                   4067: in the package, let's hope that it will complain about everything it
                   4068: needs.</p>
                   4069: <pre class="programlisting">
                   4070: <code class="prompt">$</code> bmake
                   4071: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4072: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4073: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4074: ===&gt; Patching for nvu-1.0
                   4075: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4076: ===&gt; Configuring for nvu-1.0
                   4077: [...]
                   4078: configure: error: Perl 5.004 or higher is required.
                   4079: [...]
                   4080: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4081: [...]
                   4082: </pre>
                   4083: <p>That worked quite well. So I opened the package Makefile in my
                   4084: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      4085: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  4086: package have changed now, and since a perl wrapper is automatically
1.23      wiz      4087: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  4088: from scratch.</p>
                   4089: <pre class="programlisting">
                   4090: <code class="prompt">$</code> bmake clean
                   4091: ===&gt; Cleaning for nvu-1.0
                   4092: <code class="prompt">$</code> bmake
                   4093: [...]
                   4094: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4095: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4096: [...]
                   4097: </pre>
1.23      wiz      4098: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  4099: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4100: <pre class="programlisting">
                   4101: [...]
                   4102: checking for GTK - version &gt;= 1.2.0... no
                   4103: *** Could not run GTK test program, checking why...
                   4104: [...]
                   4105: </pre>
                   4106: <p>Now to the other dependencies. The first question is: Where is the
                   4107: GTK package hidden in pkgsrc?</p>
                   4108: <pre class="programlisting">
                   4109: <code class="prompt">$</code> echo ../../*/gtk*
                   4110: [many packages ...]
                   4111: <code class="prompt">$</code> echo ../../*/gtk
                   4112: ../../x11/gtk
                   4113: <code class="prompt">$</code> echo ../../*/gtk2
                   4114: ../../x11/gtk2
                   4115: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4116: ../../x11/gtk2/buildlink3.mk
                   4117: </pre>
                   4118: <p>The first try was definitely too broad. The second one had exactly
                   4119: one result, which is very good. But there is one pitfall with GNOME
                   4120: packages. Before GNOME 2 had been released, there were already many
                   4121: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4122: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      4123: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  4124: whether this was the case here, and indeed it was.</p>
                   4125: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4126: file, adding the dependency is very easy. I just inserted an
                   4127: <code class="literal">.include</code> line before the last line of the package
                   4128: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4129: <pre class="programlisting">
                   4130: [...]
                   4131: .include "../../x11/gtk2/buildlink3.mk"
                   4132: .include "../../mk/bsd.pkg.mk
                   4133: </pre>
1.10      hubertf  4134: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  4135: was:</p>
                   4136: <pre class="programlisting">
                   4137: [...]
                   4138: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4139: checking for GTK - version &gt;= 1.2.0... no
                   4140: *** Could not run GTK test program, checking why...
                   4141: *** The test program failed to compile or link. See the file config.log for the
                   4142: *** exact error that occured. This usually means GTK was incorrectly installed
                   4143: *** or that you have moved GTK since it was installed. In the latter case, you
                   4144: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4145: configure: error: Test for GTK failed.
                   4146: [...]
                   4147: </pre>
1.23      wiz      4148: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   4149: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  4150: told me that this package really wanted to have the GNOME 1 version of
                   4151: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  4152: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  4153: So I changed the <code class="literal">x11/gtk2</code> to
                   4154: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4155: and tried again.</p>
                   4156: <pre class="programlisting">
                   4157: [...]
                   4158: 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
                   4159: In file included from xpidl.c:42:
                   4160: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4161: In file included from xpidl.c:42:
                   4162: xpidl.h:132: error: parse error before "IDL_ns"
                   4163: [...]
                   4164: </pre>
                   4165: <p>The package still does not find all of its dependencies. Now the
                   4166: question is: Which package provides the
                   4167: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4168: <pre class="programlisting">
                   4169: <code class="prompt">$</code> echo ../../*/*idl*
                   4170: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4171: <code class="prompt">$</code> echo ../../*/*IDL*
                   4172: ../../net/libIDL
                   4173: </pre>
                   4174: <p>Let's take the one from the second try. So I included the
                   4175: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4176: again. But the error didn't change. After digging through some of the
                   4177: code, I concluded that the build process of the package was broken and
                   4178: couldn't have ever worked, but since the Mozilla source tree is quite
                   4179: large, I didn't want to fix it. So I added the following to the package
                   4180: <code class="filename">Makefile</code> and tried again:</p>
                   4181: <pre class="programlisting">
                   4182: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4183: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4184: </pre>
                   4185: <p>The latter line is needed because the package expects the library
                   4186: <code class="filename">libIDL.so</code>, but only
                   4187: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4188: wrapper to rewrite that on the fly.</p>
                   4189: <p>The next problem was related to a recent change of the FreeType
                   4190: 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>
                   4191: which patch files were relevant for this issue and copied them to the
                   4192: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4193: patches so that they applied cleanly and retried again. This time,
                   4194: everything worked.</p>
                   4195: </div>
1.23      wiz      4196: <div class="sect3" title="10.2.1.3. Installing the package">
1.1       dsieger  4197: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4198: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4199: <pre class="programlisting">
                   4200: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4201: [...]
                   4202: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4203: <code class="prompt">$</code> bmake deinstall
                   4204: <code class="prompt">$</code> bmake install
                   4205: </pre>
                   4206: </div>
                   4207: </div>
                   4208: </div>
                   4209: </div>
1.23      wiz      4210: <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
1.1       dsieger  4211: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4212: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4213: <div class="toc">
                   4214: <p><b>Table of Contents</b></p>
                   4215: <dl>
1.23      wiz      4216: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4217: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   4218: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4219: <dd><dl>
                   4220: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4221: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4222: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4223: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4224: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4225: </dl></dd>
                   4226: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4227: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4228: <dd><dl>
                   4229: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4230: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4231: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4232: </dl></dd>
1.23      wiz      4233: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4234: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  4235: </dl>
                   4236: </div>
                   4237: <p>Whenever you're preparing a package, there are a number of
                   4238: files involved which are described in the following
                   4239: sections.</p>
1.23      wiz      4240: <div class="sect1" title="11.1. Makefile">
1.1       dsieger  4241: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4242: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4243: </h2></div></div></div>
                   4244: <p>Building, installation and creation of a binary package are all
                   4245:   controlled by the package's <code class="filename">Makefile</code>.
                   4246:   The <code class="filename">Makefile</code> describes various things about
                   4247:   a package, for example from where to get it, how to configure,
                   4248:   build, and install it.</p>
                   4249: <p>A package <code class="filename">Makefile</code> contains several
                   4250:   sections that describe the package.</p>
                   4251: <p>In the first section there are the following variables, which
                   4252:   should appear exactly in the order given here.  The order and
                   4253:   grouping of the variables is mostly historical and has no further
                   4254:   meaning.</p>
1.23      wiz      4255: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4256: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  4257:     distribution file to be downloaded from the package's
                   4258:     website.</p></li>
1.23      wiz      4259: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1       dsieger  4260:     package, as used by pkgsrc. You only need to provide it if
                   4261:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4262:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4263:     directory name together with the version number. It must match the
                   4264:     regular expression
                   4265:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4266:     starts with a letter or digit, and contains only letters, digits,
                   4267:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      4268: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1       dsieger  4269:     the package file to create if the <code class="varname">PKGNAME</code>
                   4270:     isn't unique on a SVR4 system. The default is
                   4271:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4272:     <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
                   4273:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4274:     does not produce an unique package name on a SVR4 system.
                   4275:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4276:     characters.</p></li>
1.23      wiz      4277: <li class="listitem">
1.1       dsieger  4278: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4279:     which the package fits in. You can choose any of the top-level
                   4280:     directories of pkgsrc for it.</p>
                   4281: <p>Currently the following values are available for
                   4282:     <code class="varname">CATEGORIES</code>. If more than
                   4283:     one is used, they need to be separated by spaces:</p>
                   4284: <pre class="programlisting">
                   4285: archivers     cross         geography     meta-pkgs     security
                   4286: audio         databases     graphics      misc          shells
                   4287: benchmarks    devel         ham           multimedia    sysutils
                   4288: biology       editors       inputmethod   net           textproc
                   4289: cad           emulators     lang          news          time
                   4290: chat          finance       mail          parallel      wm
                   4291: comms         fonts         math          pkgtools      www
                   4292: converters    games         mbone         print         x11
                   4293: </pre>
                   4294: </li>
1.23      wiz      4295: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  4296:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4297:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4298:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.23      wiz      4299:     <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  4300: </ul></div>
                   4301: <p>The second section contains information about separately
                   4302:   downloaded patches, if any.
                   4303:   </p>
1.23      wiz      4304: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4305: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1       dsieger  4306:     Name(s) of additional files that contain distribution patches.
                   4307:     There is no default. pkgsrc will look for them at
                   4308:     <code class="varname">PATCH_SITES</code>.
                   4309:     They will automatically be uncompressed before patching if
                   4310:     the names end with <code class="filename">.gz</code> or
                   4311:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      4312: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  4313:     Primary location(s) for distribution patch files (see
                   4314:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4315: </ul></div>
                   4316: <p>The third section contains the following variables.
                   4317:   </p>
1.23      wiz      4318: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4319: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 4320:     address of the person who feels responsible for this package,
                   4321:     and who is most likely to look at problems or questions regarding
1.29      dholland 4322:     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 4323:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4324:     before making changes to the package, but are not required to
                   4325:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4326:     to yourself. If you really can't maintain the package for future
                   4327:     updates, set it to
1.10      hubertf  4328:     <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      4329: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 4330:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4331:     developers to update or change the package without contacting
                   4332:     you first. A package Makefile should contain one of
                   4333:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4334:     not both.  </p></li>
1.23      wiz      4335: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  4336:     find more information about the package.</p></li>
1.23      wiz      4337: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  4338:     description of the package (should not include the package
                   4339:     name).</p></li>
                   4340: </ul></div>
                   4341: <p>Other variables that affect the build:
                   4342:   </p>
1.23      wiz      4343: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4344: <p><code class="varname">WRKSRC</code>: The directory where the
                   4345:       interesting distribution files of the package are found. The
                   4346:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4347:       works for most packages.</p>
                   4348: <p>If a package doesn't create a subdirectory for itself
                   4349:       (most GNU software does, for instance), but extracts itself in
                   4350:       the current directory, you should set
                   4351:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4352: <p>If a package doesn't create a subdirectory with the
                   4353:       name of <code class="varname">DISTNAME</code> but some different name,
                   4354:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4355:       <code class="filename">${WRKDIR}</code>, for example
                   4356:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4357:       <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>
                   4358: <p>The name of the working directory created by pkgsrc is
                   4359:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4360:       variable. By default, its value is
                   4361:       <code class="filename">work</code>. If you want to use the same
                   4362:       pkgsrc tree for building different kinds of binary packages,
                   4363:       you can change the variable according to your needs. Two
                   4364:       other variables handle common cases of setting
                   4365:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4366:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  4367:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4368:       the host's name is attached to the directory name. If
                   4369:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4370:       is attached, which might look like
                   4371:       <code class="filename">work.i386</code> or
                   4372:       <code class="filename">work.sparc</code>.</p>
                   4373: </li></ul></div>
                   4374: <p>Please pay attention to the following gotchas:</p>
1.23      wiz      4375: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4376: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  4377:       installed in compressed form by the package.  For packages using
                   4378:       BSD-style makefiles which honor MANZ, there is
                   4379:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      4380: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4381:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  4382:       below).</p></li>
1.23      wiz      4383: <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  4384: </ul></div>
                   4385: </div>
1.23      wiz      4386: <div class="sect1" title="11.2. distinfo">
1.1       dsieger  4387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4388: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4389: </h2></div></div></div>
                   4390: <p>The <code class="filename">distinfo</code> file contains the message
                   4391:   digest, or checksum, of each distfile needed for the package. This
                   4392:   ensures that the distfiles retrieved from the Internet have not been
                   4393:   corrupted during transfer or altered by a malign force to introduce
                   4394:   a security hole. Due to recent rumor about weaknesses of digest
                   4395:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4396:   message digests, as well as the file size.</p>
                   4397: <p>The <code class="filename">distinfo</code> file also contains the
                   4398:   checksums for all the patches found in the
1.10      hubertf  4399:   <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  4400: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10      hubertf  4401:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1       dsieger  4402:   command.</p>
                   4403: <p>Some packages have different sets of distfiles depending on
1.23      wiz      4404:   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  4405:   <code class="filename">distinfo</code> file and care should be taken when
                   4406:   upgrading such a package to ensure distfile information is not
                   4407:   lost.</p>
                   4408: </div>
1.23      wiz      4409: <div class="sect1" title="11.3. patches/*">
1.1       dsieger  4410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4411: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4412: <p>Many packages still don't work out-of-the box on the various
                   4413:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4414:   patch files are needed to make the package work. These patch files are
                   4415:   found in the <code class="filename">patches/</code> directory.</p>
                   4416: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4417:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.10      hubertf  4418:   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      4419:   order</a>.</p>
1.23      wiz      4420: <div class="sect2" title="11.3.1. Structure of a single patch file">
1.1       dsieger  4421: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4422: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4423: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  4424:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  4425:   problems. (To force patches to apply with fuzz you can set
                   4426:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4427:   should contain only changes for a single file, and no file should be
                   4428:   patched by more than one patch file. This helps to keep future
                   4429:   modifications simple.</p>
                   4430: <p>Each patch file is structured as follows: In the first line,
                   4431:   there is the RCS Id of the patch itself. The second line should be
                   4432:   empty for aesthetic reasons. After that, there should be a comment for
                   4433:   each change that the patch does. There are a number of standard
                   4434:   cases:</p>
1.23      wiz      4435: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4436: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  4437:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      4438: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  4439:   platform and other environment (for example, the compiler) that the
                   4440:   patch is needed for.</p></li>
                   4441: </ul></div>
1.24      wiz      4442: <p>In all, the patch should be commented so that any
1.1       dsieger  4443:   developer who knows the code of the application can make some use of
                   4444:   the patch. Special care should be taken for the upstream developers,
                   4445:   since we generally want that they accept our patches, so we have less
                   4446:   work in the future.</p>
                   4447: </div>
1.23      wiz      4448: <div class="sect2" title="11.3.2. Creating patch files">
1.1       dsieger  4449: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4450: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4451: <p>One important thing to mention is to pay attention that no RCS
                   4452:   IDs get stored in the patch files, as these will cause problems when
                   4453:   later checked into the NetBSD CVS tree. Use the
1.10      hubertf  4454:   <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  4455:   problems.</p>
                   4456: <p>For even more automation, we recommend using
1.10      hubertf  4457:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  4458:   whole set of patches. You just have to backup files before you
                   4459:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  4460:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4461:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  4462:   you upgrade a package this way, you can easily compare the new
                   4463:   set of patches with the previously existing one with
1.24      wiz      4464:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4465:   are replaced by new files, so carefully check if you want to take all
                   4466:   the changes.</p>
1.1       dsieger  4467: <p>When you have finished a package, remember to generate
1.10      hubertf  4468:   the checksums for the patch files by using the <span class="command"><strong>make
1.23      wiz      4469:   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  4470: <p>When adding a patch that corrects a problem in the
                   4471:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4472:   man pages should go), send the patch as a bug report to the
                   4473:   maintainer.  This benefits non-pkgsrc users of the package,
                   4474:   and usually makes it possible to remove the patch in future
                   4475:   version.</p>
1.2       rillig   4476: <p>The file names of the patch files are usually of the form
1.24      wiz      4477:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4478:   Many packages still use the previous convention
                   4479:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4480:   but new patches should be of the form containing the filename.
                   4481:   <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
                   4482:   automatically.</p>
1.1       dsieger  4483: </div>
1.23      wiz      4484: <div class="sect2" title="11.3.3. Sources where the patch files come from">
1.1       dsieger  4485: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4486: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4487: <p>If you want to share patches between multiple packages
                   4488:   in pkgsrc, e.g. because they use the same distfiles, set
                   4489:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4490:   can be found, e.g.:</p>
                   4491: <pre class="programlisting">
                   4492: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4493: </pre>
                   4494: <p>Patch files that are distributed by the author or other
                   4495:     maintainers can be listed in
                   4496:     <code class="varname">PATCHFILES</code>.</p>
                   4497: <p>If it is desired to store any patches that should not be
                   4498:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4499:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4500:     directory tree there is expected to have the same
1.23      wiz      4501:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  4502:     patches are expected to be stored inside these dirs (also
                   4503:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4504:     example, if you want to keep a private patch for
                   4505:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4506:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4507:     files in the named directory are expected to be patch files,
                   4508:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4509:     applied</em></span>.</p>
                   4510: </div>
1.23      wiz      4511: <div class="sect2" title="11.3.4. Patching guidelines">
1.1       dsieger  4512: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4513: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4514: <p>When fixing a portability issue in the code do not use
                   4515:       preprocessor magic to check for the current operating system nor
                   4516:       platform.  Doing so hurts portability to other platforms because
                   4517:       the OS-specific details are not abstracted appropriately.</p>
                   4518: <p>The general rule to follow is: instead of checking for the
                   4519:       operating system the application is being built on, check for the
                   4520:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4521:       instead of assuming that kqueue is available under NetBSD and
                   4522:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 4523:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4524:       yes, this generally involves patching the
1.10      hubertf  4525:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  4526:       that prevents some OSes from adopting interfaces from other OSes
                   4527:       (e.g. Linux implementing kqueue), something that the above checks
                   4528:       cannot take into account.</p>
                   4529: <p>Of course, checking for features generally involves more
                   4530:       work on the developer's side, but the resulting changes are
                   4531:       cleaner and there are chances they will work on many other
                   4532:       platforms.  Not to mention that there are higher chances of being
                   4533:       later integrated into the mainstream sources.  Remember:
                   4534:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4535: <p>Some typical examples:</p>
                   4536: <div class="table">
1.6       rillig   4537: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4538: <div class="table-contents"><table summary="Patching examples" border="1">
                   4539: <colgroup>
                   4540: <col>
                   4541: <col>
                   4542: <col>
                   4543: </colgroup>
                   4544: <thead><tr>
                   4545: <th>Where</th>
                   4546: <th>Incorrect</th>
                   4547: <th>Correct</th>
                   4548: </tr></thead>
                   4549: <tbody>
                   4550: <tr>
                   4551: <td>configure script</td>
                   4552: <td>
                   4553: <pre class="programlisting">
                   4554: case ${target_os} in
                   4555: netbsd*) have_kvm=yes ;;
                   4556: *)       have_kvm=no  ;;
                   4557: esac
                   4558: </pre>
                   4559:              </td>
                   4560: <td>
                   4561: <pre class="programlisting">
                   4562: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4563: </pre>
                   4564:              </td>
                   4565: </tr>
                   4566: <tr>
                   4567: <td>C source file</td>
                   4568: <td>
                   4569: <pre class="programlisting">
                   4570: #if defined(__NetBSD__)
                   4571: #  include &lt;sys/event.h&gt;
                   4572: #endif
                   4573: </pre>
                   4574:              </td>
                   4575: <td>
                   4576: <pre class="programlisting">
                   4577: #if defined(HAVE_SYS_EVENT_H)
                   4578: #  include &lt;sys/event.h&gt;
                   4579: #endif
                   4580: </pre>
                   4581:              </td>
                   4582: </tr>
                   4583: <tr>
                   4584: <td>C source file</td>
                   4585: <td>
                   4586: <pre class="programlisting">
                   4587: int
                   4588: monitor_file(...)
                   4589: {
                   4590: #if defined(__NetBSD__)
                   4591:         int fd = kqueue();
                   4592:         ...
                   4593: #else
                   4594:         ...
                   4595: #endif
                   4596: }
                   4597: </pre>
                   4598:              </td>
                   4599: <td>
                   4600: <pre class="programlisting">
                   4601: int
                   4602: monitor_file(...)
                   4603: {
                   4604: #if defined(HAVE_KQUEUE)
                   4605:         int fd = kqueue();
                   4606:         ...
                   4607: #else
                   4608:        ...
                   4609: #endif
                   4610: }
                   4611: </pre>
                   4612:              </td>
                   4613: </tr>
                   4614: </tbody>
                   4615: </table></div>
                   4616: </div>
                   4617: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  4618:       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
                   4619:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  4620:       2</a>).  It summarizes multiple details on how to make
                   4621:       software easier to package; all the suggestions in it were
                   4622:       collected from our experience in pkgsrc work, so they are possibly
                   4623:       helpful when creating patches too.</p>
                   4624: </div>
1.23      wiz      4625: <div class="sect2" title="11.3.5. Feedback to the author">
1.1       dsieger  4626: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4627: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4628: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4629:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4630:       improvements you do to a package to the mainstream developers.
                   4631:       This is the only way to get their attention on portability issues
                   4632:       and to ensure that future versions can be built out-of-the box on
                   4633:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4634:       the fixes straight from the packaged code.</p>
                   4635: <p>This generally involves cleaning up the patches
                   4636:       (because sometimes the patches that are
                   4637:       added to pkgsrc are quick hacks), filling bug reports in the
                   4638:       appropriate trackers for the projects and working with the
                   4639:       mainstream authors to accept your changes.  It is
                   4640:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4641:       the packages in pkgsrc are kept simple and thus further changes
                   4642:       can be done without much hassle.</p>
1.24      wiz      4643: <p>When you have done this, please add a URL to the upstream
                   4644:       bug report to the patch comment.</p>
1.1       dsieger  4645: <p>Support the idea of free software!</p>
                   4646: </div>
                   4647: </div>
1.23      wiz      4648: <div class="sect1" title="11.4. Other mandatory files">
1.1       dsieger  4649: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4650: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1       dsieger  4651: <div class="variablelist"><dl>
                   4652: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4653: <dd><p>A multi-line description of the piece of software.  This should include
                   4654:          any credits where they are due.  Please bear in mind that others do not
                   4655:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4656:          will read everything that you write here.</p></dd>
                   4657: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4658: <dd><p>This file governs the files that are installed on your
                   4659:          system: all the binaries, manual pages, etc. There are other
                   4660:          directives which may be entered in this file, to control the
                   4661:          creation and deletion of directories, and the location of
1.10      hubertf  4662:          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  4663:          information.</p></dd>
                   4664: </dl></div>
                   4665: </div>
1.23      wiz      4666: <div class="sect1" title="11.5. Optional files">
1.1       dsieger  4667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4668: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.23      wiz      4669: <div class="sect2" title="11.5.1. Files affecting the binary package">
1.1       dsieger  4670: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4671: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1       dsieger  4672: <div class="variablelist"><dl>
                   4673: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      4674: <dd>
1.29      dholland 4675: <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  4676:            First time after package extraction and before files are
                   4677:            moved in place, the second time after the files to install
                   4678:            are moved in place. This can be used to do any custom
                   4679:            procedures not possible with @exec commands in
1.29      dholland 4680:            <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
                   4681:            <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      4682:            Please note that you can modify variables in it easily by using
                   4683:            <code class="varname">FILES_SUBST</code> in the package's
                   4684:            <code class="filename">Makefile</code>:</p>
                   4685: <pre class="programlisting">
                   4686: FILES_SUBST+=  SOMEVAR="somevalue"
                   4687: </pre>
                   4688: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4689:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4690:            performed for <code class="varname">PREFIX</code>,
                   4691:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4692:            <code class="varname">VARBASE</code>, and a few others, type
                   4693:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4694:            complete list.</p>
                   4695: </dd>
1.1       dsieger  4696: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4697: <dd><p>This script is executed before and after any files are removed.  It is
                   4698:            this script's responsibility to clean up any additional messy details
                   4699:            around the package's installation, since all pkg_delete knows is how to
                   4700:            delete the files created in the original distribution.
1.29      dholland 4701:            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>
                   4702:            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      4703:            The same methods to replace variables can be used as for
                   4704:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4705: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4706: <dd>
                   4707: <p>This file is displayed after installation of the package.
                   4708:            Useful for things like legal notices on almost-free
                   4709:            software and hints for updating config files after
                   4710:            installing modules for apache, PHP etc.
                   4711:            Please note that you can modify variables in it easily by using
                   4712:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4713:            <code class="filename">Makefile</code>:</p>
                   4714: <pre class="programlisting">
                   4715: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4716: </pre>
1.23      wiz      4717: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4718:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4719:            performed for <code class="varname">PKGNAME</code>,
                   4720:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4721:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4722:            <code class="varname">X11BASE</code>,
                   4723:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4724:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4725:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4726: <p>You can display a different or additional files by
                   4727:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4728:            default is <code class="filename">MESSAGE</code>, if the file
                   4729:            exists.</p>
                   4730: </dd>
                   4731: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4732: <dd><p>FIXME: There is no documentation on the
                   4733:        alternatives framework.</p></dd>
                   4734: </dl></div>
                   4735: </div>
1.23      wiz      4736: <div class="sect2" title="11.5.2. Files affecting the build process">
1.1       dsieger  4737: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4738: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1       dsieger  4739: <div class="variablelist"><dl>
                   4740: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4741: <dd><p>This file contains arbitrary things that could
                   4742:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4743:        to be used by more than one package. This file should only be
                   4744:        used when the packages that will use the file are known in
                   4745:        advance. For other purposes it is often better to write a
                   4746:        <code class="filename">*.mk</code> file and give it a good name that
                   4747:        describes what it does.</p></dd>
                   4748: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4749: <dd><p>This file contains the dependency information
1.10      hubertf  4750:        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  4751: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4752: <dd><p>This file contains workarounds for compiler bugs
                   4753:        and similar things. It is included automatically by the pkgsrc
                   4754:        infrastructure, so you don't need an extra
                   4755:        <code class="literal">.include</code> line for
                   4756:        it.</p></dd>
                   4757: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4758: <dd><p>This file contains the code for the
1.10      hubertf  4759:        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  4760:        selected by the user. If a package has only one or two options,
                   4761:        it is equally acceptable to put the code directly into the
                   4762:        <code class="filename">Makefile</code>.</p></dd>
                   4763: </dl></div>
                   4764: </div>
1.23      wiz      4765: <div class="sect2" title="11.5.3. Files affecting nothing at all">
1.1       dsieger  4766: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4767: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1       dsieger  4768: <div class="variablelist"><dl>
                   4769: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4770: <dd><p>These files do not take place in the creation of
                   4771:        a package and thus are purely informative to the package
                   4772:        developer.</p></dd>
                   4773: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4774: <dd><p>This file contains things that need to be done
                   4775:        to make the package even
                   4776:        better.</p></dd>
                   4777: </dl></div>
                   4778: </div>
                   4779: </div>
1.23      wiz      4780: <div class="sect1" title="11.6. work*">
1.1       dsieger  4781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4782: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4783: </h2></div></div></div>
1.10      hubertf  4784: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4785:     unpacked into the directory denoted by
                   4786:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4787:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4788:     directory is also used to keep various timestamp files.
                   4789:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4790:     The default is <code class="filename">${.CURDIR}/work</code>
                   4791:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4792:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4793: </div>
1.23      wiz      4794: <div class="sect1" title="11.7. files/*">
1.1       dsieger  4795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4796: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4797: </h2></div></div></div>
                   4798: <p>If you have any files that you wish to be placed in the package prior
                   4799:     to configuration or building, you could place these files here and use
1.10      hubertf  4800:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4801:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4802:     this. Alternatively, you could simply diff the file against
                   4803:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4804:     the creation of this file.</p>
                   4805: <p>If you want to share files in this way with other
                   4806:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4807:     to the other package's <code class="filename">files</code> directory,
                   4808:     e.g.:</p>
                   4809: <pre class="programlisting">
                   4810: FILESDIR=${.CURDIR}/../xemacs/files
                   4811: </pre>
                   4812: </div>
                   4813: </div>
1.23      wiz      4814: <div class="chapter" title="Chapter 12. Programming in Makefiles">
1.1       dsieger  4815: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4816: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4817: <div class="toc">
                   4818: <p><b>Table of Contents</b></p>
                   4819: <dl>
1.6       rillig   4820: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      4821: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   4822: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4823: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4824: <dd><dl>
                   4825: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4826: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4827: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4828: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4829: <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  4830: </dl></dd>
                   4831: </dl>
                   4832: </div>
                   4833: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4834:   each of which forms a well-defined part of the pkgsrc system. Using
1.29      dholland 4835:   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  4836:   like pkgsrc requires some discipline to keep the code correct and
                   4837:   understandable.</p>
                   4838: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4839:   programming are variables (which are actually macros) and shell
                   4840:   commands. Among these shell commands may even be more complex ones
1.29      dholland 4841:   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  4842:   as intended it is necessary to quote all variables correctly when they
                   4843:   are used.</p>
                   4844: <p>This chapter describes some patterns, that appear quite often in
                   4845:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4846:   with them.</p>
1.23      wiz      4847: <div class="sect1" title="12.1. Caveats">
1.1       dsieger  4848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4849: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.23      wiz      4850: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4851: <p>When you are creating a file as a
                   4852:     target of a rule, always write the data to a temporary file first
                   4853:     and finally rename that file. Otherwise there might occur an error
                   4854:     in the middle of generating the file, and when the user runs
1.29      dholland 4855:     <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  4856:     regenerated properly. Example:</p>
                   4857: <pre class="programlisting">
                   4858: wrong:
                   4859:         @echo "line 1" &gt; ${.TARGET}
                   4860:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4861:         @false
                   4862: 
                   4863: correct:
                   4864:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4865:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4866:         @false
                   4867:         @mv ${.TARGET}.tmp ${.TARGET}
                   4868: </pre>
1.10      hubertf  4869: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4870:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4871:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4872:     correct</strong></span> gives an error message twice, as expected.</p>
1.29      dholland 4873: <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  4874:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4875:     happens when it is interrupted, for example by pressing
                   4876:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29      dholland 4877:     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  4878: </li></ul></div>
                   4879: </div>
1.23      wiz      4880: <div class="sect1" title="12.2. Makefile variables">
1.1       dsieger  4881: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4882: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4883: <p><code class="filename">Makefile</code> variables contain strings that
                   4884:     can be processed using the five operators ``='', ``+='', ``?='',
1.29      dholland 4885:     ``:='', 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  4886:     page.</p>
                   4887: <p>When a variable's value is parsed from a
                   4888:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4889:     backslash character ``\'' are handled specially. If a backslash is
                   4890:     followed by a newline, any whitespace immediately in front of the
                   4891:     backslash, the backslash, the newline, and any whitespace
                   4892:     immediately behind the newline are replaced with a single space. A
                   4893:     backslash character and an immediately following hash character are
                   4894:     replaced with a single hash character. Otherwise, the backslash is
                   4895:     passed as is. In a variable assignment, any hash character that is
                   4896:     not preceded by a backslash starts a comment that continues upto the
                   4897:     end of the logical line.</p>
                   4898: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4899:     the only way to create a variable consisting of a single backslash
                   4900:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4901: <p>So far for defining variables. The other thing you can do with
                   4902:     variables is evaluating them. A variable is evaluated when it is
                   4903:     part of the right side of the ``:='' or the ``!='' operator, or
                   4904:     directly before executing a shell command which the variable is part
1.29      dholland 4905:     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  4906:     is, variables are not evaluated until there's no other way. The
                   4907:     ``modifiers'' mentioned in the man page also evaluate the
                   4908:     variable.</p>
                   4909: <p>Some of the modifiers split the string into words and then
                   4910:     operate on the words, others operate on the string as a whole. When
                   4911:     a string is split into words, it is split as you would expect
1.29      dholland 4912:     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 4913: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.1       dsieger  4914:     loop does not follow the shell quoting rules but splits at sequences
                   4915:     of whitespace.</p>
                   4916: <p>There are several types of variables that should be handled
                   4917:     differently. Strings and two types of lists.</p>
1.23      wiz      4918: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4919: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1       dsieger  4920:       characters. Nevertheless, you should restrict yourself to only
                   4921:       using printable characters. Examples are
                   4922:       <code class="varname">PREFIX</code> and
                   4923:       <code class="varname">COMMENT</code>.</p></li>
1.23      wiz      4924: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1       dsieger  4925:       are never exported to any shell command. Their elements are
                   4926:       separated by whitespace. Therefore, the elements themselves cannot
                   4927:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4928:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4929:       Examples are <code class="varname">DEPENDS</code> and
                   4930:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23      wiz      4931: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1       dsieger  4932:       may be exported to a shell command. Their elements can contain any
                   4933:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4934:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4935:       <code class="varname">DISTFILES</code> and
                   4936:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4937: </ul></div>
1.23      wiz      4938: <div class="sect2" title="12.2.1. Naming conventions">
1.1       dsieger  4939: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4940: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.23      wiz      4941: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4942: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4943:        are reserved for use by the pkgsrc infrastructure. They shall
                   4944:        not be used by package
                   4945:        <code class="filename">Makefile</code>s.</p></li>
1.23      wiz      4946: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4947:        lowercase variable names for the iteration
                   4948:        variables.</p></li>
1.23      wiz      4949: <li class="listitem"><p>All list variables should have a ``plural''
1.1       dsieger  4950:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4951:        <code class="varname">DISTFILES</code>.</p></li>
                   4952: </ul></div>
                   4953: </div>
                   4954: </div>
1.23      wiz      4955: <div class="sect1" title="12.3. Code snippets">
1.1       dsieger  4956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4957: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  4958: <p>This section presents you with some code snippets you should
                   4959:     use in your own code. If you don't find anything appropriate here,
                   4960:     you should test your code and add it here.</p>
1.23      wiz      4961: <div class="sect2" title="12.3.1. Adding things to a list">
1.1       dsieger  4962: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4963: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  4964: <pre class="programlisting">
                   4965: STRING=                 foo * bar `date`
                   4966: INT_LIST=               # empty
                   4967: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4968: EXT_LIST=               # empty
                   4969: ANOTHER_EXT_LIST=       a=b c=d
                   4970: 
                   4971: INT_LIST+=              ${STRING}               # 1
                   4972: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4973: EXT_LIST+=              ${STRING:Q}             # 3
                   4974: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   4975: </pre>
                   4976: <p>When you add a string to an external list (example 3), it
                   4977:       must be quoted. In all other cases, you must not add a quoting
                   4978:       level. You must not merge internal and external lists, unless you
                   4979:       are sure that all entries are correctly interpreted in both
                   4980:       lists.</p>
                   4981: </div>
1.23      wiz      4982: <div class="sect2" title="12.3.2. Converting an internal list into an external list">
1.1       dsieger  4983: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4984: <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  4985: <pre class="programlisting">
                   4986: EXT_LIST=       # empty
                   4987: .for i in ${INT_LIST}
                   4988: EXT_LIST+=      ${i:Q}""
                   4989: .endfor
                   4990: </pre>
                   4991: <p>This code converts the internal list
                   4992:       <code class="varname">INT_LIST</code> into the external list
                   4993:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4994:       are unquoted they must be quoted here. The reason for appending
                   4995:       <code class="varname">""</code> is explained below.</p>
                   4996: </div>
1.23      wiz      4997: <div class="sect2" title="12.3.3. Passing variables to a shell command">
1.1       dsieger  4998: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4999: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  5000: <p>Sometimes you may want to print an arbitrary string. There
                   5001:        are many ways to get it wrong and only few that can handle every
                   5002:        nastiness.</p>
                   5003: <pre class="programlisting">
                   5004: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5005: EXT_LIST=       string=${STRING:Q} x=second\ item
                   5006: 
                   5007: all:
                   5008:         echo ${STRING}                  # 1
                   5009:         echo "${STRING}"                # 2
                   5010:         echo "${STRING:Q}"              # 3
                   5011:         echo ${STRING:Q}                # 4
                   5012:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5013:         printf "%s\\n" ${STRING:Q}""    # 6
                   5014:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   5015: </pre>
                   5016: <p>Example 1 leads to a syntax error in the shell, as the
                   5017:       characters are just copied.</p>
                   5018: <p>Example 2 leads to a syntax error too, and if you leave out
                   5019:       the last " character from <code class="varname">${STRING}</code>,
1.29      dholland 5020:       <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  5021:       variable would be evaluated, too.</p>
                   5022: <p>Example 3 outputs each space character preceded by a
                   5023:       backslash (or not), depending on the implementation of the
1.29      dholland 5024:       <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  5025: <p>Example 4 handles correctly every string that does not start
                   5026:       with a dash. In that case, the result depends on the
1.29      dholland 5027:       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  5028:       guarantee that your input does not start with a dash, this form is
                   5029:       appropriate.</p>
                   5030: <p>Example 5 handles even the case of a leading dash
                   5031:       correctly.</p>
                   5032: <p>Example 6 also works with every string and is the
                   5033:       light-weight solution, since it does not involve a pipe, which has
                   5034:       its own problems.</p>
                   5035: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5036:       because the quoting has already been done when adding elements to
                   5037:       the list.</p>
                   5038: <p>As internal lists shall not be passed to the shell, there is
                   5039:       no example for it.</p>
                   5040: </div>
1.23      wiz      5041: <div class="sect2" title="12.3.4. Quoting guideline">
1.1       dsieger  5042: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5043: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  5044: <p>There are many possible sources of wrongly quoted variables.
                   5045:       This section lists some of the commonly known ones.</p>
1.23      wiz      5046: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5047: <li class="listitem">
1.1       dsieger  5048: <p>Whenever you use the value of a list, think
                   5049:        about what happens to leading or trailing whitespace. If the
                   5050:        list is a well-formed shell expression, you can apply the
                   5051:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5052:        whitespace from each word. The <code class="varname">:M</code> operator
                   5053:        first splits its argument according to the rules of the shell,
                   5054:        and then creates a new list consisting of all words that match
                   5055:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5056:        One class of situations where this is needed is when adding a
                   5057:        variable like <code class="varname">CPPFLAGS</code> to
                   5058:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5059:        invokes other configure scripts, it strips the leading and
                   5060:        trailing whitespace from the variable and then passes it to the
                   5061:        other configure scripts. But these configure scripts expect the
                   5062:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5063:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5064:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5065:        here is how we do it:</p>
                   5066: <pre class="programlisting">
                   5067: CPPFLAGS=               # empty
                   5068: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5069: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5070: 
                   5071: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5072: 
                   5073: all:
                   5074:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5075:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   5076: </pre>
                   5077: </li>
1.23      wiz      5078: <li class="listitem"><p>The example above contains one bug: The
1.1       dsieger  5079:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5080:        expression, but there is the C compiler after it, which also
                   5081:        expects a properly quoted string (this time in C syntax). The
                   5082:        version above is therefore only correct if
                   5083:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5084:        or double quotes. If you want to allow these, you have to add
                   5085:        another layer of quoting to each variable that is used as a C
                   5086:        string literal. You cannot use the <code class="varname">:Q</code>
                   5087:        operator for it, as this operator only works for the
                   5088:        shell.</p></li>
1.23      wiz      5089: <li class="listitem">
1.1       dsieger  5090: <p>Whenever a variable can be empty, the
                   5091:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5092:        are two completely different cases which can be solved with the
                   5093:        same trick.</p>
                   5094: <pre class="programlisting">
                   5095: EMPTY=                  # empty
                   5096: empty_test:
                   5097:         for i in a ${EMPTY:Q} c; do \
                   5098:             echo "$$i"; \
                   5099:         done
                   5100: 
                   5101: for_test:
                   5102: .for i in a:\ a:\test.txt
                   5103:         echo ${i:Q}
                   5104:         echo "foo"
                   5105: .endfor
                   5106: </pre>
                   5107: <p>The first example will only print two of the three lines
                   5108:        we might have expected. This is because
                   5109:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5110:        the shell cannot see. The workaround is to write
                   5111:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5112:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5113:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5114: <p>The second example will only print three lines instead of
                   5115:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5116:        This is because the backslash of the value
                   5117:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29      dholland 5118:        <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
                   5119:        <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  5120:        <code class="varname">${i:Q}""</code>.</p>
                   5121: </li>
                   5122: </ul></div>
                   5123: </div>
1.23      wiz      5124: <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
1.1       dsieger  5125: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5126: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5127: <p>The pkgsrc bmake program does not handle the following
                   5128:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5129:       contains a ``-'' character, one of the closing braces is included
                   5130:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5131: <pre class="programlisting">
                   5132: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5133: </pre>
                   5134: <p>For a more complex code snippet and a workaround, see the
                   5135:       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
                   5136:       <code class="varname">bug1</code>.</p>
                   5137: </div>
                   5138: </div>
                   5139: </div>
1.23      wiz      5140: <div class="chapter" title="Chapter 13. PLIST issues">
1.1       dsieger  5141: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5142: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5143: <div class="toc">
                   5144: <p><b>Table of Contents</b></p>
                   5145: <dl>
1.6       rillig   5146: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      5147: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5148: <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   5149: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5150: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      5151: <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   5152: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5153: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5154: </dl>
                   5155: </div>
                   5156: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      5157:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  5158:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5159:   directory it's been installed in) plus some additional statements
1.29      dholland 5160:   - 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  5161:   This chapter addresses some issues that need attention when
                   5162:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5163:   below!).</p>
1.23      wiz      5164: <div class="sect1" title="13.1. RCS ID">
1.1       dsieger  5165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5166: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5167: <p>Be sure to add a RCS ID line as the first thing in any
                   5168:     <code class="filename">PLIST</code> file you write:</p>
                   5169: <pre class="programlisting">
                   5170: @comment $NetBSD$
                   5171:     </pre>
                   5172: </div>
1.23      wiz      5173: <div class="sect1" title="13.2. Semi-automatic PLIST generation">
1.1       dsieger  5174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5175: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  5176: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  5177:     to output a PLIST that matches any new files since the package
1.10      hubertf  5178:     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  5179:     more information on this target.</p>
                   5180: </div>
1.23      wiz      5181: <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
1.1       dsieger  5182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  5183: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  5184: </h2></div></div></div>
                   5185: <p>If you have used any of the *-dirs packages, as explained in
1.10      hubertf  5186:     <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
                   5187:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1       dsieger  5188:     <code class="varname">@comment</code>s instead of real
                   5189:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5190:     specific directories and files, so that the results of that
                   5191:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5192:     lot</em></span> during the update of packages.</p>
                   5193: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5194:     of AWK patterns and actions that are used to filter the output of
                   5195:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5196:     scripting you like to it, but be careful with quoting.</p>
                   5197: <p>For example, to get all files inside the
                   5198:     <code class="filename">libdata/foo</code> directory removed from the
                   5199:     resulting PLIST:</p>
                   5200: <pre class="programlisting">
                   5201: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5202:     </pre>
                   5203: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5204:     to a specific (shared) directory converted to
                   5205:     <code class="varname">@comment</code>s:</p>
                   5206: <pre class="programlisting">
                   5207: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5208:     </pre>
                   5209: </div>
1.23      wiz      5210: <div class="sect1" title="13.4. Variable substitution in PLIST">
1.1       dsieger  5211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5212: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5213: <p>A number of variables are substituted automatically in
                   5214:     PLISTs when a package is installed on a system. This includes the
                   5215:     following variables:</p>
                   5216: <div class="variablelist"><dl>
                   5217: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5218: <dd>
                   5219: <p>Some packages like emacs and perl embed information
                   5220:          about which architecture they were built on into the
                   5221:          pathnames where they install their files. To handle this
                   5222:          case, PLIST will be preprocessed before actually used, and
                   5223:          the symbol
1.23      wiz      5224:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  5225:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  5226:          same is done if the string
                   5227:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5228:          PLIST somewhere - use this on packages that have GNU
                   5229:          autoconf-created configure scripts.</p>
1.23      wiz      5230: <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  5231: <h3 class="title">Legacy note</h3>
                   5232: <p>There used to be a symbol
1.23      wiz      5233:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  5234:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  5235:            -m</strong></span>, but that's no longer supported and has
                   5236:            been removed.</p>
                   5237: </div>
                   5238: </dd>
                   5239: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5240: <dd>
                   5241: <p>Some packages want to embed the OS name and version
                   5242:          into some paths.  To do this, use these variables in the
                   5243:          <code class="filename">PLIST</code>:
                   5244:          </p>
1.23      wiz      5245: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5246: <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>
                   5247: <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>
                   5248: <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  5249: </ul></div>
                   5250: </dd>
                   5251: </dl></div>
                   5252: <p>For a complete list of values which are replaced by
                   5253:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5254:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5255: <p>If you want to change other variables not listed above, you
                   5256:     can add variables and their expansions to this variable in the
1.10      hubertf  5257:     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  5258: <pre class="programlisting">
                   5259: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5260:     </pre>
1.23      wiz      5261: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  5262:     in the <code class="filename">PLIST</code> with
1.23      wiz      5263:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      5264: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   5265:     the common case of conditionally including some
                   5266:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5267:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   5268:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5269:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      5270:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      5271:     in the <code class="filename">PLIST</code> with either
1.23      wiz      5272:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5273:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      5274:     For example, in <code class="filename">Makefile</code>:</p>
                   5275: <pre class="programlisting">
                   5276: PLIST_VARS+=   foo
                   5277: .if <em class="replaceable"><code>condition</code></em>
                   5278: PLIST.foo=     yes
                   5279: .else
                   5280:     </pre>
                   5281: <p>And then in <code class="filename">PLIST</code>:</p>
                   5282: <pre class="programlisting">
                   5283: @comment $NetBSD$
                   5284: bin/bar
                   5285: man/man1/bar.1
                   5286: ${PLIST.foo}bin/foo
                   5287: ${PLIST.foo}man/man1/foo.1
                   5288: ${PLIST.foo}share/bar/foo.data
                   5289: ${PLIST.foo}@dirrm share/bar
                   5290:     </pre>
1.1       dsieger  5291: </div>
1.23      wiz      5292: <div class="sect1" title="13.5. Man page compression">
1.1       dsieger  5293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5294: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5295: <p>Man pages should be installed in compressed form if
                   5296:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5297:     and uncompressed otherwise. To handle this in the
1.23      wiz      5298:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  5299:     appended/removed automatically for man pages according to
                   5300:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5301:     or not, see above for details. This modification of the
                   5302:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5303:     <code class="filename">PLIST</code> itself.</p>
                   5304: </div>
1.23      wiz      5305: <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
1.1       dsieger  5306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5307: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5308: </h2></div></div></div>
                   5309: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5310:     in generating the binary package, set the variable
                   5311:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29      dholland 5312:     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  5313:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5314:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5315: </div>
1.23      wiz      5316: <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
1.1       dsieger  5317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5318: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5319: <p>Some packages decide to install a different set of files based on
                   5320:     the operating system being used. These differences can be
                   5321:     automatically handled by using the following files:</p>
1.23      wiz      5322: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5323: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5324: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5325: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5326: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5327: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  5328: </ul></div>
                   5329: </div>
1.23      wiz      5330: <div class="sect1" title="13.8. Sharing directories between packages">
1.1       dsieger  5331: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5332: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23      wiz      5333: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  5334:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 5335:     directories were problematic because you had to add special
                   5336:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  5337:     centralized package handle them.</p>
1.22      jakllsch 5338: <p>In pkgsrc, it is now easy: Each package should create
                   5339:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5340:     will remove any directories left empty after uninstalling a
                   5341:     package.</p>
                   5342: <p>If a package needs an empty directory to work, create
                   5343:     the directory during installation as usual, and also add an
                   5344:     entry to the PLIST:
                   5345:     </p>
1.1       dsieger  5346: <pre class="programlisting">
1.22      jakllsch 5347: @pkgdir path/to/empty/directory
1.1       dsieger  5348:     </pre>
1.22      jakllsch 5349: <p>
                   5350:     </p>
1.1       dsieger  5351: </div>
                   5352: </div>
1.23      wiz      5353: <div class="chapter" title="Chapter 14. Buildlink methodology">
1.1       dsieger  5354: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5355: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5356: <div class="toc">
                   5357: <p><b>Table of Contents</b></p>
                   5358: <dl>
1.6       rillig   5359: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      5360: <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  5361: <dd><dl>
1.6       rillig   5362: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      5363: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5364:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5365:       and
                   5366:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5367:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5368: </dl></dd>
1.23      wiz      5369: <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  5370: <dd><dl>
1.23      wiz      5371: <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   5372: <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  5373: </dl></dd>
                   5374: </dl>
                   5375: </div>
                   5376: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5377:   are seen by a package's configure and build processes.  This is implemented
                   5378:   in a two step process:</p>
1.23      wiz      5379: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5380: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  5381:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5382:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      5383: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  5384:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5385:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5386:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5387:       native compiler on some operating systems look like GCC, so that
                   5388:       packages that expect GCC won't require modifications to build with
                   5389:       those native compilers.</p></li>
                   5390: </ol></div>
                   5391: <p>This normalizes the environment in which a package is built so that the
                   5392:   package may be built consistently despite what other software may be
                   5393:   installed. Please note that the normal system header and library paths,
                   5394:   e.g. <code class="filename">/usr/include</code>,
                   5395:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5396:   designed to insulate the package build from non-system-supplied
                   5397:   software.</p>
1.23      wiz      5398: <div class="sect1" title="14.1. Converting packages to use buildlink3">
1.1       dsieger  5399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5400: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5401: <p>The process of converting packages to use the buildlink3
1.23      wiz      5402:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  5403:     The things to keep in mind are:</p>
1.23      wiz      5404: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5405: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  5406:        instead of the actual toolchain.  Some packages are tricky,
                   5407:        and the only way to know for sure is the check
                   5408:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5409:        wrappers are being invoked.</p></li>
1.23      wiz      5410: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  5411:        the package Makefile, e.g. Java VMs, standalone shells,
                   5412:        etc., because the code to symlink files into
                   5413:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      5414:        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  5415:        </p></li>
1.23      wiz      5416: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  5417:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5418:        package's Makefile are added as dependencies for that package.
                   5419:        </p></li>
                   5420: </ol></div>
                   5421: <p>If a dependency on a particular package is required for its libraries and
                   5422:     headers, then we replace:</p>
                   5423: <pre class="programlisting">
                   5424: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5425: </pre>
                   5426: <p>with</p>
                   5427: <pre class="programlisting">
                   5428: .include "../../category/foo/buildlink3.mk"
                   5429: </pre>
                   5430: <p>The buildlink3.mk files usually define the required dependencies.
                   5431:     If you need a newer version of the dependency when using buildlink3.mk
                   5432:     files, then you can define it in your Makefile; for example:</p>
                   5433: <pre class="programlisting">
                   5434: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5435: .include "../../category/foo/buildlink3.mk"
                   5436: </pre>
                   5437: <p>There are several <code class="filename">buildlink3.mk</code>
                   5438:     files in <code class="filename">pkgsrc/mk</code>
                   5439:     that handle special package issues:</p>
1.23      wiz      5440: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5441: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  5442:        the native or a pkgsrc Berkeley DB implementation based on
                   5443:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5444:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      5445: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  5446:        comes with neither Curses nor NCurses, this will take care
                   5447:        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      5448: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  5449:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5450:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5451:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      5452: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  5453:        system-provided Motif installation or adds a dependency on
                   5454:        <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      5455:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   5456:        <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  5457:        which Motif version will be used.</p></li>
1.23      wiz      5458: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  5459:        variables that may be used by packages that use the
                   5460:        Open Sound System (OSS) API.</p></li>
1.23      wiz      5461: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.1       dsieger  5462:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
                   5463:        the file for more information.</p></li>
1.23      wiz      5464: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  5465:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5466:        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      5467: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  5468:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5469:        library.</p></li>
                   5470: </ul></div>
                   5471: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5472:     files provide a more complete
                   5473:     description of how to use them properly.</p>
                   5474: </div>
1.23      wiz      5475: <div class="sect1" title="14.2. Writing buildlink3.mk files">
1.1       dsieger  5476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5477: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5478: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5479:     included by Makefiles to indicate the need to compile and link
                   5480:     against header files and libraries provided by the package.  A
                   5481:     <code class="filename">buildlink3.mk</code> file should always provide
                   5482:     enough information to add the correct type of dependency
                   5483:     relationship and include any other
                   5484:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5485:     headers and libraries that it needs in turn.</p>
                   5486: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5487:     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>
                   5488:     package is highly recommended.  For most packages, the following
                   5489:     command will generate a good starting point for
                   5490:     <code class="filename">buildlink3.mk</code> files:</p>
                   5491: <pre class="screen">
                   5492: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5493: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5494:     </pre>
1.23      wiz      5495: <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
1.1       dsieger  5496: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5497: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5498: <p>The following real-life example
                   5499:       <code class="filename">buildlink3.mk</code> is taken
                   5500:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5501: <pre class="programlisting">
1.18      snj      5502: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  5503: 
1.18      snj      5504: BUILDLINK_TREE+=       tiff
1.1       dsieger  5505: 
1.18      snj      5506: .if !defined(TIFF_BUILDLINK3_MK)
                   5507: TIFF_BUILDLINK3_MK:=
1.1       dsieger  5508: 
1.18      snj      5509: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5510: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5511: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.1       dsieger  5512: 
                   5513: .include "../../devel/zlib/buildlink3.mk"
                   5514: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      5515: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  5516: 
1.18      snj      5517: BUILDLINK_TREE+=       -tiff
1.1       dsieger  5518: </pre>
                   5519: <p>The header and footer manipulate
1.18      snj      5520:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  5521:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      5522:       the dependency tree.</p>
                   5523: <p>The main section is protected from multiple inclusion
1.1       dsieger  5524:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5525:       added.  Several important variables are set in the section:</p>
1.23      wiz      5526: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5527: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5528:          is the actual dependency recorded in the installed
                   5529:          package; this should always be set using
1.10      hubertf  5530:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  5531:          we're appending to any pre-existing list of values.  This
                   5532:          variable should be set to the first version of the
1.26      wiz      5533:          package that had an backwards-incompatible API change.
1.1       dsieger  5534:          </p></li>
1.23      wiz      5535: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5536:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5537:          pkgsrc directory.</p></li>
1.23      wiz      5538: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5539:          (not shown above) controls whether we use
                   5540:          <code class="varname">BUILD_DEPENDS</code> or
                   5541:          <code class="varname">DEPENDS</code> to add the dependency on
                   5542:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5543:          selected by setting
                   5544:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5545:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  5546:          used.</p></li>
1.23      wiz      5547: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5548:            and
                   5549:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5550:            (not shown above) are lists of subdirectories of
                   5551:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5552:            to add to the header and library search paths.  These
1.23      wiz      5553:            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  5554:          respectively.</p></li>
1.23      wiz      5555: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5556:            (not shown above) is the list of preprocessor flags to add
                   5557:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      5558:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  5559:            should be avoided and instead be handled using
                   5560:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5561:          above.</p></li>
                   5562: </ul></div>
                   5563: <p>The following variables are all optionally defined within
                   5564:       this second section (protected against multiple inclusion) and
                   5565:       control which package files are symlinked into
                   5566:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5567:       transformed during the symlinking:</p>
1.23      wiz      5568: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5569: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5570:            (not shown above) is a shell glob pattern relative to
                   5571:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5572:            to be symlinked into
                   5573:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5574:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      5575: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5576:            (not shown above) is a shell pipeline that
                   5577:            outputs to stdout a list of files relative to
                   5578:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5579:            The resulting files are to be symlinked
                   5580:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5581:            this takes the <code class="filename">+CONTENTS</code> of a
                   5582:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5583:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      5584: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5585:            (not shown above) is a filter command that filters
                   5586:            <code class="filename">+CONTENTS</code> input into a list of files
                   5587:            relative to
                   5588:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5589:            on stdout.  By default for overwrite packages,
                   5590:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5591:            outputs the contents of the <code class="filename">include</code>
                   5592:            and <code class="filename">lib</code> directories in the package
                   5593:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5594:            it outputs any libtool archives in
                   5595:            <code class="filename">lib</code> directories.</p></li>
1.23      wiz      5596: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5597:            (not shown above) is a list of sed arguments used to
                   5598:            transform the name of the source filename into a
1.10      hubertf  5599:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  5600:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5601: </ul></div>
1.18      snj      5602: <p>This section can additionally include any
1.1       dsieger  5603:       <code class="filename">buildlink3.mk</code> needed for
                   5604:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5605:       Including these <code class="filename">buildlink3.mk</code> files
                   5606:       means that the headers and libraries for these
                   5607:       dependencies are also symlinked into
                   5608:       <code class="filename">${BUILDLINK_DIR}</code>
                   5609:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5610:       <code class="filename">buildlink3.mk</code>
1.18      snj      5611:       file is included. Dependencies are only added for directly
                   5612:       include <code class="filename">buildlink3.mk</code> files.</p>
1.1       dsieger  5613: </div>
1.26      wiz      5614: <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files">
1.1       dsieger  5615: <div class="titlepage"><div><div><h3 class="title">
1.26      wiz      5616: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1       dsieger  5617:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5618:       and
                   5619:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5620:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5621: <p>These two variables differ in that one describes source
                   5622:       compatibility (API) and the other binary compatibility (ABI).
                   5623:       The difference is that a change in the API breaks compilation of
                   5624:       programs while changes in the ABI stop compiled programs from
                   5625:       running.</p>
                   5626: <p>Changes to the
1.27      wiz      5627:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5628:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5629:       very rarely. One possible reason is that all packages depending
                   5630:       on this already need a newer version. In case it is bumped see
                   5631:       the description below.</p>
                   5632: <p>The most common example of an ABI change is that the major
                   5633:       version of a shared library is increased. In this case,
                   5634:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5635:       should be adjusted to require at least the new package version.
                   5636:       Then the packages that depend on this package need their
                   5637:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5638:       <code class="filename">buildlink3.mk</code> files, their
                   5639:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5640:       adjusted, too. This is needed so pkgsrc will require the correct
                   5641:       package dependency and not settle for an older one when building
                   5642:       the source.</p>
1.10      hubertf  5643: <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      5644:       more information about dependencies on other packages,
                   5645:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  5646:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5647: <p>Please take careful consideration before adjusting
                   5648:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5649:       or
                   5650:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5651:       as we don't want to cause unneeded package deletions and
                   5652:       rebuilds.  In many cases, new versions of packages work just
                   5653:       fine with older dependencies.</p>
                   5654: <p>Also it is not needed to set
1.26      wiz      5655:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5656:       when it is identical to
1.1       dsieger  5657:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5658: </div>
                   5659: </div>
1.23      wiz      5660: <div class="sect1" title="14.3. Writing builtin.mk files">
1.1       dsieger  5661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5662: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5663: <p>Some packages in pkgsrc install headers and libraries that
                   5664:       coincide with headers and libraries present in the base system.
                   5665:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5666:       packages should also include a <code class="filename">builtin.mk</code>
                   5667:       file that includes the necessary checks to decide whether using
                   5668:       the built-in software or the pkgsrc software is
                   5669:     appropriate.</p>
                   5670: <p>The only requirements of a builtin.mk file for
                   5671:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      5672: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5673: <li class="listitem"><p>It should set
1.1       dsieger  5674:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5675:        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  5676:        after it is included.</p></li>
1.23      wiz      5677: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  5678:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5679:        which is already set before the
                   5680:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      5681: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  5682:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5683:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5684: </ol></div>
1.23      wiz      5685: <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
1.1       dsieger  5686: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5687: <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  5688: <p>The following is the recommended template for builtin.mk
                   5689:       files:</p>
                   5690: <pre class="programlisting">
                   5691: .if !defined(IS_BUILTIN.foo)
                   5692: #
                   5693: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5694: # genuinely exists in the system or not.
                   5695: #
                   5696: IS_BUILTIN.foo?=        no
                   5697: 
                   5698: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5699: # version can be determined.
                   5700: #
                   5701: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5702: BUILTIN_PKG.foo?=       foo-1.0
                   5703: .  endif
                   5704: .endif  # IS_BUILTIN.foo
                   5705: 
                   5706: .if !defined(USE_BUILTIN.foo)
                   5707: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5708: .  if defined(BUILTIN_PKG.foo)
                   5709: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5710: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5711: USE_BUILTIN.foo!=                                                       \
                   5712:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5713:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5714: .      endif
                   5715: .    endfor
                   5716: .  endif
                   5717: .endif  # USE_BUILTIN.foo
                   5718: 
                   5719: CHECK_BUILTIN.foo?=     no
                   5720: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5721: #
                   5722: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5723: # "yes" or "no".
                   5724: #
                   5725: .endif  # CHECK_BUILTIN.foo
                   5726: </pre>
                   5727: <p>The first section sets
                   5728:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5729:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5730:       in the base system.  This should not be a base system software
                   5731:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      5732:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  5733:       included as part of the base system.  This variable is only
                   5734:       used internally within the <code class="filename">builtin.mk</code>
                   5735:       file.</p>
                   5736: <p>The second section sets
                   5737:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5738:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5739:       system if it exists (if
                   5740:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5741:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  5742:       within the <code class="filename">builtin.mk</code> file.</p>
                   5743: <p>The third section sets
                   5744:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5745:       and is <span class="emphasis"><em>required</em></span> in all
                   5746:       <code class="filename">builtin.mk</code> files.  The code in this
                   5747:       section must make the determination whether the built-in
                   5748:       software is adequate to satisfy the dependencies listed in
                   5749:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5750:       This is typically done by comparing
                   5751:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5752:       against each of the dependencies in
                   5753:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5754:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5755:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5756:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5757:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5758:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5759:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5760:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5761:       that the built-in version of the software is similar enough to
                   5762:       be used as a replacement.</p>
                   5763: <p>The last section is guarded by
                   5764:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5765:       and includes code that uses the value of
                   5766:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5767:       set in the previous section.  This typically includes, e.g.,
                   5768:       adding additional dependency restrictions and listing additional
                   5769:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5770:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5771: </div>
1.23      wiz      5772: <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
1.1       dsieger  5773: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5774: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5775: <p>When building packages, it's possible to choose whether to set
                   5776:        a global preference for using either the built-in (native)
                   5777:        version or the pkgsrc version of software to satisfy a
                   5778:        dependency.  This is controlled by setting
                   5779:        <code class="varname">PREFER_PKGSRC</code> and
                   5780:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5781:        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  5782:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5783:        use the pkgsrc versions of software, while
                   5784:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5785:        built-in versions.  Preferences are determined by the most
                   5786:        specific instance of the package in either
                   5787:        <code class="varname">PREFER_PKGSRC</code> or
                   5788:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5789:        in neither or in both variables, then
                   5790:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5791:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5792:        using pkgsrc versions of software for all but the most basic
                   5793:       bits on a NetBSD system, you can set:</p>
                   5794: <pre class="programlisting">
                   5795: PREFER_PKGSRC=  yes
                   5796: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5797: </pre>
                   5798: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5799:       <code class="filename">builtin.mk</code>
                   5800:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5801:       otherwise it is simply ignored in that list.</p>
                   5802: </div>
                   5803: </div>
                   5804: </div>
1.23      wiz      5805: <div class="chapter" title="Chapter 15. The pkginstall framework">
1.1       dsieger  5806: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5807: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5808: <div class="toc">
                   5809: <p><b>Table of Contents</b></p>
                   5810: <dl>
1.6       rillig   5811: <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  5812: <dd><dl>
1.6       rillig   5813: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5814: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5815: </dl></dd>
1.6       rillig   5816: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5817: <dd><dl>
1.23      wiz      5818: <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   5819: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5820: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5821: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5822: </dl></dd>
                   5823: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5824: <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>
                   5825: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5826: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5827: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5828: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5829: <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  5830: </dl>
                   5831: </div>
                   5832: <p>This chapter describes the framework known as
                   5833: <code class="literal">pkginstall</code>, whose key features are:</p>
1.23      wiz      5834: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5835: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5836:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5837: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5838:     provided that packages are correctly designed.</p></li>
1.23      wiz      5839: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5840: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5841: <li class="listitem"><p>Registration of system shells.</p></li>
                   5842: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5843: </ul></div>
                   5844: <p>The following sections inspect each of the above points in detail.</p>
                   5845: <p>You may be thinking that many of the things described here could be
                   5846: easily done with simple code in the package's post-installation target
                   5847: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5848: as the code in them is only executed when building from source.  Machines
                   5849: using binary packages could not benefit from it at all (as the code itself
                   5850: could be unavailable).  Therefore, the only way to achieve any of the items
                   5851: described above is by means of the installation scripts, which are
                   5852: automatically generated by pkginstall.</p>
1.23      wiz      5853: <div class="sect1" title="15.1. Files and directories outside the installation prefix">
1.1       dsieger  5854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5855: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5856: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5857: of files and directories that belong to a package.  The names used in it
                   5858: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5859: which means that it cannot register files outside this directory (absolute
                   5860: path names are not allowed).  Despite this restriction, some packages need
                   5861: to install files outside this location; e.g., under
                   5862: <code class="filename">${VARBASE}</code> or
                   5863: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5864: is to create such files during installation time by using
                   5865: installation scripts.</p>
                   5866: <p>The generic installation scripts are shell scripts that can
                   5867: contain arbitrary code.  The list of scripts to execute is taken from
                   5868: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5869: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5870: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5871: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5872: commands, so they have the potential to create and manage files
                   5873: anywhere in the file system.</p>
                   5874: <p>Using these general installation files is not recommended, but
                   5875: may be needed in some special cases.  One reason for avoiding them is
                   5876: that the user has to trust the packager that there is no unwanted or
                   5877: simply erroneous code included in the installation script. Also,
                   5878: previously there were many similar scripts for the same functionality,
                   5879: and fixing a common error involved finding and changing all of
                   5880: them.</p>
                   5881: <p>The pkginstall framework offers another, standardized way.  It
                   5882: provides generic scripts to abstract the manipulation of such files
                   5883: and directories based on variables set in the package's
                   5884: <code class="filename">Makefile</code>.  The rest of this section describes
                   5885: these variables.</p>
1.23      wiz      5886: <div class="sect2" title="15.1.1. Directory manipulation">
1.1       dsieger  5887: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5888: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5889: <p>The following variables can be set to request the creation of
                   5890: directories anywhere in the file system:</p>
1.23      wiz      5891: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5892: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5893:     contain a list of directories that should be created and should attempt
                   5894:     to be destroyed by the installation scripts.  The difference between
                   5895:     the two is that the latter prompts the administrator to remove any
                   5896:     directories that may be left after deinstallation (because they were
                   5897:     not empty), while the former does not.</p></li>
1.23      wiz      5898: <li class="listitem">
1.1       dsieger  5899: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5900:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5901:     which directories should be created and should attempt to be destroyed
                   5902:     by the installation scripts.  Each tuple holds the following values,
                   5903:     separated by spaces: the directory name, its owner, its group and its
                   5904:     numerical mode.  For example:</p>
                   5905: <pre class="programlisting">
                   5906: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5907: </pre>
                   5908: <p>The difference between the two is exactly the same as their
                   5909:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5910: </li>
                   5911: </ul></div>
                   5912: </div>
1.23      wiz      5913: <div class="sect2" title="15.1.2. File manipulation">
1.1       dsieger  5914: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5915: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5916: <p>Creating non-empty files outside the installation prefix is tricky
                   5917: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5918: To overcome this problem, the only solution is to extract the file in the
                   5919: known place (i.e., inside the installation prefix) and copy it to the
                   5920: appropriate location during installation (done by the installation scripts
                   5921: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5922: file</em></span> in the following paragraphs, which describe the variables
                   5923: that can be used to automatically and consistently handle files outside the
                   5924: installation prefix:</p>
1.23      wiz      5925: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5926: <li class="listitem">
1.1       dsieger  5927: <p><code class="varname">CONF_FILES</code> and
1.30    ! wiz      5928:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5929:     During installation time, the master file is copied to the target one
                   5930:     if and only if the latter does not exist.  Upon deinstallation, the
                   5931:     target file is removed provided that it was not modified by the
                   5932:     installation.</p>
                   5933: <p>The difference between the two is that the latter prompts the
                   5934:     administrator to remove any files that may be left after
                   5935:     deinstallation (because they were not empty), while the former does
                   5936:     not.</p>
                   5937: </li>
1.23      wiz      5938: <li class="listitem">
1.1       dsieger  5939: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30    ! wiz      5940:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5941:     files as well as their target locations.  For each of them, it also
                   5942:     specifies their owner, their group and their numeric permissions, in
                   5943:     this order.  For example:</p>
                   5944: <pre class="programlisting">
1.30    ! wiz      5945: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       dsieger  5946: </pre>
                   5947: <p>The difference between the two is exactly the same as their
                   5948:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5949: </li>
                   5950: </ul></div>
                   5951: </div>
                   5952: </div>
1.23      wiz      5953: <div class="sect1" title="15.2. Configuration files">
1.1       dsieger  5954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5955: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  5956: <p>Configuration files are special in the sense that they are installed
                   5957: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5958: need special treatment during installation (most of which is automated by
                   5959: pkginstall).  The main concept you must bear in mind is that files marked
                   5960: as configuration files are automatically copied to the right place (somewhere
                   5961: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5962: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5963: be removed if they have local modifications.  This ensures that
                   5964: administrators never lose any custom changes they may have made.</p>
1.23      wiz      5965: <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
1.1       dsieger  5966: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5967: <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  5968: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5969: specifies where configuration files shall be installed.  Its contents are
                   5970: set based upon the following variables:</p>
1.23      wiz      5971: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5972: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5973:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5974:     be overridden by the user to point to his preferred location (e.g.,
                   5975:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5976:     Packages must not use it directly.</p></li>
1.23      wiz      5977: <li class="listitem">
1.1       dsieger  5978: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5979:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5980:     for the package being built shall be installed.  The definition of this
                   5981:     variable only makes sense in the package's
                   5982:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5983: <p>As an example, consider the Apache package,
                   5984:     <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
                   5985:     configuration files under the
                   5986:     <code class="filename">httpd/</code> subdirectory of
                   5987:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5988:     Makefile.</p>
                   5989: </li>
1.23      wiz      5990: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5991:     variable that holds this package's configuration directory (if
                   5992:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5993:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5994:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5995: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5996:     directory where the configuration files for the package identified by
                   5997:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5998: </ul></div>
                   5999: <p>Based on the above variables, pkginstall determines the value of
                   6000: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6001: variable that can be used within a package to refer to its configuration
                   6002: directory.  The algorithm used to set its value is basically the
                   6003: following:</p>
1.23      wiz      6004: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6005: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  6006:     its value is used.</p></li>
1.23      wiz      6007: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  6008:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6009:     <code class="filename">Makefile</code>, the resulting value is
                   6010:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      6011: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  6012:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6013: </ol></div>
                   6014: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  6015: 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
                   6016: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6017: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  6018: </div>
1.23      wiz      6019: <div class="sect2" title="15.2.2. Telling the software where configuration files are">
1.1       dsieger  6020: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6021: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  6022: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6023: known place, you need to teach each package where it shall install its
                   6024: files.  In some cases you will have to patch the package Makefiles to
                   6025: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6026: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6027: generated files:</p>
                   6028: <pre class="programlisting">
                   6029: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   6030: </pre>
                   6031: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6032: for</em></span> its configuration files, not where they will be originally
                   6033: installed (although the difference is never explicit,
                   6034: unfortunately).</p>
                   6035: </div>
1.23      wiz      6036: <div class="sect2" title="15.2.3. Patching installations">
1.1       dsieger  6037: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6038: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  6039: <p>As said before, pkginstall automatically handles configuration files.
                   6040: This means that <span class="strong"><strong>the packages themselves must not
                   6041: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   6042: directly</strong></span>.  Bad news is that many software installation scripts
                   6043: will, out of the box, mess with the contents of that directory.  So what is
                   6044: the correct procedure to fix this issue?</p>
                   6045: <p>You must teach the package (usually by manually patching it) to
                   6046: install any configuration files under the examples hierarchy,
                   6047: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6048: <code class="filename">PLIST</code> registers them and the administrator always
                   6049: has the original copies available.</p>
                   6050: <p>Once the required configuration files are in place (i.e., under the
                   6051: examples hierarchy), the pkginstall framework can use them as master copies
                   6052: during the package installation to update what is in
                   6053: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   6054: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  6055: 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  6056: about their syntax and their purpose.  Here is an example, taken from the
                   6057: <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>
                   6058: <pre class="programlisting">
                   6059: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6060: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   6061: </pre>
                   6062: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6063: package and has no meaning outside it.</p>
                   6064: </div>
1.23      wiz      6065: <div class="sect2" title="15.2.4. Disabling handling of configuration files">
1.1       dsieger  6066: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6067: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  6068: <p>The automatic copying of config files can be toggled by setting the
                   6069: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6070: installation.</p>
                   6071: </div>
                   6072: </div>
1.23      wiz      6073: <div class="sect1" title="15.3. System startup scripts">
1.1       dsieger  6074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6075: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  6076: <p>System startup scripts are special files because they must be
                   6077: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  6078: 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  6079: can be used.  However, pkginstall provides a special mechanism to handle
                   6080: these files.</p>
                   6081: <p>In order to provide system startup scripts, the package has
                   6082: to:</p>
1.23      wiz      6083: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6084: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  6085:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   6086:     <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
                   6087:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      6088: <li class="listitem">
1.1       dsieger  6089: <p>Tell pkginstall to handle it, appending the name of the script,
                   6090:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6091:     Continuing the previous example:</p>
                   6092: <pre class="programlisting">
                   6093: RCD_SCRIPTS+=   cupsd
                   6094: </pre>
                   6095: </li>
                   6096: </ol></div>
                   6097: <p>Once this is done, pkginstall will do the following steps for each
                   6098: script in an automated fashion:</p>
1.23      wiz      6099: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6100: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  6101:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6102:     variable.</p></li>
1.23      wiz      6103: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  6104:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6105:     that this master file must be explicitly registered in the
                   6106:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      6107: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  6108:     from the examples hierarchy into the system-wide startup scripts
                   6109:     directory.</p></li>
                   6110: </ol></div>
1.23      wiz      6111: <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
1.1       dsieger  6112: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6113: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6114: <p>The automatic copying of config files can be toggled by setting the
                   6115: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6116: installation.  Note that the scripts will be always copied inside the
                   6117: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6118: matter what the value of this variable is.</p>
                   6119: </div>
                   6120: </div>
1.23      wiz      6121: <div class="sect1" title="15.4. System users and groups">
1.1       dsieger  6122: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6123: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6124: <p>If a package needs to create special users and/or groups during
                   6125: installation, it can do so by using the pkginstall framework.</p>
                   6126: <p>Users can be created by adding entries to the
                   6127: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6128: syntax:</p>
                   6129: <pre class="programlisting">
                   6130: user:group
                   6131: </pre>
                   6132: <p>Further specification of user details may be done by setting
                   6133: per-user variables.
                   6134: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6135: numeric UID for the user.
                   6136: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6137: user's description or comment.
                   6138: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6139: user's home directory, and defaults to
                   6140: <code class="filename">/nonexistent</code> if not specified.
                   6141: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6142: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6143: not specified.</p>
                   6144: <p>Similarly, groups can be created by adding entries to the
                   6145: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6146: <pre class="programlisting">
                   6147: group
                   6148: </pre>
                   6149: <p>The numeric GID of the group may be set by defining
                   6150: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6151: <p>If a package needs to create the users and groups at an earlier
                   6152: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6153: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6154: indicate the phase before which the users and groups are created.  In
                   6155: this case, the numeric UIDs and GIDs of the created users and groups
                   6156: are automatically hardcoded into the final installation scripts.</p>
                   6157: </div>
1.23      wiz      6158: <div class="sect1" title="15.5. System shells">
1.1       dsieger  6159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6160: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6161: <p>Packages that install system shells should register them in the shell
                   6162: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6163: administrator.  This must be done from the installation scripts to keep
                   6164: binary packages working on any system.  pkginstall provides an easy way to
                   6165: accomplish this task.</p>
                   6166: <p>When a package provides a shell interpreter, it has to set the
                   6167: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6168: add some hooks to the installation scripts to handle it.  Consider the
                   6169: 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>
                   6170: <pre class="programlisting">
                   6171: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6172: </pre>
1.23      wiz      6173: <div class="sect2" title="15.5.1. Disabling shell registration">
1.1       dsieger  6174: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6175: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6176: <p>The automatic registration of shell interpreters can be disabled by
                   6177: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6178: environment variable to <code class="literal">NO</code>.</p>
                   6179: </div>
                   6180: </div>
1.23      wiz      6181: <div class="sect1" title="15.6. Fonts">
1.1       dsieger  6182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6183: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6184: <p>Packages that install X11 fonts should update the database files
                   6185: that index the fonts within each fonts directory.  This can easily be
                   6186: accomplished within the pkginstall framework.</p>
                   6187: <p>When a package installs X11 fonts, it must list the directories in
                   6188: which fonts are installed in the
                   6189: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      6190: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   6191: <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  6192: installation scripts to run the appropriate commands to update the fonts
                   6193: database files within each of those directories.  For convenience, if the
                   6194: directory path is relative, it is taken to be relative to the package's
                   6195: 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>
                   6196: <pre class="programlisting">
                   6197: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6198: </pre>
1.23      wiz      6199: <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
1.1       dsieger  6200: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6201: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6202: <p>The automatic update of fonts databases can be disabled by
                   6203: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6204: environment variable to <code class="literal">NO</code>.</p>
                   6205: </div>
                   6206: </div>
                   6207: </div>
1.23      wiz      6208: <div class="chapter" title="Chapter 16. Options handling">
1.1       dsieger  6209: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6210: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6211: <div class="toc">
                   6212: <p><b>Table of Contents</b></p>
                   6213: <dl>
1.6       rillig   6214: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      6215: <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   6216: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6217: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6218: </dl>
                   6219: </div>
                   6220: <p>Many packages have the ability to be built to support different
                   6221: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6222: in pkgsrc that provides generic handling of those options that
                   6223: determine different ways in which the packages can be built.  It's
                   6224: possible for the user to specify exactly which sets of options will be
                   6225: built into a package or to allow a set of global default options
                   6226: apply.</p>
1.7       rillig   6227: <p>There are two broad classes of behaviors that one might want to
                   6228: control via options.  One is whether some particular feature is
                   6229: enabled in a program that will be built anyway, often by including or
                   6230: not including a dependency on some other package.  The other is
                   6231: whether or not an additional program will be built as part of the
                   6232: package.  Generally, it is better to make a split package for such
                   6233: additional programs instead of using options, because it enables
                   6234: binary packages to be built which can then be added separately.  For
                   6235: example, the foo package might have minimal dependencies (those
                   6236: packages without which foo doesn't make sense), and then the foo-gfoo
                   6237: package might include the GTK frontend program gfoo.  This is better
                   6238: than including a gtk option to foo that adds gfoo, because either that
                   6239: option is default, in which case binary users can't get foo without
                   6240: gfoo, or not default, in which case they can't get gfoo.  With split
                   6241: packages, they can install foo without having GTK, and later decide to
                   6242: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6243: source users too, avoiding the need for rebuilds.</p>
                   6244: <p>Plugins with widely varying dependencies should usually be split
                   6245: instead of options.</p>
                   6246: <p>It is often more work to maintain split packages, especially if
                   6247: the upstream package does not support this.  The decision of split
                   6248: vs. option should be made based on the likelihood that users will want
                   6249: or object to the various pieces, the size of the dependencies that are
                   6250: included, and the amount of work.</p>
                   6251: <p>A further consideration is licensing.  Non-free parts, or parts
                   6252: that depend on non-free dependencies (especially plugins) should
                   6253: almost always be split if feasible.</p>
1.23      wiz      6254: <div class="sect1" title="16.1. Global default options">
1.1       dsieger  6255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6256: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6257: <p>Global default options are listed in
                   6258: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6259: that should be built into every package if that option is supported.
1.10      hubertf  6260: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6261: </div>
1.23      wiz      6262: <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
1.1       dsieger  6263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6264: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6265: </h2></div></div></div>
                   6266: <p>The following example shows how
                   6267: <code class="filename">bsd.options.mk</code> should be used
                   6268: by the hypothetical ``wibble'' package, either in the package
                   6269: <code class="filename">Makefile</code>, or in a file,
                   6270: e.g. <code class="filename">options.mk</code>, that is included by the
                   6271: main package <code class="filename">Makefile</code>.</p>
                   6272: <pre class="programlisting">
                   6273: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6274: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6275: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6276: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6277: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6278: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6279: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6280: 
                   6281: .include "../../mk/bsd.prefs.mk"
                   6282: 
                   6283: # this package was previously named wibble2
                   6284: .if defined(PKG_OPTIONS.wibble2)
                   6285: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6286: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6287:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6288: .endif
                   6289: 
                   6290: .include "../../mk/bsd.options.mk"
                   6291: 
                   6292: # Package-specific option-handling
                   6293: 
                   6294: ###
                   6295: ### FOO support
                   6296: ###
                   6297: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6298: CONFIGURE_ARGS+=    --enable-foo
                   6299: .endif
                   6300: 
                   6301: ###
                   6302: ### LDAP support
                   6303: ###
                   6304: .if !empty(PKG_OPTIONS:Mldap)
                   6305: .  include "../../databases/openldap-client/buildlink3.mk"
                   6306: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6307: .endif
                   6308: 
                   6309: ###
                   6310: ### database support
                   6311: ###
                   6312: .if !empty(PKG_OPTIONS:Mmysql)
                   6313: .  include "../../mk/mysql.buildlink3.mk"
                   6314: .endif
                   6315: .if !empty(PKG_OPTIONS:Mpgsql)
                   6316: .  include "../../mk/pgsql.buildlink3.mk"
                   6317: .endif
                   6318: </pre>
                   6319: <p>The first section contains the information about which build
                   6320: options are supported by the package, and any default options settings
                   6321: if needed.</p>
1.23      wiz      6322: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6323: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29      dholland 6324: <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  6325: options.  It should be set to
                   6326: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6327: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6328: at the point where the options are processed.</p></li>
1.23      wiz      6329: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  6330: build options supported by the package.</p></li>
1.23      wiz      6331: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  6332: list of names of groups of mutually exclusive options.  The options in
                   6333: each group are listed in
                   6334: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6335: The most specific setting of any option from the group takes
                   6336: precedence over all other options in the group.  Options from the
                   6337: groups will be automatically added to
                   6338: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      6339: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  6340: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6341: packages will fail if no option from the group is
                   6342: selected.</p></li>
1.23      wiz      6343: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  6344: of names of sets of options.  At least one option from each set must
                   6345: be selected.  The options in each set are listed in
                   6346: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6347: Options from the sets will be automatically added to
                   6348: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6349: fail if no option from the set is selected.</p></li>
1.23      wiz      6350: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  6351: build options which are enabled by default.</p></li>
1.23      wiz      6352: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  6353: of
1.23      wiz      6354: <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  6355: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6356: their option counterparts.  Pairs should be added with
1.23      wiz      6357: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  6358: warning will be issued if the user uses a legacy
                   6359: variable.</p></li>
1.23      wiz      6360: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  6361: of
1.23      wiz      6362: <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  6363: pairs that map options that have been renamed to their new
1.23      wiz      6364: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  6365: the listing of global legacy options.  A warning will be issued if
                   6366: the user uses a legacy option.</p></li>
1.23      wiz      6367: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  6368: options implied by deprecated variables used.  This can be used for
                   6369: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6370: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6371: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      6372: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  6373: a list of warnings about deprecated variables or options used, and
                   6374: what to use instead.</p></li>
                   6375: </ol></div>
                   6376: <p>A package should never modify
                   6377: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6378: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6379: To suggest a default set of options, use
                   6380: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6381: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6382: including <code class="filename">bsd.options.mk</code>.  If none of
                   6383: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6384: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6385: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6386: happen with platform-specific options if none of them is supported on
                   6387: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6388: empty list and the package is otherwise treated as not using the
                   6389: options framework.</p>
                   6390: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6391: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6392: build options, properly filtered to remove unsupported and duplicate
                   6393: options.</p>
                   6394: <p>The remaining sections contain the logic that is specific to
                   6395: each option.  The correct way to check for an option is to check
                   6396: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6397: <pre class="programlisting">
                   6398: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6399: </pre>
                   6400: </div>
1.23      wiz      6401: <div class="sect1" title="16.3. Option Names">
1.1       dsieger  6402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6403: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6404: <p>Options that enable similar features in different packages (like
                   6405: optional support for a library) should use a common name in all
                   6406: packages that support it (like the name of the library).  If another
                   6407: package already has an option with the same meaning, use the same
                   6408: name.</p>
                   6409: <p>Options that enable features specific to one package, where it's
                   6410: unlikely that another (unrelated) package has the same (or a similar)
                   6411: optional feature, should use a name prefixed with
                   6412: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6413: <p>If a group of related packages share an optional feature
                   6414: specific to that group, prefix it with the name of the
1.23      wiz      6415: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  6416: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6417: <p>For new options, add a line to
                   6418: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6419: fields, separated by tab.  The first field is the option name, the
                   6420: second its description.  The description should be a whole sentence
                   6421: (starting with an uppercase letter and ending with a period) that
1.23      wiz      6422: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6423: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  6424: </div>
1.23      wiz      6425: <div class="sect1" title="16.4. Determining the options of dependencies">
1.7       rillig   6426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6427: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  6428: <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   6429: different dependencies based on the options with which the package was
                   6430: built. For querying these options, the file
                   6431: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6432: typical example looks like this:</p>
                   6433: <pre class="programlisting">
                   6434: pkgbase := libpurple
                   6435: .include "../../mk/pkg-build-options.mk"
                   6436: 
                   6437: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6438: ...
                   6439: .endif
                   6440: </pre>
                   6441: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6442: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6443: options of the libpurple package, which can then be queried like
                   6444: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6445: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6446: details.</p>
                   6447: </div>
1.1       dsieger  6448: </div>
1.23      wiz      6449: <div class="chapter" title="Chapter 17. The build process">
1.1       dsieger  6450: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6451: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6452: <div class="toc">
                   6453: <p><b>Table of Contents</b></p>
                   6454: <dl>
1.6       rillig   6455: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6456: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6457: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6458: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      6459: <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   6460: <dd><dl>
                   6461: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6462: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6463: </dl></dd>
1.23      wiz      6464: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6465: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6466: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6467: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6468: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6469: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6470: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6471: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6472: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6473: <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   6474: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6475: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6476: </dl>
                   6477: </div>
1.23      wiz      6478: <div class="sect1" title="17.1. Introduction">
1.1       dsieger  6479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6480: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6481: <p>This chapter gives a detailed description on how a package is
                   6482:     built. Building a package is separated into different
                   6483:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6484:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      6485:     described in the following sections. Each phase is split into
1.1       dsieger  6486:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6487:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6488:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6489:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6490:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6491: <p>Never override the regular targets (like
                   6492:     <code class="varname">fetch</code>), if you have to, override the
                   6493:     <code class="varname">do-*</code> ones instead.</p>
                   6494: <p>The basic steps for building a program are always the same.  First
                   6495:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6496:     the local system and then extracted. After any pkgsrc-specific patches
                   6497:     to compile properly are applied, the software can be configured, then
                   6498:     built (usually by compiling), and finally the generated binaries, etc.
                   6499:     can be put into place on the system.</p>
                   6500: <p>To get more details about what is happening at each step,
                   6501:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6502:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6503:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6504: </div>
1.23      wiz      6505: <div class="sect1" title="17.2. Program location">
1.1       dsieger  6506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6507: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6508: <p>Before outlining the process performed by the NetBSD package system in
                   6509:     the next section, here's a brief discussion on where programs are
                   6510:     installed, and which variables influence this.</p>
                   6511: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6512:     where all files of the final program shall be installed. It is
                   6513:     usually set to <code class="varname">LOCALBASE</code>
                   6514:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6515:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6516:     <code class="varname">PREFIX</code> needs to be put
                   6517:     into the various places in the program's source where paths to
1.10      hubertf  6518:     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  6519: <p>When choosing which of these variables to use,
                   6520:     follow the following rules:</p>
1.23      wiz      6521: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   6522: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  6523:        where the current pkg will be installed.  When referring to a
                   6524:        pkg's own installation path, use
1.23      wiz      6525:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6526: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  6527:        are installed.  If you need to construct a -I or -L argument
                   6528:        to the compiler to find includes and libraries installed by
1.23      wiz      6529:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  6530:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6531:        installed all packages in <code class="filename">/usr/local</code>. As
                   6532:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6533:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      6534: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  6535:        distribution (from xsrc, etc.) is installed. When looking for
                   6536:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      6537:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   6538: <li class="listitem">
1.1       dsieger  6539: <p>X11-based packages are special in that they may be
                   6540:        installed in either <code class="varname">X11BASE</code> or
                   6541:        <code class="varname">LOCALBASE</code>.</p>
                   6542: <p>Usually, X11 packages should be installed under
                   6543:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6544:        will need to include
                   6545:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6546:        request the presence of X11 and to get the right compilation
                   6547:        flags.</p>
                   6548: <p>Even though, there are some packages that cannot be installed
                   6549:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6550:        files. These packages are special and they must be placed under
                   6551:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6552:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6553:        your package.</p>
                   6554: <p>Some notes: If you need
                   6555:        to find includes or libraries installed by a pkg that has
                   6556:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6557:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6558:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6559:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6560:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6561:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6562:        is enabled by default.</p>
                   6563: </li>
1.23      wiz      6564: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1       dsieger  6565:        the installed location of an X11
                   6566:        package. <code class="varname">X11PREFIX</code> will be set to
                   6567:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6568:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6569:        installed.</p></li>
1.23      wiz      6570: <li class="listitem">
1.1       dsieger  6571: <p>If xpkgwedge is installed, it is possible to have some
                   6572:        packages installed in <code class="varname">X11BASE</code> and some in
                   6573:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6574:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6575:        definition can be used. It takes pairs in the format
1.29      dholland 6576:        <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  6577:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6578:        of the installed package &lt;package&gt;, or
1.23      wiz      6579:        <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
1.1       dsieger  6580:        installed.</p>
                   6581: <p>This is best illustrated by example.</p>
                   6582: <p>The following lines are taken from
                   6583:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6584: <pre class="programlisting">
                   6585: EVAL_PREFIX+=           GTKDIR=gtk+
                   6586: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6587: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6588: CONFIGURE_ARGS+=        --enable-multibyte
                   6589: </pre>
                   6590: <p>Specific defaults can be defined for the packages
                   6591:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6592:        definition of the form:</p>
                   6593: <pre class="programlisting">
                   6594: GTKDIR_DEFAULT= ${LOCALBASE}
                   6595: </pre>
                   6596: <p>where <code class="varname">GTKDIR</code> corresponds
                   6597:        to the first definition in
                   6598:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6599: </li>
1.23      wiz      6600: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29      dholland 6601:        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  6602:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6603:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6604: </ul></div>
                   6605: </div>
1.23      wiz      6606: <div class="sect1" title="17.3. Directories used during the build process">
1.1       dsieger  6607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6608: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 6609: <p>When building a package, various directories are used to store
1.1       dsieger  6610:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6611:     directories are explained here.</p>
                   6612: <p>Some of the directory variables contain relative pathnames. There
                   6613:     are two common base directories for these relative directories:
                   6614:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6615:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6616:     inside the package itself.</p>
                   6617: <div class="variablelist"><dl>
                   6618: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6619: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6620:       root directory. Generally, you don't need
                   6621:       it.</p></dd>
                   6622: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6623: <dd><p>This is an absolute pathname that points to the
                   6624:       current package.</p></dd>
                   6625: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6626: <dd><p>This is a pathname relative to
                   6627:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6628:       package.</p></dd>
                   6629: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6630: <dd><p>This is an absolute pathname pointing to the directory
                   6631:       where all work takes place. The distfiles are extracted to this
                   6632:       directory. It also contains temporary directories and log files used by
                   6633:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6634:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6635: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6636: <dd><p>This is an absolute pathname pointing to the directory
                   6637:       where the distfiles are extracted. It is usually a direct subdirectory
                   6638:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6639:       that isn't hidden. This variable may be changed by a package
                   6640:       <code class="filename">Makefile</code>.</p></dd>
                   6641: </dl></div>
1.14      jmcneill 6642: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6643:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   6644:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 6645:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6646:     If users would like to have their pkgsrc trees behave in a
                   6647:     read-only manner, then the value of
                   6648:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6649:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  6650: </div>
1.23      wiz      6651: <div class="sect1" title="17.4. Running a phase">
1.1       dsieger  6652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6653: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  6654: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  6655:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6656:     phase. This will automatically run all phases that are required for this
                   6657:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  6658:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  6659:     the package will be built, but not installed.</p>
                   6660: </div>
1.23      wiz      6661: <div class="sect1" title="17.5. The fetch phase">
1.1       dsieger  6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6663: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6664: <p>The first step in building a package is to fetch the
                   6665:     distribution files (distfiles) from the sites that are providing
                   6666:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6667:     phase.</p>
1.23      wiz      6668: <div class="sect2" title="17.5.1. What to fetch and where to get it from">
1.1       dsieger  6669: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6670: <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  6671: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6672:       defines all URLs from where the distfile, whose name is
                   6673:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6674:       fetched. The more complicated cases are described
                   6675:       below.</p>
                   6676: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6677:       the list of distfiles that have to be fetched. Its value
                   6678:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6679:       so that most packages don't need to define it at all.
                   6680:       <code class="varname">EXTRACT_SUFX</code> is
                   6681:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6682:       freely. Note that if your package requires additional
                   6683:       distfiles to the default one, you cannot just append the
                   6684:       additional filenames using the <code class="literal">+=</code>
                   6685:       operator, but you have write for example:</p>
                   6686: <pre class="programlisting">
                   6687: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6688: </pre>
                   6689: <p>Each distfile is fetched from a list of sites, usually
                   6690:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6691:       <code class="varname">DISTFILES</code> or multiple
                   6692:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6693:       set
                   6694:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6695:       to the list of URLs where the file
                   6696:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6697:       (including the suffix) can be found.</p>
                   6698: <pre class="programlisting">
                   6699: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6700: DISTFILES+=     foo-file.tar.gz
                   6701: SITES.foo-file.tar.gz= \
                   6702: http://www.somewhere.com/somehow/ \
                   6703: http://www.somewhereelse.com/mirror/somehow/
                   6704: </pre>
                   6705: <p>When actually fetching the distfiles, each item from
                   6706:       <code class="varname">MASTER_SITES</code> or
                   6707:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6708:       appended to it, without an intermediate slash. Therefore,
                   6709:       all site values have to end with a slash or other separator
                   6710:       character. This allows for example to set
                   6711:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6712:       that gets the name of the distfile as a parameter. In this
                   6713:       case, the definition would look like:</p>
                   6714: <pre class="programlisting">
                   6715: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6716: </pre>
1.22      jakllsch 6717: <p> The exception to this rule are URLs starting with a dash.
                   6718:       In that case the URL is taken as is, fetched and the result stored
                   6719:       under the name of the distfile.</p>
1.1       dsieger  6720: <p>There are some predefined values for
                   6721:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6722:       packages.  The names of the variables should speak for
                   6723:       themselves.</p>
                   6724: <pre class="programlisting">
                   6725: ${MASTER_SITE_APACHE}
                   6726: ${MASTER_SITE_BACKUP}
                   6727: ${MASTER_SITE_CYGWIN}
                   6728: ${MASTER_SITE_DEBIAN}
                   6729: ${MASTER_SITE_FREEBSD}
                   6730: ${MASTER_SITE_FREEBSD_LOCAL}
                   6731: ${MASTER_SITE_GENTOO}
                   6732: ${MASTER_SITE_GNOME}
                   6733: ${MASTER_SITE_GNU}
                   6734: ${MASTER_SITE_GNUSTEP}
                   6735: ${MASTER_SITE_IFARCHIVE}
                   6736: ${MASTER_SITE_KDE}
                   6737: ${MASTER_SITE_MOZILLA}
                   6738: ${MASTER_SITE_MYSQL}
                   6739: ${MASTER_SITE_OPENOFFICE}
                   6740: ${MASTER_SITE_PERL_CPAN}
                   6741: ${MASTER_SITE_PGSQL}
                   6742: ${MASTER_SITE_R_CRAN}
                   6743: ${MASTER_SITE_SOURCEFORGE}
                   6744: ${MASTER_SITE_SOURCEFORGE_JP}
                   6745: ${MASTER_SITE_SUNSITE}
                   6746: ${MASTER_SITE_SUSE}
                   6747: ${MASTER_SITE_TEX_CTAN}
                   6748: ${MASTER_SITE_XCONTRIB}
                   6749: ${MASTER_SITE_XEMACS}
                   6750: </pre>
                   6751: <p>Some explanations for the less self-explaining ones:
                   6752:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6753:       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      6754:       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  6755: <p>If you choose one of these predefined sites, you may
                   6756:       want to specify a subdirectory of that site. Since these
                   6757:       macros may expand to more than one actual site, you
                   6758:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6759:       specify a subdirectory:</p>
                   6760: <pre class="programlisting">
                   6761: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6762: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6763: </pre>
                   6764: <p>Note the trailing slash after the subdirectory
                   6765:       name.</p>
                   6766: </div>
1.23      wiz      6767: <div class="sect2" title="17.5.2. How are the files fetched?">
1.1       dsieger  6768: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6769: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6770: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6771:       all the distfiles exist in a local directory
                   6772:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6773:       user). If the files do not exist, they are fetched using
                   6774:       commands of the form</p>
                   6775: <pre class="programlisting">
                   6776: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6777: </pre>
                   6778: <p>where <code class="literal">${site}</code> varies through
                   6779:       several possibilities in turn: first,
                   6780:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6781:       sites specified in either <code class="varname">SITES.file</code> if
                   6782:       defined, else <code class="varname">MASTER_SITES</code> or
                   6783:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6784:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6785:       all except the first and the last can be optionally sorted
                   6786:       by the user, via setting either
                   6787:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6788:       <code class="varname">MASTER_SORT_AWK</code> or
                   6789:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6790: <p> The specific command and arguments used depend on the
                   6791:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6792:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6793: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6794:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6795:       distfiles, if they are freely distributable.  Packages setting
                   6796:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6797:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6798:       mirrored.</p>
                   6799: </div>
                   6800: </div>
1.23      wiz      6801: <div class="sect1" title="17.6. The checksum phase">
1.1       dsieger  6802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6803: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6804: <p>After the distfile(s) are fetched, their checksum is
                   6805:     generated and compared with the checksums stored in the
                   6806:     distinfo file. If the checksums don't match, the build is
                   6807:     aborted. This is to ensure the same distfile is used for
                   6808:     building, and that the distfile wasn't changed, e.g. by some
                   6809:     malign force, deliberately changed distfiles on the master
                   6810:     distribution site or network lossage.</p>
                   6811: </div>
1.23      wiz      6812: <div class="sect1" title="17.7. The extract phase">
1.1       dsieger  6813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6814: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6815: <p>When the distfiles are present on the local system, they
                   6816:     need to be extracted, as they usually come in the form of some
                   6817:     compressed archive format.</p>
                   6818: <p>By default, all <code class="varname">DISTFILES</code> are
                   6819:     extracted. If you only need some of them, you can set the
                   6820:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6821:     files.</p>
                   6822: <p>Extracting the files is usually done by a little
                   6823:     program, <code class="filename">mk/extract/extract</code>, which
                   6824:     already knows how to extract various archive formats, so most
                   6825:     likely you will not need to change anything here. But if you
                   6826:     need, the following variables may help you:</p>
                   6827: <div class="variablelist"><dl>
                   6828: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6829: <dd><p>Use these variables to override the default
                   6830:       options for an extract command, which are defined in
                   6831:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6832: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6833: <dd><p>This variable can be set to
1.14      jmcneill 6834:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6835:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6836:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6837:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6838:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6839: </dl></div>
                   6840: <p>If the <code class="filename">extract</code> program doesn't
                   6841:     serve your needs, you can also override the
                   6842:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6843:     command used for extracting the files. This command is
                   6844:     executed in the <code class="filename">${WRKSRC}</code>
                   6845:     directory. During execution of this command, the shell
                   6846:     variable <code class="varname">extract_file</code> holds the absolute
                   6847:     pathname of the file that is going to be extracted.</p>
                   6848: <p>And if that still does not suffice, you can override the
                   6849:     <code class="varname">do-extract</code> target in the package
                   6850:     Makefile.</p>
                   6851: </div>
1.23      wiz      6852: <div class="sect1" title="17.8. The patch phase">
1.1       dsieger  6853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6854: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6855: <p>After extraction, all the patches named by the
                   6856:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6857:     subdirectory of the package as well as in
                   6858:     $LOCALPATCHES/$PKGPATH (e.g.
                   6859:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6860:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6861:     <code class="filename">.gz</code> are uncompressed before they are
                   6862:     applied, files ending in <code class="filename">.orig</code> or
                   6863:     <code class="filename">.rej</code> are ignored. Any special options to
1.29      dholland 6864:     <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  6865:     <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 6866: <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  6867:     it fail if the patches apply with some lines of fuzz. Please
                   6868:     fix (regen) the patches so that they apply cleanly. The
                   6869:     rationale behind this is that patches that don't apply cleanly
                   6870:     may end up being applied in the wrong place, and cause severe
                   6871:     harm there.</p>
                   6872: </div>
1.23      wiz      6873: <div class="sect1" title="17.9. The tools phase">
1.1       dsieger  6874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6875: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6876: <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  6877:     </p>
                   6878: </div>
1.23      wiz      6879: <div class="sect1" title="17.10. The wrapper phase">
1.1       dsieger  6880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6881: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6882: <p>This phase creates wrapper programs for the compilers and
                   6883:     linkers. The following variables can be used to tweak the
                   6884:     wrappers.</p>
                   6885: <div class="variablelist"><dl>
                   6886: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6887: <dd><p>The command used to print progress
                   6888:       messages. Does nothing by default. Set to
                   6889:       <code class="literal">${ECHO}</code> to see the progress
                   6890:       messages.</p></dd>
                   6891: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6892: <dd><p>This variable can be set to
                   6893:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6894:       depending on whether you want additional information in the
                   6895:       wrapper log file.</p></dd>
                   6896: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6897: <dd><p>This variable can be set to
                   6898:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6899:       on whether the wrapper should use its cache, which will
                   6900:       improve the speed. The default value is
                   6901:       <code class="literal">yes</code>, but is forced to
                   6902:       <code class="literal">no</code> if the platform does not support
                   6903:       it.</p></dd>
                   6904: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6905: <dd><p>A list of reordering commands. A reordering
                   6906:       command has the form
                   6907:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6908:       It ensures that that
                   6909:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6910:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6911:       </p></dd>
                   6912: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6913: <dd><p>A list of transformation commands. [TODO:
                   6914:       investigate further]</p></dd>
                   6915: </dl></div>
                   6916: </div>
1.23      wiz      6917: <div class="sect1" title="17.11. The configure phase">
1.1       dsieger  6918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6919: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6920: <p>Most pieces of software need information on the header
                   6921:     files, system calls, and library routines which are available
                   6922:     on the platform they run on. The process of determining this
                   6923:     information is known as configuration, and is usually
                   6924:     automated. In most cases, a script is supplied with the
                   6925:     distfiles, and its invocation results in generation of header
                   6926:     files, Makefiles, etc.</p>
                   6927: <p>If the package contains a configure script, this can be
                   6928:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6929:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6930:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6931:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6932:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6933: <pre class="programlisting">
                   6934: .for d in ${CONFIGURE_DIRS}
                   6935:         cd ${WRKSRC} \
                   6936:         &amp;&amp; cd ${d} \
                   6937:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6938: .endfor
                   6939: </pre>
                   6940: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6941:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6942:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6943:     configure script is run with the environment
                   6944:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6945:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6946:     <code class="varname">CONFIGURE_ENV</code>,
                   6947:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6948:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6949:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6950:     package.</p>
                   6951: <p>If the program uses an <code class="filename">Imakefile</code>
                   6952:     for configuration, the appropriate steps can be invoked by
                   6953:     setting <code class="varname">USE_IMAKE</code> to
1.23      wiz      6954:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
1.1       dsieger  6955:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   6956:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6957:     xmkmf's environment by adding them to the
                   6958:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6959: <p>If the program uses <code class="filename">cmake</code>
                   6960:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6961:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6962:     You can add variables to cmake's environment by adding them to the
                   6963:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6964:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6965:     The top directory argument is given by the
                   6966:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6967:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6968: <p>If there is no configure step at all, set
1.23      wiz      6969:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6970: </div>
1.23      wiz      6971: <div class="sect1" title="17.12. The build phase">
1.1       dsieger  6972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6973: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6974: <p>For building a package, a rough equivalent of the
                   6975:     following code is executed.</p>
                   6976: <pre class="programlisting">
                   6977: .for d in ${BUILD_DIRS}
                   6978:         cd ${WRKSRC} \
                   6979:         &amp;&amp; cd ${d} \
                   6980:         &amp;&amp; env ${MAKE_ENV} \
                   6981:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6982:                 -f ${MAKE_FILE} \
                   6983:                 ${BUILD_TARGET}
                   6984: .endfor
                   6985: </pre>
                   6986: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6987:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6988:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6989:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6990:     <code class="varname">MAKE_ENV</code> and arguments
                   6991:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6992:     <code class="varname">MAKE_ENV</code>,
                   6993:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6994:     <code class="varname">MAKE_FILE</code> and
                   6995:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6996:     package.</p>
                   6997: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      6998:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6999:     <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  7000:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      7001:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   7002:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  7003: <p>If there is no build step at all, set
1.23      wiz      7004:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  7005: </div>
1.23      wiz      7006: <div class="sect1" title="17.13. The test phase">
1.1       dsieger  7007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7008: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  7009: <p>[TODO]</p>
                   7010: </div>
1.23      wiz      7011: <div class="sect1" title="17.14. The install phase">
1.1       dsieger  7012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7013: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  7014: <p>Once the build stage has completed, the final step is to
                   7015:     install the software in public directories, so users can
                   7016:     access the programs and files.</p>
                   7017: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   7018:     equivalent of the following code is executed. Additionally,
                   7019:     before and after this code, much magic is performed to do
                   7020:     consistency checks, registering the package, and so on.</p>
                   7021: <pre class="programlisting">
                   7022: .for d in ${INSTALL_DIRS}
                   7023:         cd ${WRKSRC} \
                   7024:         &amp;&amp; cd ${d} \
                   7025:         &amp;&amp; env ${MAKE_ENV} \
                   7026:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7027:                 -f ${MAKE_FILE} \
                   7028:                 ${INSTALL_TARGET}
                   7029: .endfor
                   7030: </pre>
                   7031: <p>The variable's meanings are analogous to the ones in the
                   7032:     <span class="emphasis"><em>build</em></span> phase.
                   7033:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7034:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      7035:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   7036:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  7037:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7038:     defined.</p>
                   7039: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   7040:     variables are useful. They are all variations of the
1.29      dholland 7041:     <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  7042:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7043:     install command. The specialized variants, together with their
                   7044:     intended use, are:</p>
                   7045: <div class="variablelist"><dl>
                   7046: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   7047: <dd><p>directories that contain
                   7048:       binaries</p></dd>
                   7049: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   7050: <dd><p>directories that contain
                   7051:       scripts</p></dd>
                   7052: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   7053: <dd><p>directories that contain shared and static
                   7054:       libraries</p></dd>
                   7055: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   7056: <dd><p>directories that contain data
                   7057:       files</p></dd>
                   7058: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   7059: <dd><p>directories that contain man
                   7060:       pages</p></dd>
                   7061: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   7062: <dd><p>binaries that can be stripped from debugging
                   7063:       symbols</p></dd>
                   7064: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   7065: <dd><p>binaries that cannot be
                   7066:       stripped</p></dd>
                   7067: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   7068: <dd><p>game
                   7069:       binaries</p></dd>
                   7070: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   7071: <dd><p>shared and static
                   7072:       libraries</p></dd>
                   7073: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7074: <dd><p>data files</p></dd>
                   7075: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   7076: <dd><p>data files for
                   7077:       games</p></dd>
                   7078: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7079: <dd><p>man pages</p></dd>
                   7080: </dl></div>
                   7081: <p>Some other variables are:</p>
                   7082: <div class="variablelist"><dl>
                   7083: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7084: <dd><p>A list of directories relative to
                   7085:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   7086:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7087:       The package is supposed to create all needed directories itself
                   7088:       before installing files to it and list all other directories here.
                   7089:       </p></dd>
                   7090: </dl></div>
                   7091: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      7092:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  7093:     mostly relevant for packages in the <code class="filename">regress</code>
                   7094:     category.</p>
                   7095: </div>
1.23      wiz      7096: <div class="sect1" title="17.15. The package phase">
1.1       dsieger  7097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7098: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  7099: <p>Once the install stage has completed, a binary package of
                   7100:     the installed files can be built.  These binary packages can be
                   7101:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  7102:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7103:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  7104: <p>By default, the binary packages are created in
                   7105:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7106:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7107:     one for each category in the <code class="varname">CATEGORIES</code>
                   7108:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7109:     <code class="filename">pkgsrc/packages</code>.</p>
                   7110: </div>
1.23      wiz      7111: <div class="sect1" title="17.16. Cleaning up">
1.1       dsieger  7112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7113: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  7114: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  7115:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  7116:     to clean the work directories of all dependencies too, use
1.10      hubertf  7117:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  7118: </div>
1.23      wiz      7119: <div class="sect1" title="17.17. Other helpful targets">
1.1       dsieger  7120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7121: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1       dsieger  7122: <div class="variablelist"><dl>
                   7123: <dt><span class="term">pre/post-*</span></dt>
                   7124: <dd><p>For any of the main targets described in the
                   7125:          previous section, two auxiliary targets exist with
1.23      wiz      7126:          <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  7127:          prefix for the main target's name.  These targets are
                   7128:          invoked before and after the main target is called,
                   7129:          allowing extra configuration or installation steps be
                   7130:          performed from a package's Makefile, for example, which
                   7131:          a program's configure script or install target
                   7132:          omitted.</p></dd>
                   7133: <dt><span class="term">do-*</span></dt>
                   7134: <dd><p>Should one of the main targets do the wrong thing,
                   7135:          and should there be no variable to fix this, you can
                   7136:          redefine it with the do-* target.  (Note that redefining
                   7137:          the target itself instead of the do-* target is a bad
                   7138:          idea, as the pre-* and post-* targets won't be called
                   7139:          anymore, etc.) You will not usually need to do
                   7140:          this.</p></dd>
                   7141: <dt><span class="term">reinstall</span></dt>
                   7142: <dd>
1.10      hubertf  7143: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  7144:          you noticed some file was not installed properly, you
                   7145:          can repeat the installation with this target, which will
1.23      wiz      7146:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  7147: <p>This is the default value of
                   7148:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  7149:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  7150:          package</strong></span>, where the defaults are
1.23      wiz      7151:          <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  7152:          respectively.</p>
                   7153: </dd>
                   7154: <dt><span class="term">deinstall</span></dt>
                   7155: <dd>
1.29      dholland 7156: <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  7157:          current directory, effectively de-installing the
                   7158:          package. The following variables can be used to tune the
                   7159:          behaviour:</p>
                   7160: <div class="variablelist"><dl>
                   7161: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29      dholland 7162: <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  7163: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7164: <dd><p>Remove all packages that require (depend on)
                   7165:                the given package.  This can be used to remove any
                   7166:                packages that may have been pulled in by a given
1.10      hubertf  7167:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  7168:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7169:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7170:                likely to remove whole KDE. Works by adding
1.29      dholland 7171:                <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  7172:                command line.</p></dd>
                   7173: </dl></div>
                   7174: </dd>
                   7175: <dt><span class="term">bin-install</span></dt>
                   7176: <dd><p>Install a binary package from local disk and via FTP
                   7177:          from a list of sites (see the
                   7178:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  7179:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  7180:          available anywhere.  The arguments given to
1.10      hubertf  7181:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  7182:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7183:          operation, etc.</p></dd>
                   7184: <dt><span class="term">update</span></dt>
                   7185: <dd>
                   7186: <p>This target causes the current package to be
                   7187:          updated to the latest version.  The package and all
                   7188:          depending packages first get de-installed, then current
                   7189:          versions of the corresponding packages get compiled and
                   7190:          installed.  This is similar to manually noting which
                   7191:          packages are currently installed, then performing a
1.10      hubertf  7192:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7193:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  7194:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7195:          packages.</p>
1.23      wiz      7196: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  7197:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  7198:          update</strong></span> was interrupted for some reason.
                   7199:          However, in this case, make sure you don't call
1.10      hubertf  7200:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  7201:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7202:          Otherwise, you lose the ability to automatically update
                   7203:          the current package along with the dependent packages
                   7204:          you have installed.</p>
1.10      hubertf  7205: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  7206:          update</strong></span> will only work as long as the package
                   7207:          tree remains unchanged.  If the source code for one of
                   7208:          the packages to be updated has been changed, resuming
1.10      hubertf  7209:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  7210:          fail!</p>
                   7211: <p>The following variables can be used either on the
1.10      hubertf  7212:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7213:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  7214:          update</strong></span>:</p>
                   7215: <div class="variablelist"><dl>
                   7216: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7217: <dd><p>Install target to recursively use for the
                   7218:                updated package and the dependent packages.
                   7219:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      7220:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  7221:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      7222:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7223:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7224:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  7225:                endless loop!</p></dd>
                   7226: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7227: <dd><p>Don't clean up after updating.  Useful if
                   7228:                you want to leave the work sources of the updated
                   7229:                packages around for inspection or other purposes.
                   7230:                Be sure you eventually clean up the source tree
1.23      wiz      7231:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  7232:                or you may run into troubles with old source code
                   7233:                still lying around on your next
1.10      hubertf  7234:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  7235:                update</strong></span>.</p></dd>
                   7236: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7237: <dd><p>Deinstall each package before installing
                   7238:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7239:                may be necessary if the
1.23      wiz      7240:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  7241:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  7242:                update</strong></span>.</p></dd>
                   7243: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7244: <dd><p>Allows you to disable recursion and hardcode
                   7245:                the target for packages.  The default is
1.23      wiz      7246:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  7247:                facilitating a recursive update of prerequisite
                   7248:                packages.  Only set
                   7249:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7250:                disable recursive updates. Use
                   7251:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7252:                set a specific target for each package to be
1.10      hubertf  7253:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  7254:                (see above).</p></dd>
                   7255: </dl></div>
                   7256: </dd>
                   7257: <dt><span class="term">clean-update</span></dt>
                   7258: <dd>
                   7259: <p>Clean the source tree for all packages that would
1.10      hubertf  7260:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  7261:          from the current directory.  This target should not be
                   7262:          used if the current package (or any of its depending
                   7263:          packages) have already been de-installed (e.g., after
1.10      hubertf  7264:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  7265:          some packages you intended to update. As a rule of
                   7266:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  7267:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  7268:          and only if you have a dirty package tree (e.g., if you
                   7269:          used <code class="varname">NOCLEAN</code>).</p>
                   7270: <p>If you are unsure about whether your tree is
1.10      hubertf  7271:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  7272:          clean</strong></span> at the top of the tree, or use the
                   7273:          following sequence of commands from the directory of the
                   7274:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  7275:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  7276:          time, otherwise you lose all the packages you wanted to
                   7277:          update!):</p>
                   7278: <pre class="screen">
                   7279: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7280: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7281: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7282:          </pre>
                   7283: <p>The following variables can be used either on the
1.10      hubertf  7284:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7285:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.1       dsieger  7286: <div class="variablelist"><dl>
                   7287: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  7288: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  7289:                reconstruct the list of directories to update for
1.10      hubertf  7290:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  7291:                update</strong></span> successfully installed all
                   7292:                packages you wanted to update.  Normally, this is
1.10      hubertf  7293:                done automatically on <span class="command"><strong>make
1.1       dsieger  7294:                update</strong></span>, but may have been suppressed by
                   7295:                the <code class="varname">NOCLEAN</code> variable (see
                   7296:                above).</p></dd>
                   7297: </dl></div>
                   7298: </dd>
                   7299: <dt><span class="term">replace</span></dt>
                   7300: <dd>
                   7301: <p>Update the installation of the current package.  This
                   7302:          differs from update in that it does not replace dependent
                   7303:          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
                   7304:          target to work.</p>
                   7305: <p><span class="emphasis"><em>Be careful when using this
                   7306:          target!</em></span> There are no guarantees that dependent
                   7307:          packages will still work, in particular they will most
1.10      hubertf  7308:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  7309:          library package whose shared library major version changed
                   7310:          between your installed version and the new one.  For this
                   7311:          reason, this target is not officially supported and only
                   7312:          recommended for advanced users.</p>
                   7313: </dd>
                   7314: <dt><span class="term">info</span></dt>
1.29      dholland 7315: <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  7316:          package. You can use this to check which version of a
                   7317:          package is installed.</p></dd>
                   7318: <dt><span class="term">index</span></dt>
                   7319: <dd>
                   7320: <p>This is a top-level command, i.e. it should be used in
                   7321:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7322:          database of all packages in the local pkgsrc tree, including
                   7323:          dependencies, comment, maintainer, and some other useful
                   7324:          information.  Individual entries are created by running
1.10      hubertf  7325:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  7326:          directories.  This index file is saved as
                   7327:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  7328:          verbose format by running <span class="command"><strong>make
1.1       dsieger  7329:          print-index</strong></span>.  You can search in it with
1.10      hubertf  7330:          <span class="command"><strong>make search
1.1       dsieger  7331:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7332:          extract a list of all packages that depend on a particular
1.10      hubertf  7333:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  7334:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7335: <p>Running this command takes a very long time, some
                   7336:          hours even on fast machines!</p>
                   7337: </dd>
                   7338: <dt><span class="term">readme</span></dt>
                   7339: <dd>
                   7340: <p>This target generates a
                   7341:          <code class="filename">README.html</code> file, which can be
                   7342:          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
                   7343:          contain references to any packages which are in the
                   7344:          <code class="varname">PACKAGES</code> directory on the local
                   7345:          host. The generated files can be made to refer to URLs
                   7346:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7347:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7348:          wanted to generate <code class="filename">README.html</code>
                   7349:          files which pointed to binary packages on the local
                   7350:          machine, in the directory
                   7351:          <code class="filename">/usr/packages</code>, set
                   7352:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7353:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7354:          <code class="varname">${PACKAGES}</code> directory and its
                   7355:          subdirectories will be searched for all the binary
                   7356:          packages.</p>
                   7357: <p>The target can be run at the toplevel or in category
                   7358:          directories, in which case it descends recursively.</p>
                   7359: </dd>
                   7360: <dt><span class="term">readme-all</span></dt>
                   7361: <dd><p>This is a top-level command, run it in
                   7362:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7363:          file <code class="filename">README-all.html</code> which contains a
                   7364:          list of all packages currently available in the NetBSD
                   7365:          Packages Collection, together with the category they belong
                   7366:          to and a short description. This file is compiled from the
                   7367:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  7368:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  7369:          readme</strong></span>.</p></dd>
                   7370: <dt><span class="term">cdrom-readme</span></dt>
                   7371: <dd><p>This is very much the same as the
1.23      wiz      7372:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  7373:          used when generating a pkgsrc tree to be written to a
                   7374:          CD-ROM.  This target also produces
                   7375:          <code class="filename">README.html</code> files, and can be made
                   7376:          to refer to URLs based on
                   7377:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7378:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7379: <dt><span class="term">show-distfiles</span></dt>
                   7380: <dd><p>This target shows which distfiles and patchfiles
                   7381:          are needed to build the package
                   7382:          (<code class="varname">ALLFILES</code>, which contains all
                   7383:          <code class="varname">DISTFILES</code> and
                   7384:          <code class="varname">PATCHFILES</code>, but not
                   7385:          <code class="filename">patches/*</code>).</p></dd>
                   7386: <dt><span class="term">show-downlevel</span></dt>
                   7387: <dd><p>This target shows nothing if the package is not
                   7388:          installed. If a version of this package is installed,
                   7389:          but is not the version provided in this version of
                   7390:          pkgsrc, then a warning message is displayed. This target
                   7391:          can be used to show which of your installed packages are
                   7392:          downlevel, and so the old versions can be deleted, and
                   7393:          the current ones added.</p></dd>
                   7394: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7395: <dd><p>This target shows the directory in the pkgsrc
                   7396:          hierarchy from which the package can be built and
                   7397:          installed. This may not be the same directory as the one
                   7398:          from which the package was installed. This target is
                   7399:          intended to be used by people who may wish to upgrade
                   7400:          many packages on a single host, and can be invoked from
                   7401:          the top-level pkgsrc Makefile by using the
1.23      wiz      7402:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  7403: <dt><span class="term">show-installed-depends</span></dt>
                   7404: <dd><p>This target shows which installed packages match
                   7405:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7406:          if out of date dependencies are causing build
                   7407:          problems.</p></dd>
                   7408: <dt><span class="term">check-shlibs</span></dt>
                   7409: <dd><p>After a package is installed, check all its
                   7410:          binaries and (on ELF platforms) shared libraries to see
                   7411:          if they find the shared libs they need.  Run by default
1.10      hubertf  7412:          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  7413: <dt><span class="term">print-PLIST</span></dt>
                   7414: <dd>
1.23      wiz      7415: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  7416:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  7417:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  7418:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7419:          to care for shared libs etc., but it is
                   7420:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7421:          result before putting it into
                   7422:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7423:          diff the output of this command against an already
                   7424:          existing <code class="filename">PLIST</code> file.</p>
1.29      dholland 7425: <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  7426:          other methods that don't update file access times, be
                   7427:          sure to add these files manually to your
1.23      wiz      7428:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7429:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  7430:          them!</p>
1.23      wiz      7431: <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  7432:          information on this target.</p>
                   7433: </dd>
                   7434: <dt><span class="term">bulk-package</span></dt>
                   7435: <dd>
                   7436: <p>Used to do bulk builds. If an appropriate binary
                   7437:          package already exists, no action is taken. If not, this
                   7438:          target will compile, install and package it (and its
                   7439:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10      hubertf  7440:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7441:          After creating the binary package, the sources, the
                   7442:          just-installed package and its required packages are
                   7443:          removed, preserving free disk space.</p>
                   7444: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7445:          all packages installed on a system!</em></span></p>
                   7446: </dd>
                   7447: <dt><span class="term">bulk-install</span></dt>
                   7448: <dd>
                   7449: <p>Used during bulk-installs to install required
                   7450:          packages. If an up-to-date binary package is available,
1.29      dholland 7451:          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  7452:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  7453:          but the installed binary won't be removed.</p>
                   7454: <p>A binary package is considered
1.23      wiz      7455:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.29      dholland 7456:          <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      7457: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7458: <li class="listitem"><p>None of the package's files
1.1       dsieger  7459:              (<code class="filename">Makefile</code>, ...) were modified
                   7460:              since it was built.</p></li>
1.23      wiz      7461: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  7462:              packages were modified since it was built.</p></li>
                   7463: </ul></div>
                   7464: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7465:          all packages installed on a system!</em></span></p>
                   7466: </dd>
                   7467: </dl></div>
                   7468: </div>
                   7469: </div>
1.23      wiz      7470: <div class="chapter" title="Chapter 18. Tools needed for building or running">
1.1       dsieger  7471: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7472: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7473: <div class="toc">
                   7474: <p><b>Table of Contents</b></p>
                   7475: <dl>
1.6       rillig   7476: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7477: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7478: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7479: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7480: </dl>
                   7481: </div>
                   7482: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7483: by pkgsrc and also for individual packages to define what commands
                   7484: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7485: or for later run-time of an installed packaged (such as
                   7486: <code class="varname">DEPENDS</code>).
                   7487: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7488: package will not be used.</p>
                   7489: <p>When building a package, the replacement tools are
                   7490: made available in a directory (as symlinks or wrapper scripts)
                   7491: that is early in the executable search path. Just like the buildlink
                   7492: system, this helps with consistent builds.</p>
                   7493: <p>A tool may be needed to help build a specific package. For example,
                   7494: perl, GNU make (gmake) or yacc may be needed.</p>
                   7495: <p>Also a tool may be needed, for example, because the native system's supplied
                   7496: tool may be inefficient for building a package with pkgsrc.
                   7497: For example, a package may need GNU awk, bison (instead of
                   7498: yacc) or a better sed.</p>
                   7499: <p>The tools used by a package can be listed by running
1.10      hubertf  7500: <span class="command"><strong>make show-tools</strong></span>.</p>
1.23      wiz      7501: <div class="sect1" title="18.1. Tools for pkgsrc builds">
1.1       dsieger  7502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7503: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7504: <p>The default set of tools used by pkgsrc is defined in
                   7505: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  7506: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7507: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  7508: These can be seen by running:
1.10      hubertf  7509: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  7510: <p>If a package needs a specific program to build
                   7511: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7512: to define the tools needed.</p>
                   7513: </div>
1.23      wiz      7514: <div class="sect1" title="18.2. Tools needed by packages">
1.1       dsieger  7515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7516: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      7517: <p>In the following examples, the :run means that it is needed at
                   7518: run-time (and becomes a DEPENDS).
1.1       dsieger  7519: The default is a build dependency which can be set with
                   7520: :build. (So in this example, it is the same as gmake:build
                   7521: and pkg-config:build.)</p>
                   7522: <pre class="programlisting">
                   7523: USE_TOOLS+=     gmake perl:run pkg-config
                   7524: </pre>
                   7525: <p>When using the tools framework, a
                   7526: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7527: which contains the full path to the appropriate tool. For example,
1.23      wiz      7528: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  7529: on Linux systems.</p>
                   7530: <p>If you always need a pkgsrc version of the
                   7531: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7532: </p>
                   7533: </div>
1.23      wiz      7534: <div class="sect1" title="18.3. Tools provided by platforms">
1.1       dsieger  7535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7536: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7537: <p>When improving or porting pkgsrc to a new platform, have a look
                   7538: at (or create) the corresponding platform specific make file fragment under
                   7539: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7540: the name of the common tools. For example:</p>
                   7541: <pre class="programlisting">
                   7542: .if exists(/usr/bin/bzcat)
                   7543: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7544: .elif exists(/usr/bin/bzip2)
                   7545: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7546: .endif
                   7547: 
                   7548: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7549: </pre>
                   7550: </div>
1.23      wiz      7551: <div class="sect1" title="18.4. Questions regarding the tools">
1.1       dsieger  7552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7553: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.23      wiz      7554: <div class="qandaset" title="Frequently Asked Questions">
1.30    ! wiz      7555: <a name="id1168229295927"></a><dl>
1.6       rillig   7556: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7557: </dt>
1.6       rillig   7558: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7559:        tools?</a>
                   7560: </dt>
1.6       rillig   7561: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7562:        package is using while being built? I want to know whether it
                   7563:        uses sed or not.</a>
                   7564: </dt>
                   7565: </dl>
1.23      wiz      7566: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  7567: <col align="left" width="1%">
1.23      wiz      7568: <col>
1.1       dsieger  7569: <tbody>
1.23      wiz      7570: <tr class="question" title="18.4.1.">
1.1       dsieger  7571: <td align="left" valign="top">
1.30    ! wiz      7572: <a name="tools.new"></a><a name="id1168229295930"></a><p><b>18.4.1.</b></p>
1.1       dsieger  7573: </td>
                   7574: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7575: </tr>
                   7576: <tr class="answer">
                   7577: <td align="left" valign="top"></td>
                   7578: <td align="left" valign="top"><p>TODO</p></td>
                   7579: </tr>
1.23      wiz      7580: <tr class="question" title="18.4.2.">
1.1       dsieger  7581: <td align="left" valign="top">
1.30    ! wiz      7582: <a name="tools.listall"></a><a name="id1168229295939"></a><p><b>18.4.2.</b></p>
1.1       dsieger  7583: </td>
                   7584: <td align="left" valign="top"><p>How do I get a list of all available
                   7585:        tools?</p></td>
                   7586: </tr>
                   7587: <tr class="answer">
                   7588: <td align="left" valign="top"></td>
                   7589: <td align="left" valign="top"><p>TODO</p></td>
                   7590: </tr>
1.23      wiz      7591: <tr class="question" title="18.4.3.">
1.1       dsieger  7592: <td align="left" valign="top">
1.30    ! wiz      7593: <a name="tools.used"></a><a name="id1168229295947"></a><p><b>18.4.3.</b></p>
1.1       dsieger  7594: </td>
                   7595: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7596:        package is using while being built? I want to know whether it
                   7597:        uses sed or not.</p></td>
                   7598: </tr>
                   7599: <tr class="answer">
                   7600: <td align="left" valign="top"></td>
                   7601: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7602:        to do it.)</p></td>
                   7603: </tr>
                   7604: </tbody>
                   7605: </table>
                   7606: </div>
                   7607: </div>
                   7608: </div>
1.23      wiz      7609: <div class="chapter" title="Chapter 19. Making your package work">
1.1       dsieger  7610: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7611: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7612: <div class="toc">
                   7613: <p><b>Table of Contents</b></p>
                   7614: <dl>
1.6       rillig   7615: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7616: <dd><dl>
1.6       rillig   7617: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      7618: <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   7619: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7620: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7621: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7622: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7623: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7624: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7625: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7626: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7627: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7628: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7629: </dl></dd>
1.23      wiz      7630: <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   7631: <dd><dl>
                   7632: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7633: <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>
                   7634: </dl></dd>
1.23      wiz      7635: <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   7636: <dd><dl>
                   7637: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7638: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7639: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7640: </dl></dd>
                   7641: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7642: <dd><dl>
                   7643: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7644: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7645: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7646: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7647: </dl></dd>
1.23      wiz      7648: <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   7649: <dd><dl>
                   7650: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7651: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      7652: <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   7653: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7654: </dl></dd>
1.23      wiz      7655: <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   7656: <dd><dl>
                   7657: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7658: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7659: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7660: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7661: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7662: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7663: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7664: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7665: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      7666: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   7667: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7668: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7669: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7670: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7671: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7672: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7673: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7674: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7675:     emulation</a></span></dt>
1.6       rillig   7676: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7677: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7678: </dl></dd>
1.6       rillig   7679: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7680: </dl>
                   7681: </div>
1.23      wiz      7682: <div class="sect1" title="19.1. General operation">
1.1       dsieger  7683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7684: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.23      wiz      7685: <div class="sect2" title="19.1.1. Portability of packages">
1.1       dsieger  7686: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7687: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7688: <p>One appealing feature of pkgsrc is that it runs on many
                   7689:     different platforms. As a result, it is important to ensure,
                   7690:     where possible, that packages in pkgsrc are portable. This
                   7691:     chapter mentions some particular details you should pay
                   7692:     attention to while working on pkgsrc.</p>
                   7693: </div>
1.23      wiz      7694: <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
1.1       dsieger  7695: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  7696: <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  7697: </h3></div></div></div>
                   7698: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7699:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7700:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7701:     want to use those variables in the preprocessor directives of
1.29      dholland 7702:     <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  7703:     <code class="literal">.for</code>), you need to include the file
                   7704:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7705:     loads the user preferences.</p>
                   7706: <p>But note that some variables may not be completely defined
                   7707:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7708:     included, as they may contain references to variables that are
                   7709:     not yet defined. In shell commands this is no problem, since
                   7710:     variables are actually macros, which are only expanded when they
                   7711:     are used. But in the preprocessor directives mentioned above and
                   7712:     in dependency lines (of the form <code class="literal">target:
                   7713:     dependencies</code>) the variables are expanded at load
                   7714:     time.</p>
1.23      wiz      7715: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7716: <h3 class="title">Note</h3>
                   7717: <p>Currently there is no exhaustive list of all
                   7718:     variables that tells you whether they can be used at load time
                   7719:     or only at run time, but it is in preparation.</p>
                   7720: </div>
                   7721: </div>
1.23      wiz      7722: <div class="sect2" title="19.1.3. User interaction">
1.1       dsieger  7723: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7724: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7725: <p>Occasionally, packages require interaction from the user,
                   7726:     and this can be in a number of ways:</p>
1.23      wiz      7727: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7728: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7729:        interaction such as entering username/password or accepting a
                   7730:        license on a web page.</p></li>
1.23      wiz      7731: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7732:        passwords.</p></li>
1.23      wiz      7733: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7734: <li class="listitem"><p>help during the build process</p></li>
                   7735: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7736: </ul></div>
                   7737: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7738:     provided to notify the pkgsrc mechanism of an interactive stage
                   7739:     which will be needed, and this should be set in the package's
                   7740:     <code class="filename">Makefile</code>, e.g.:</p>
                   7741: <pre class="programlisting">
                   7742: INTERACTIVE_STAGE=      build
                   7743:     </pre>
                   7744: <p>Multiple interactive stages can be specified:</p>
                   7745: <pre class="programlisting">
                   7746: INTERACTIVE_STAGE=      configure install
                   7747:     </pre>
                   7748: <p>The user can then decide to skip this package by setting the
                   7749:     <code class="varname">BATCH</code> variable.</p>
                   7750: </div>
1.23      wiz      7751: <div class="sect2" title="19.1.4. Handling licenses">
1.1       dsieger  7752: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7753: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7754: <p>Authors of software can choose the licence under which
                   7755:     software can be copied.  This is due to copyright law, and reasons
                   7756:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7757:     system recognizes that there are a number of licenses which some
                   7758:     users may find objectionable or difficult or impossible to comply
                   7759:     with.  The Free Software Foundation has declared some licenses
                   7760:     "Free", and the Open Source Initiative has a definition of "Open
                   7761:     Source".  The pkgsrc system, as a policy choice, does not label
                   7762:     packages which have licenses that are Free or Open Source.
                   7763:     However, packages without a license meeting either of those tests
                   7764:     are labeled with a license tag denoting the license.  Note that a
                   7765:     package with no license to copy trivially does not meet either the
                   7766:     Free or Open Source test.</p>
                   7767: <p>For packages which are not Free or Open Source, pkgsrc will
                   7768:     not build the package unless the user has indicated to pkgsrc that
                   7769:     packages with that particular license may be built.  Note that
                   7770:     this documentation avoids the term "accepted the license".  The
                   7771:     pkgsrc system is merely providing a mechanism to avoid
                   7772:     accidentally building a package with a non-free license;
                   7773:     judgement and responsibility remain with the user.  (Installation
                   7774:     of binary packages are not currently subject to this mechanism;
                   7775:     this is a bug.)</p>
                   7776: <p>One might want to only install packages with a BSD license,
1.19      jnemeth  7777:     or the GPL, and not the other.  The free licenses are added to the 
                   7778:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7779:     user can override the default by setting the
                   7780:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7781:     of "+=".  The licenses accepted by default are:
                   7782:     </p>
                   7783: <pre class="programlisting">
                   7784:     public-domain
                   7785:     gnu-gpl-v2 gnu-lgpl-v2
                   7786:     gnu-gpl-v3 gnu-lgpl-v3
                   7787:     original-bsd modified-bsd
                   7788:     x11
                   7789:     apache-2.0
                   7790:     cddl-1.0
                   7791:     open-font-license
                   7792:     </pre>
                   7793: <p>
                   7794:     </p>
1.1       dsieger  7795: <p>The license tag mechanism is intended to address
                   7796:     copyright-related issues surrounding building, installing and
                   7797:     using a package, and not to address redistribution issues (see
                   7798:     <code class="varname">RESTRICTED</code> and
1.19      jnemeth  7799:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7800:     Packages with redistribution restrictions should set these
                   7801:     tags.</p>
1.1       dsieger  7802: <p>Denoting that a package may be copied according to a
                   7803:     particular license is done by placing the license in
                   7804:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7805:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7806:     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>
                   7807: <pre class="programlisting">
                   7808: LICENSE=        xv-license
                   7809:     </pre>
                   7810: <p>When trying to build, the user will get a notice that the
                   7811:     package is covered by a license which has not been placed in the
                   7812:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7813: <pre class="programlisting">
                   7814: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7815: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7816: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7817: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7818: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7819: *** Error code 1
                   7820:     </pre>
1.10      hubertf  7821: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7822:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7823:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7824:     convey to pkgsrc that it should not in the future fail because of
                   7825:     that license:</p>
                   7826: <pre class="programlisting">
                   7827: ACCEPTABLE_LICENSES+=xv-license
                   7828:     </pre>
                   7829: <p>When adding a package with a new license, the license text
                   7830:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7831:     displaying.  A list of known licenses can be seen in this
                   7832:     directory.</p>
                   7833: <p>When the license changes (in a way other than formatting),
                   7834:     please make sure that the new license has a different name (e.g.,
                   7835:     append the version number if it exists, or the date).  Just
                   7836:     because a user told pkgsrc to build programs under a previous
                   7837:     version of a license does not mean that pkgsrc should build
                   7838:     programs under the new licenses.  The higher-level point is that
                   7839:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7840:     test is a mechanistic test of whether a particular text has been
                   7841:     approved by either of two bodies.</p>
                   7842: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7843:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7844:     is deprecated because it does not crisply refer to a particular
                   7845:     license text.  Another problem with such usage is that it does not
                   7846:     enable a user to tell pkgsrc to proceed for a single package
                   7847:     without also telling pkgsrc to proceed for all packages with that
                   7848:     tag.</p>
                   7849: </div>
1.23      wiz      7850: <div class="sect2" title="19.1.5. Restricted packages">
1.1       dsieger  7851: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7852: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7853: <p>Some licenses restrict how software may be re-distributed.
                   7854:     Because a license tag is required unless the package is Free or
                   7855:     Open Source, all packages with restrictions should have license
                   7856:     tags.  By declaring the restrictions, package tools can
                   7857:     automatically refrain from e.g. placing binary packages on FTP
                   7858:     sites.</p>
                   7859: <p>There are four restrictions that may be encoded, which are
                   7860:     the cross product of sources (distfiles) and binaries not being
                   7861:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7862:     language in any license, and because non-Free licenses tend to be
                   7863:     different from each other, pkgsrc adopts a definition of FTP and
                   7864:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7865:     should not be made available over the Internet at no charge.
                   7866:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7867:     made available on some kind of media, together with other source
                   7868:     and binary packages, and which is sold for a distribution charge.
                   7869:     </p>
                   7870: <p>In order to encode these restrictions, the package system
                   7871:     defines five make variables that can be set to note these
                   7872:     restrictions:</p>
1.23      wiz      7873: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7874: <li class="listitem">
1.1       dsieger  7875: <p><code class="varname">RESTRICTED</code></p>
                   7876: <p>This variable should be set whenever a restriction
                   7877:        exists (regardless of its kind).  Set this variable to a
                   7878:        string containing the reason for the restriction.  It should
                   7879:        be understood that those wanting to understand the restriction
                   7880:        will have to read the license, and perhaps seek advice of
                   7881:        counsel.</p>
                   7882: </li>
1.23      wiz      7883: <li class="listitem">
1.1       dsieger  7884: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7885: <p>Binaries may not be placed on CD-ROM containing other
                   7886:        binary packages, for which a distribution charge may be made.
                   7887:        In this case, set this variable to
                   7888:        <code class="varname">${RESTRICTED}</code>.</p>
                   7889: </li>
1.23      wiz      7890: <li class="listitem">
1.1       dsieger  7891: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7892: <p>Binaries may not made available on the Internet without
                   7893:        charge.  In this case, set this variable to
                   7894:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7895:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7896: </li>
1.23      wiz      7897: <li class="listitem">
1.1       dsieger  7898: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7899: <p>Distfiles may not be placed on CD-ROM, together with
                   7900:        other distfiles, for which a fee may be charged.  In this
                   7901:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7902:        </p>
                   7903: </li>
1.23      wiz      7904: <li class="listitem">
1.1       dsieger  7905: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7906: <p>Distfiles may not made available via FTP at no charge.
                   7907:        In this case, set this variable to
                   7908:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7909:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7910: </li>
                   7911: </ul></div>
                   7912: </div>
1.23      wiz      7913: <div class="sect2" title="19.1.6. Handling dependencies">
1.1       dsieger  7914: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7915: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  7916: <p>Your package may depend on some other package being present
                   7917:     - and there are various ways of expressing this dependency.
                   7918:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7919:     <code class="varname">DEPENDS</code> definitions, the
                   7920:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7921:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7922:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  7923:     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  7924: <p>The basic difference between the two variables is as
                   7925:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7926:     that pre-requisite in the binary package so it will be pulled in
                   7927:     when the binary package is later installed, whilst the
                   7928:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7929:     dependency that is only needed for building the package.</p>
                   7930: <p>This means that if you only need a package present whilst
                   7931:     you are building, it should be noted as a
                   7932:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7933: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7934:     <code class="varname">DEPENDS</code> definition is:</p>
                   7935: <pre class="programlisting">
                   7936: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7937:     </pre>
1.23      wiz      7938: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7939:     may include any of the wildcard version numbers recognized by
1.29      dholland 7940:     <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      7941: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7942: <li class="listitem">
1.1       dsieger  7943: <p>If your package needs another package's binaries or
                   7944:        libraries to build or run, and if that package has a
                   7945:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7946: <pre class="programlisting">
                   7947: .include "../../graphics/jpeg/buildlink3.mk"
                   7948:        </pre>
                   7949: </li>
1.23      wiz      7950: <li class="listitem">
1.25      spz      7951: <p>If your package needs binaries from another package to build,
                   7952:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1       dsieger  7953: <pre class="programlisting">
1.25      spz      7954: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1       dsieger  7955:        </pre>
                   7956: </li>
1.25      spz      7957: <li class="listitem"><p>If your package needs a library with which to link and
                   7958:        there is no <code class="filename">buildlink3.mk</code> file
                   7959:        available, create one. Using
                   7960:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7961:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7962: <li class="listitem">
1.25      spz      7963: <p>If your package needs some executable to be able to run
                   7964:        correctly and if there's no
                   7965:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7966:        using the <code class="varname">DEPENDS</code> variable. The
                   7967:        <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
                   7968:        be able to execute the latex binary from the teTeX package
                   7969:        when it runs, and that is specified:</p>
1.1       dsieger  7970: <pre class="programlisting">
1.25      spz      7971: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.1       dsieger  7972:        </pre>
1.25      spz      7973: </li>
                   7974: <li class="listitem">
                   7975: <p>You can use wildcards in package dependencies. Note that
                   7976:        such wildcard dependencies are retained when creating binary
                   7977:        packages. The dependency is checked when installing the binary
                   7978:        package and any package which matches the pattern will be
                   7979:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7980: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7981:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7982:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7983:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7984: <p>Wildcards can also be used to specify that a package
                   7985:        will only build against a certain minimum version of a
                   7986:        pre-requisite:</p>
                   7987: <pre class="programlisting">
1.25      spz      7988: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.1       dsieger  7989:        </pre>
1.25      spz      7990: <p>This means that the package will build using version 6.0
                   7991:        of ImageMagick or newer. Such a dependency may be warranted
                   7992:        if, for example, the command line options of an executable
                   7993:        have changed.</p>
                   7994: <p>If you need to depend on minimum versions of libraries,
                   7995:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  7996: <p>For security fixes, please update the package
1.10      hubertf  7997:        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  7998:        information.</p>
                   7999: </li>
                   8000: </ol></div>
                   8001: <p>If your package needs files from another package to build,
                   8002:     add the relevant distribution files to
                   8003:     <code class="varname">DISTFILES</code>, so they will be extracted
                   8004:     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.
                   8005:     (It relies on the jpeg sources being present in source form
                   8006:     during the build.)</p>
                   8007: </div>
1.23      wiz      8008: <div class="sect2" title="19.1.7. Handling conflicts with other packages">
1.1       dsieger  8009: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8010: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  8011: <p>Your package may conflict with other packages a user might
                   8012:     already have installed on his system, e.g. if your package
                   8013:     installs the same set of files as another package in the pkgsrc
                   8014:     tree.</p>
                   8015: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   8016:     space-separated list of packages (including version string) your
                   8017:     package conflicts with.</p>
                   8018: <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>
                   8019:     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>
                   8020:     install the same shared library, thus you set in
                   8021:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8022: <pre class="programlisting">
                   8023: CONFLICTS=      Xaw-Xpm-[0-9]*
                   8024:     </pre>
                   8025: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   8026: <pre class="programlisting">
                   8027: CONFLICTS=      Xaw3d-[0-9]*
                   8028:     </pre>
                   8029: <p>Packages will automatically conflict with other packages
                   8030:     with the name prefix and a different version
1.23      wiz      8031:     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
                   8032:     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
1.1       dsieger  8033: </div>
1.23      wiz      8034: <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
1.1       dsieger  8035: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8036: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  8037: <p>There are several reasons why a package might be
                   8038:     instructed to not build under certain circumstances.  If the
                   8039:     package builds and runs on most platforms, the exceptions
                   8040:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8041:     the package builds and runs on a small handful of platforms,
                   8042:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8043:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8044:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8045:     (OS-version-platform) that can use glob-style
                   8046:     wildcards.</p>
                   8047: <p>Some packages are tightly bound to a specific version of an
                   8048:     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
                   8049:     backwards compatible with other versions of the OS, and should be
                   8050:     uploaded to a version specific directory on the FTP server.  Mark
                   8051:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      8052:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  8053:     the package system internals, but may be used in the
                   8054:     future.</p>
                   8055: <p>If the package should be skipped (for example, because it
                   8056:     provides functionality already provided by the system), set
                   8057:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8058:     the package should fail because some preconditions are not met,
                   8059:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   8060:     message.</p>
                   8061: </div>
1.23      wiz      8062: <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
1.1       dsieger  8063: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8064: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  8065: <p>To ensure that a package may not be deleted, once it has been
                   8066:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8067:     be set in the package Makefile. This will be carried into any
                   8068:     binary package that is made from this pkgsrc entry. A
1.23      wiz      8069:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.29      dholland 8070:     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      8071:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  8072: </div>
1.23      wiz      8073: <div class="sect2" title="19.1.10. Handling packages with security problems">
1.1       dsieger  8074: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8075: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  8076: <p>When a vulnerability is found, this should be noted in
                   8077:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.10      hubertf  8078:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.1       dsieger  8079:     in the same directory to update the file on ftp.NetBSD.org.</p>
                   8080: <p>After fixing the vulnerability by a patch, its
                   8081:     <code class="varname">PKGREVISION</code> should be increased (this
                   8082:     is of course not necessary if the problem is fixed by using
                   8083:     a newer release of the software).</p>
                   8084: <p>Also, if the fix should be applied to the stable pkgsrc
                   8085:     branch, be sure to submit a pullup request!</p>
                   8086: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8087:     semi-automatically by a weekly cron job.</p>
                   8088: </div>
1.23      wiz      8089: <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
1.1       dsieger  8090: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8091: <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  8092: <p>When making fixes to an existing package it can be useful
                   8093:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8094:     avoid conflicting with future versions by the original author, a
1.23      wiz      8095:     <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  8096:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      8097:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8098:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  8099: <pre class="programlisting">
                   8100: DISTNAME=       foo-17.42
                   8101: PKGREVISION=    9
                   8102:     </pre>
                   8103: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      8104:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8105:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  8106:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8107:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8108: <p>When a new release of the package is released, the
                   8109:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8110:     minor release of the above package, things should be like:</p>
                   8111: <pre class="programlisting">
                   8112: DISTNAME=       foo-17.43
                   8113:     </pre>
                   8114: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8115:     non-trivial change in the resulting binary package.  Without a
                   8116:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8117:     version installed has no way of knowing that their package is out
                   8118:     of date.  Thus, changes without increasing
                   8119:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8120:     trivial that no reasonable person would want to upgrade", and this
                   8121:     is the rough test for when increasing
                   8122:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8123:     changes that do not merit increasing
                   8124:     <code class="varname">PKGREVISION</code> are:</p>
1.23      wiz      8125: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8126: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 8127:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  8128:       or comments in Makefile.</p></li>
1.23      wiz      8129: <li class="listitem"><p>
1.1       dsieger  8130:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      8131: <li class="listitem"><p>
1.1       dsieger  8132:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      8133: <li class="listitem"><p>
1.1       dsieger  8134:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8135: </ul></div>
                   8136: <p>Examples of changes that do merit an increase to
                   8137:     <code class="varname">PKGREVISION</code> include:</p>
1.23      wiz      8138: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8139: <li class="listitem"><p>
1.1       dsieger  8140:       Security fixes</p></li>
1.23      wiz      8141: <li class="listitem"><p>
1.1       dsieger  8142:       Changes or additions to a patch file</p></li>
1.23      wiz      8143: <li class="listitem"><p>
1.1       dsieger  8144:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      8145: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  8146: </ul></div>
                   8147: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8148:     changes.</p>
                   8149: </div>
1.23      wiz      8150: <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
1.1       dsieger  8151: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8152: <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  8153: <p>When you want to replace the same text in multiple files
                   8154:     or when the replacement text varies, patches alone cannot help.
                   8155:     This is where the SUBST framework comes in. It provides an
                   8156:     easy-to-use interface for replacing text in files.
                   8157:     Example:</p>
                   8158: <pre class="programlisting">
                   8159: SUBST_CLASSES+=                 fix-paths
                   8160: SUBST_STAGE.fix-paths=          pre-configure
                   8161: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8162: SUBST_FILES.fix-paths=          src/*.c
                   8163: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8164: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8165: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8166:     </pre>
                   8167: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8168:     that are used to identify the different SUBST blocks that are
                   8169:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8170:     important to always use the <code class="literal">+=</code> operator with
                   8171:     this variable. Otherwise some substitutions may be
                   8172:     skipped.</p>
                   8173: <p>The remaining variables of each SUBST block are
                   8174:     parameterized with the identifier from the first line
                   8175:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8176:     parameters to a function call.</p>
                   8177: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8178:     which the replacement will take place. All combinations of
                   8179:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8180:     <code class="literal">post-</code> together with a phase name are
                   8181:     possible, though only few are actually used. Most commonly used
                   8182:     are <code class="literal">post-patch</code> and
                   8183:     <code class="literal">pre-configure</code>. Of these two,
                   8184:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  8185:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  8186:     have the state after applying the patches but before making any
                   8187:     other changes. This is especially useful when you are debugging
                   8188:     a package in order to create new patches for it. Similarly,
                   8189:     <code class="literal">post-build</code> is preferred over
                   8190:     <code class="literal">pre-install</code>, because the install phase should
                   8191:     generally be kept as simple as possible. When you use
                   8192:     <code class="literal">post-build</code>, you have the same files in the
                   8193:     working directory that will be installed later, so you can check
                   8194:     if the substitution has succeeded.</p>
                   8195: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8196:     that is printed just before the substitution is done.</p>
                   8197: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8198:     globbing patterns that specifies the files in which the
                   8199:     substitution will take place. The patterns are interpreted
                   8200:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8201: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29      dholland 8202:     <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  8203:     command should be prefixed with <code class="literal">-e</code>, so that
                   8204:     all SUBST blocks look uniform.</p>
                   8205: <p>There are some more variables, but they are so seldomly
                   8206:     used that they are only documented in the
                   8207:     <code class="filename">mk/subst.mk</code> file.</p>
                   8208: </div>
                   8209: </div>
1.23      wiz      8210: <div class="sect1" title="19.2. Fixing problems in the fetch phase">
1.1       dsieger  8211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8212: <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      8213: <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
1.1       dsieger  8214: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8215: <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  8216: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8217:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8218:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8219:     with the name of each file to download as an argument, expecting
                   8220:     it to output the URL of the directory from which to download
                   8221:     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
                   8222:     example of this usage.</p>
                   8223: <p>If the download can't be automated, because the user must
                   8224:     submit personal information to apply for a password, or must pay
                   8225:     for the source, or whatever, you can set
                   8226:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8227:     displayed to the user before aborting the build. Example:</p>
                   8228: <pre class="programlisting">
                   8229: FETCH_MESSAGE=  "Please download the files"
                   8230: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8231: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8232:     </pre>
                   8233: </div>
1.23      wiz      8234: <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
1.1       dsieger  8235: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8236: <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  8237: <p>Sometimes authors of a software package make some
                   8238:     modifications after the software was released, and they put up a
                   8239:     new distfile without changing the package's version number. If a
                   8240:     package is already in pkgsrc at that time, the checksum will
                   8241:     no longer match. The contents of the new distfile should be
                   8242:     compared against the old one before changing anything, to make
                   8243:     sure the distfile was really updated on purpose, and that
                   8244:     no trojan horse or so crept in.
                   8245:     Please mention that the distfiles were compared and what was found
                   8246:     in your commit message.
                   8247:     Then, the correct way to work around this is to
                   8248:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8249:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8250:     <code class="varname">DISTFILES</code> and
                   8251:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8252:     subdirectory of the local distfiles directory.
1.10      hubertf  8253:     (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  8254:     In case this
                   8255:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8256:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8257:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8258:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8259:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8260:     path in the filenames.
                   8261:     Also increase the PKGREVISION if the installed package is different.
                   8262:     Furthermore, a mail to the package's authors seems appropriate
                   8263:     telling them that changing distfiles after releases without
                   8264:     changing the file names is not good practice.</p>
                   8265: </div>
                   8266: </div>
1.23      wiz      8267: <div class="sect1" title="19.3. Fixing problems in the configure phase">
1.1       dsieger  8268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8269: <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      8270: <div class="sect2" title="19.3.1. Shared libraries - libtool">
1.1       dsieger  8271: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8272: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8273: <p>pkgsrc supports many different machines, with different
                   8274:     object formats like a.out and ELF, and varying abilities to do
                   8275:     shared library and dynamic loading at all. To accompany this,
                   8276:     varying commands and options have to be passed to the
                   8277:     compiler, linker, etc. to get the Right Thing, which can be
                   8278:     pretty annoying especially if you don't have all the machines
                   8279:     at your hand to test things.  The
                   8280:     <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      8281:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8282:     both static and dynamic libraries from a set of source files,
                   8283:     thus being platform-independent.</p>
                   8284: <p>Here's how to use libtool in a package in seven simple
                   8285:     steps:</p>
1.23      wiz      8286: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8287: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8288:        Makefile.</p></li>
1.23      wiz      8289: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8290:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8291:        add it to the definition of <code class="varname">CC</code>, if only
                   8292:        libraries are being built in a given Makefile. This one command
                   8293:        will build both PIC and non-PIC library objects, so you need not
                   8294:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8295: <li class="listitem">
1.1       dsieger  8296: <p>For the linking of the library, remove any
1.23      wiz      8297:        <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
                   8298:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8299: <pre class="programlisting">
                   8300: ${LIBTOOL} --mode=link \
                   8301:     ${CC} -o ${.TARGET:.a=.la} \
                   8302:         ${OBJS:.o=.lo} \
                   8303:         -rpath ${PREFIX}/lib \
                   8304:         -version-info major:minor
                   8305:        </pre>
                   8306: <p>Note that the library is changed to have a
                   8307:        <code class="filename">.la</code> extension, and the objects are
                   8308:        changed to have a <code class="filename">.lo</code>
                   8309:        extension. Change <code class="varname">OBJS</code> as
                   8310:        necessary. This automatically creates all of the
                   8311:        <code class="filename">.a</code>,
                   8312:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8313:        necessary) in the build directory. Be sure to include
1.23      wiz      8314:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8315:        minor are zero, as libtool will otherwise strip off the
                   8316:        shared library version.</p>
                   8317: <p>From the libtool manual:</p>
                   8318: <pre class="programlisting">
                   8319: So, libtool library versions are described by three integers:
                   8320: 
                   8321: CURRENT
                   8322: The most recent interface number that this library implements.
                   8323: 
                   8324: REVISION
                   8325: The implementation number of the CURRENT interface.
                   8326: 
                   8327: AGE
                   8328: The difference between the newest and oldest interfaces that
                   8329: this library implements.  In other words, the library implements
                   8330: all the interface numbers in the range from number `CURRENT -
                   8331: AGE' to `CURRENT'.
                   8332: 
                   8333: If two libraries have identical CURRENT and AGE numbers, then the
                   8334: dynamic linker chooses the library with the greater REVISION number.
                   8335:        </pre>
1.23      wiz      8336: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8337:        different results for a.out and ELF (excluding symlinks)
                   8338:        in only one case. An ELF library of the form
1.23      wiz      8339:        <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  8340:        will have a symlink of
1.23      wiz      8341:        <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  8342:        on an a.out platform. This is handled
                   8343:        automatically.</p>
1.23      wiz      8344: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8345:        directory of the library being built.</p>
                   8346: <p>In the <code class="filename">PLIST</code>, include only the
                   8347:        <code class="filename">.la</code> file, the other files will be
                   8348:        added automatically.</p>
                   8349: </li>
1.23      wiz      8350: <li class="listitem">
1.1       dsieger  8351: <p>When linking shared object (<code class="filename">.so</code>)
1.29      dholland 8352:        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      8353:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8354:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8355:        tacked on.</p>
                   8356: <p>The <code class="filename">PLIST</code> file gets the
                   8357:        <code class="filename">foo.so</code> entry.</p>
                   8358: </li>
1.23      wiz      8359: <li class="listitem">
1.1       dsieger  8360: <p>When linking programs that depend on these libraries
                   8361:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.29      dholland 8362:        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      8363:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8364:        libraries (static or shared), but please be aware that
                   8365:        libtool will not allow you to specify a relative path in
1.23      wiz      8366:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8367:        expects you to change that argument to be the
                   8368:        <code class="filename">.la</code> file. e.g.</p>
                   8369: <pre class="programlisting">
                   8370: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8371:        </pre>
                   8372: <p>should be changed to:</p>
                   8373: <pre class="programlisting">
                   8374: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8375:        </pre>
                   8376: <p>and it will do the right thing with the libraries.</p>
                   8377: </li>
1.23      wiz      8378: <li class="listitem">
1.29      dholland 8379: <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>
                   8380:        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      8381:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8382:        <code class="filename">.la</code>. e.g.</p>
                   8383: <pre class="programlisting">
1.22      jakllsch 8384: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1       dsieger  8385:        </pre>
                   8386: <p>This will install the static <code class="filename">.a</code>,
                   8387:        shared library, any needed symlinks, and run
1.29      dholland 8388:        <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  8389: </li>
1.23      wiz      8390: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8391:        the <code class="filename">.la</code>
                   8392:        file (this is a change from previous behaviour).</p></li>
                   8393: </ol></div>
                   8394: </div>
1.23      wiz      8395: <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
1.1       dsieger  8396: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8397: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8398: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8399:     package Makefile. This will override the package's own libtool
                   8400:     in most cases.  For older libtool using packages,  libtool is
                   8401:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8402:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8403:     configure; find work*/ -name libtool</strong></span>.</p>
                   8404: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8405:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8406:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8407:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8408:     package's libtool script(s), set it as appropriate.</p>
                   8409: <p>If you do not need <code class="filename">*.a</code> static
                   8410:     libraries built and installed, then use
                   8411:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8412: <p>If your package makes use of the platform-independent library
                   8413:     for loading dynamic shared objects, that comes with libtool
                   8414:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8415: <p>Some packages use libtool incorrectly so that the package
                   8416:     may not work or build in some circumstances. Some of the more
                   8417:     common errors are:</p>
1.23      wiz      8418: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8419: <li class="listitem">
1.1       dsieger  8420: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8421:        executable or library. This in itself isn't a problem if one of two things
                   8422:        has been done:</p>
1.23      wiz      8423: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8424: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8425:            <code class="filename">libfoo.la</code>, not
                   8426:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8427: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8428: </ol></div>
                   8429: </li>
1.23      wiz      8430: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8431:        The function lt_dlinit() should be called and the macro
                   8432:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8433:        executables.</p></li>
                   8434: </ul></div>
                   8435: </div>
1.23      wiz      8436: <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
1.1       dsieger  8437: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8438: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8439: <p>If a package needs GNU autoconf or automake to be executed
                   8440:     to regenerate the configure script and Makefile.in makefile
                   8441:     templates, then they should be executed in a pre-configure
                   8442:     target.</p>
                   8443: <p>For packages that need only autoconf:</p>
                   8444: <pre class="programlisting">
                   8445: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8446: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8447: ...
                   8448: 
                   8449: pre-configure:
                   8450:         cd ${WRKSRC} &amp;&amp; autoconf
                   8451: 
                   8452: ...
                   8453:     </pre>
                   8454: <p>and for packages that need automake and autoconf:</p>
                   8455: <pre class="programlisting">
                   8456: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8457: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8458: ...
                   8459: 
                   8460: pre-configure:
                   8461:         set -e; cd ${WRKSRC}; \
                   8462:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8463: 
                   8464: ...
                   8465:     </pre>
                   8466: <p>Packages which use GNU Automake will almost certainly
                   8467:     require GNU Make.</p>
                   8468: <p>There are times when the configure process makes
                   8469:     additional changes to the generated files, which then causes
                   8470:     the build process to try to re-execute the automake sequence.
                   8471:     This is prevented by touching various files in the configure
                   8472:     stage. If this causes problems with your package you can set
                   8473:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8474:     Makefile.</p>
                   8475: </div>
                   8476: </div>
1.23      wiz      8477: <div class="sect1" title="19.4. Programming languages">
1.1       dsieger  8478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8479: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.23      wiz      8480: <div class="sect2" title="19.4.1. C, C++, and Fortran">
1.1       dsieger  8481: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8482: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8483: <p>Compilers for the C, C++, and Fortran languages comes with
                   8484:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8485:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  8486:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8487: <p>To declare which language's compiler a package needs, set
                   8488:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      8489:     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
                   8490:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8491:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8492:     written in C++, usually need a C compiler for the configure
                   8493:     phase.</p>
                   8494: </div>
1.23      wiz      8495: <div class="sect2" title="19.4.2. Java">
1.1       dsieger  8496: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8497: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8498: <p>If a program is written in Java, use the Java framework in
                   8499:     pkgsrc.  The package must include
                   8500:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8501:     provides the following variables:</p>
1.23      wiz      8502: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8503: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8504:       dependency on the JDK is added.  If
1.23      wiz      8505:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8506:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8507:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8508:       JDK.</p></li>
1.23      wiz      8509: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8510:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8511:       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
                   8512:       <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
                   8513:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8514:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8515:       above. This variable is not set by default.</p></li>
1.24      wiz      8516: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8517:       automatically set to the runtime location of the used Java
                   8518:       implementation dependency. It may be used to set
                   8519:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8520:       needs this variable to be defined.
                   8521:       </p></li>
1.1       dsieger  8522: </ul></div>
                   8523: </div>
1.23      wiz      8524: <div class="sect2" title="19.4.3. Packages containing perl scripts">
1.1       dsieger  8525: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8526: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8527: <p>If your package contains interpreted perl scripts, add
1.23      wiz      8528:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8529:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8530:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8531:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8532:     that you want adjusted.  Every occurrence of
                   8533:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8534:     path to the perl executable.</p>
                   8535: <p>If a particular version of perl is needed, set the
                   8536:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8537:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.10      hubertf  8538: <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  8539:     about handling perl modules.</p>
                   8540: </div>
1.23      wiz      8541: <div class="sect2" title="19.4.4. Other programming languages">
1.1       dsieger  8542: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8543: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1       dsieger  8544: <p>Currently, there is no special handling for other languages
                   8545:     in pkgsrc.  If a compiler package provides a
                   8546:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8547:     just add a (build) dependency on the appropriate compiler
                   8548:     package.</p>
                   8549: </div>
                   8550: </div>
1.23      wiz      8551: <div class="sect1" title="19.5. Fixing problems in the build phase">
1.1       dsieger  8552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8553: <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  8554: <p>The most common failures when building a package are that
                   8555:        some platforms do not provide certain header files, functions or
                   8556:        libraries, or they provide the functions in a library that the
                   8557:        original package author didn't know. To work around this, you
                   8558:        can rewrite the source code in most cases so that it does not
                   8559:        use the missing functions or provides a replacement function.</p>
1.23      wiz      8560: <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
1.1       dsieger  8561: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8562: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8563: <p>If a package already comes with a GNU configure script, the
                   8564:        preferred way to fix the build failure is to change the
                   8565:        configure script, not the code. In the other cases, you can
                   8566:        utilize the C preprocessor, which defines certain macros
                   8567:        depending on the operating system and hardware architecture it
                   8568:        compiles for. These macros can be queried using for example
                   8569:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8570:        system, hardware architecture and compiler has its own macro.
                   8571:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8572:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8573:        are all defined, you know that you are using NetBSD on an i386
                   8574:        compatible CPU, and your compiler is GCC.</p>
                   8575: <p>The list of the following macros for hardware and
                   8576:        operating system depends on the compiler that is used. For
                   8577:        example, if you want to conditionally compile code on Solaris,
                   8578:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8579:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.23      wiz      8580: <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
1.1       dsieger  8581: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8582: <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  8583: <p>To distinguish between 4.4 BSD-derived systems and the
                   8584:         rest of the world, you should use the following code.</p>
                   8585: <pre class="programlisting">
                   8586: #include &lt;sys/param.h&gt;
                   8587: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8588: /* BSD-specific code goes here */
                   8589: #else
                   8590: /* non-BSD-specific code goes here */
                   8591: #endif
                   8592: </pre>
                   8593: <p>If this distinction is not fine enough, you can also test
                   8594:        for the following macros.</p>
                   8595: <pre class="programlisting">
                   8596: FreeBSD     __FreeBSD__
                   8597: DragonFly   __DragonFly__
                   8598: Interix     __INTERIX
                   8599: IRIX        __sgi (TODO: get a definite source for this)
                   8600: Linux       linux, __linux, __linux__
                   8601: NetBSD      __NetBSD__
                   8602: OpenBSD     __OpenBSD__
                   8603: Solaris     sun, __sun
                   8604: </pre>
                   8605: </div>
1.23      wiz      8606: <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
1.1       dsieger  8607: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8608: <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  8609: <pre class="programlisting">
                   8610: i386        i386, __i386, __i386__
                   8611: MIPS        __mips
                   8612: SPARC       sparc, __sparc
                   8613: </pre>
                   8614: </div>
1.23      wiz      8615: <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
1.1       dsieger  8616: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8617: <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  8618: <pre class="programlisting">
                   8619: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8620: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8621: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8622: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8623: </pre>
                   8624: </div>
                   8625: </div>
1.23      wiz      8626: <div class="sect2" title="19.5.2. How to handle compiler bugs">
1.1       dsieger  8627: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8628: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8629: <p>Some source files trigger bugs in the compiler, based on
                   8630:         combinations of compiler version and architecture and almost
                   8631:         always relation to optimisation being enabled.  Common symptoms
                   8632:         are gcc internal errors or never finishing compiling a
                   8633:        file.</p>
                   8634: <p>Typically, a workaround involves testing the
                   8635:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8636:         optimisation for that combination of file,
                   8637:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8638:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8639:        number of examples.</p>
                   8640: </div>
1.23      wiz      8641: <div class="sect2" title="19.5.3. Undefined reference to &#8220;...&#8221;">
1.1       dsieger  8642: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz      8643: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8644: </h3></div></div></div>
1.1       dsieger  8645: <p>This error message often means that a package did not
                   8646:        link to a shared library it needs. The following functions are
                   8647:        known to cause this error message over and over.</p>
                   8648: <div class="informaltable">
                   8649: <a name="undefined-reference-functions"></a><table border="1">
                   8650: <colgroup>
                   8651: <col>
                   8652: <col>
                   8653: <col>
                   8654: </colgroup>
                   8655: <thead><tr>
                   8656: <th>Function</th>
                   8657: <th>Library</th>
                   8658: <th>Affected platforms</th>
                   8659: </tr></thead>
                   8660: <tbody>
                   8661: <tr>
                   8662: <td>accept, bind, connect</td>
                   8663: <td>-lsocket</td>
                   8664: <td>Solaris</td>
                   8665: </tr>
                   8666: <tr>
                   8667: <td>crypt</td>
                   8668: <td>-lcrypt</td>
                   8669: <td>DragonFly, NetBSD</td>
                   8670: </tr>
                   8671: <tr>
                   8672: <td>dlopen, dlsym</td>
                   8673: <td>-ldl</td>
                   8674: <td>Linux</td>
                   8675: </tr>
                   8676: <tr>
                   8677: <td>gethost*</td>
                   8678: <td>-lnsl</td>
                   8679: <td>Solaris</td>
                   8680: </tr>
                   8681: <tr>
                   8682: <td>inet_aton</td>
                   8683: <td>-lresolv</td>
                   8684: <td>Solaris</td>
                   8685: </tr>
                   8686: <tr>
                   8687: <td>nanosleep, sem_*, timer_*</td>
                   8688: <td>-lrt</td>
                   8689: <td>Solaris</td>
                   8690: </tr>
                   8691: <tr>
                   8692: <td>openpty</td>
                   8693: <td>-lutil</td>
                   8694: <td>Linux</td>
                   8695: </tr>
                   8696: </tbody>
                   8697: </table>
                   8698: </div>
                   8699: <p>To fix these linker errors, it is often sufficient to say
                   8700:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8701:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8702:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8703:     bmake</strong></span>.</p>
1.23      wiz      8704: <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
1.1       dsieger  8705: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8706: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8707: <p>When you are using the SunPro compiler, there is another
                   8708: possibility. That compiler cannot handle the following code:</p>
                   8709: <pre class="programlisting">
                   8710: extern int extern_func(int);
                   8711: 
                   8712: static inline int
                   8713: inline_func(int x)
                   8714: {
                   8715:         return extern_func(x);
                   8716: }
                   8717: 
                   8718: int main(void)
                   8719: {
                   8720:         return 0;
                   8721: }
                   8722: </pre>
                   8723: <p>It generates the code for <code class="function">inline_func</code> even if
                   8724: that function is never used. This code then refers to
                   8725: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8726: solve this problem you can try to tell the package to disable inlining
                   8727: of functions.</p>
                   8728: </div>
                   8729: </div>
1.23      wiz      8730: <div class="sect2" title="19.5.4. Running out of memory">
1.1       dsieger  8731: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8732: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8733: <p>Sometimes packages fail to build because the compiler runs
                   8734:     into an operating system specific soft limit.  With the
                   8735:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8736:     to unlimit the resources.  Currently, the allowed values are
1.23      wiz      8737:     <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  8738:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8739:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8740:     segment size or maximum stack size of a process, respectively, to
                   8741:     their hard limits.</p>
                   8742: </div>
                   8743: </div>
1.23      wiz      8744: <div class="sect1" title="19.6. Fixing problems in the install phase">
1.1       dsieger  8745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8746: <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      8747: <div class="sect2" title="19.6.1. Creating needed directories">
1.1       dsieger  8748: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8749: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8750: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8751:     with some operating systems cannot create more than one
                   8752:     directory at a time. As such, you should call
                   8753:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8754: <pre class="programlisting">
                   8755: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8756: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8757:     </pre>
1.23      wiz      8758: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8759:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8760:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8761:     automatically do the right thing.</p>
                   8762: </div>
1.23      wiz      8763: <div class="sect2" title="19.6.2. Where to install documentation">
1.1       dsieger  8764: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8765: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8766: <p>In general, documentation should be installed into
                   8767:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8768:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8769:     includes the version number of the package).</p>
                   8770: <p>Many modern packages using GNU autoconf allow to set the
                   8771:     directory where HTML documentation is installed with the
1.23      wiz      8772:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8773:     is needed because otherwise the documentation ends up in
                   8774:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8775:     places.</p>
                   8776: <p>An exception to the above is that library API documentation
                   8777:     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
                   8778:     browsers (devhelp) should be left at their default location, which
                   8779:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8780:     documentation can be recognized from files ending in
                   8781:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8782:     (It is also acceptable to install such files in
                   8783:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8784:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8785:     <code class="filename">.devhelp*</code> file must be directly in that
                   8786:     directory then, no additional subdirectory level is allowed in
                   8787:     this case. This is usually achieved by using
1.23      wiz      8788:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8789:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8790:     though.)</p>
                   8791: </div>
1.23      wiz      8792: <div class="sect2" title="19.6.3. Installing highscore files">
1.1       dsieger  8793: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8794: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8795: <p>Certain packages, most of them in the games category, install
                   8796:     a score file that allows all users on the system to record their
                   8797:     highscores.  In order for this to work, the binaries need to be
                   8798:     installed setgid and the score files owned by the appropriate
                   8799:     group and/or owner (traditionally the "games" user/group).  The
                   8800:     following variables, documented in more detail in
                   8801:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8802:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8803:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8804:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
                   8805: <p>Note that per default, setgid installation of games is
                   8806:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8807:     the other variables accordingly.</p>
1.14      jmcneill 8808: <p>A package should therefore never hard code file ownership or
1.1       dsieger  8809:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8810:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8811:     correctly.</p>
                   8812: </div>
1.23      wiz      8813: <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
1.1       dsieger  8814: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8815: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8816: <p><code class="varname">DESTDIR</code> support means that a package
                   8817:     installs into a staging directory, not the final location of the
                   8818:     files. Then a binary package is created which can be used for
                   8819:     installation as usual. There are two ways: Either the package must
1.23      wiz      8820:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8821:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
                   8822: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8823: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8824:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. If
1.14      jmcneill 8825:       bsd.prefs.mk is included in the Makefile,
                   8826:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8827:       the inclusion.</p></li>
1.23      wiz      8828: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8829:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8830: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8831:       automatically. Many manual rules and pre/post-install often are
                   8832:       incorrect; fix them.</p></li>
1.23      wiz      8833: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8834:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8835: <li class="listitem"><p>In general, packages should support
1.4       rillig   8836:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8837:       DESTDIR.</p></li>
                   8838: </ul></div>
                   8839: </div>
1.23      wiz      8840: <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
1.4       rillig   8841: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8842: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8843: <p>Your package may also contain scripts with hardcoded paths to
                   8844:       other interpreters besides (or as well as) perl.  To correct the
                   8845:       full pathname to the script interpreter, you need to set the
                   8846:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8847:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8848: <pre class="programlisting">
                   8849: REPLACE_INTERPRETER+=   tcl
                   8850: REPLACE.tcl.old=        .*/bin/tclsh
                   8851: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8852: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8853: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8854:     </pre>
1.23      wiz      8855: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8856: <h3 class="title">Note</h3>
                   8857: <p>Before March 2006, these variables were called
                   8858:     <code class="varname">_REPLACE.*</code> and
                   8859:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8860: </div>
                   8861: </div>
1.23      wiz      8862: <div class="sect2" title="19.6.6. Packages installing perl modules">
1.1       dsieger  8863: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8864: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8865: <p>Makefiles of packages providing perl5 modules should include
                   8866:     the Makefile fragment
                   8867:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8868:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8869:     configuration for such modules as well as various hooks to tune
                   8870:     this configuration.  See comments in this file for
                   8871:     details.</p>
                   8872: <p>Perl5 modules will install into different places depending
                   8873:     on the version of perl used during the build process.  To
                   8874:     address this, pkgsrc will append lines to the
                   8875:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8876:     the installed <code class="filename">.packlist</code> file generated by
                   8877:     most perl5 modules.  This is invoked by defining
                   8878:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8879:     paths to packlist files, e.g.:</p>
                   8880: <pre class="programlisting">
                   8881: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8882:     </pre>
                   8883: <p>The variables <code class="varname">PERL5_SITELIB</code>,
                   8884:     <code class="varname">PERL5_SITEARCH</code>, and
                   8885:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8886:     in which perl5 modules may be installed, and may be used by
                   8887:     perl5 packages that don't have a packlist.  These three
                   8888:     variables are also substituted for in the
                   8889:     <code class="filename">PLIST</code>.</p>
                   8890: </div>
1.23      wiz      8891: <div class="sect2" title="19.6.7. Packages installing info files">
1.1       dsieger  8892: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8893: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8894: <p>Some packages install info files or use the
1.23      wiz      8895:     <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  8896:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8897:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8898:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8899:     handle registration of the info files in the Info directory
1.23      wiz      8900:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8901:     files registration is either provided by the system, or by a
                   8902:     special purpose package automatically added as dependency if
                   8903:     needed.</p>
                   8904: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8905:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8906:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8907:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8908: <p>The info files for the package should be listed in the
                   8909:     package <code class="filename">PLIST</code>; however any split info files
                   8910:     need not be listed.</p>
1.23      wiz      8911: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8912:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8913:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8914:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8915:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8916:     variable in the package <code class="filename">Makefile</code>. By
                   8917:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8918:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8919:     does not match the required minimum, a build dependency on the
                   8920:     <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
                   8921:     be added automatically.</p>
                   8922: <p>The build and installation process of the software provided
                   8923:     by the package should not use the
1.10      hubertf  8924:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8925:     info files is the task of the package
                   8926:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8927:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8928: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8929:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8930:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8931:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8932: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8933:     no effect except the logging of a message. The script overriding
1.10      hubertf  8934:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8935:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8936:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8937: </div>
1.23      wiz      8938: <div class="sect2" title="19.6.8. Packages installing man pages">
1.1       dsieger  8939: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8940: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8941: <p>All packages that install manual pages should install them
                   8942:     into the same directory, so that there is one common place to look
                   8943:     for them. In pkgsrc, this place is
                   8944:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8945:     should be used in packages. The default for
                   8946:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8947:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8948:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
                   8949: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8950: <h3 class="title">Note</h3>
                   8951: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8952:     is far from complete.</p>
                   8953: </div>
                   8954: <p>The <code class="filename">PLIST</code> files can just use
                   8955:     <code class="filename">man/</code> as the top level directory for the man
                   8956:     page file entries, and the pkgsrc framework will convert as
                   8957:     needed. In all other places, the correct
                   8958:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8959: <p>Packages that are
                   8960:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      8961:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  8962:     <code class="filename">./configure</code>
                   8963:     --mandir switch to set where the man pages should be installed.
                   8964:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8965:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8966: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8967:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      8968:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  8969:     Or if the <code class="filename">./configure</code> script uses
                   8970:     a non-standard use of --mandir, you can set
                   8971:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  8972: <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  8973:     information on installation of compressed manual pages.</p>
                   8974: </div>
1.23      wiz      8975: <div class="sect2" title="19.6.9. Packages installing GConf data files">
1.1       dsieger  8976: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   8977: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8978: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8979:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8980:     you need to take some extra steps to make sure they get registered
                   8981:     in the database:</p>
1.23      wiz      8982: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8983: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  8984:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   8985:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  8986:        deinstallation time, and tells the package where to install
1.7       rillig   8987:        GConf data files using some standard configure arguments.  It
1.1       dsieger  8988:        also disallows any access to the database directly from the
                   8989:        package.</p></li>
1.23      wiz      8990: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  8991:        <code class="filename">.schemas</code> files under
                   8992:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8993:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8994:        need to manually patch the package.</p></li>
1.23      wiz      8995: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  8996:        directory, as they will be handled automatically.  See
1.10      hubertf  8997:        <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      8998: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  8999:        your <code class="filename">Makefile</code> with a list of all
                   9000:        <code class="filename">.schemas</code> files installed by the package, if
                   9001:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      9002: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  9003:        your <code class="filename">Makefile</code> with a
                   9004:        list of all <code class="filename">.entries</code> files installed by the
                   9005:        package, if any. Names must not contain any directories in
                   9006:        them.</p></li>
                   9007: </ol></div>
                   9008: </div>
1.23      wiz      9009: <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
1.1       dsieger  9010: <div class="titlepage"><div><div><h3 class="title">
1.18      snj      9011: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  9012: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      9013:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  9014:     get registered in the database:</p>
1.23      wiz      9015: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9016: <li class="listitem"><p>Include
1.18      snj      9017:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9018:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  9019:        takes care of rebuilding the scrollkeeper database at
                   9020:        installation and deinstallation time, and disallows any access
                   9021:        to it directly from the package.</p></li>
1.23      wiz      9022: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9023:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9024:        will be handled automatically.</p></li>
1.23      wiz      9025: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      9026:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9027:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  9028: </ol></div>
                   9029: </div>
1.23      wiz      9030: <div class="sect2" title="19.6.11. Packages installing X11 fonts">
1.1       dsieger  9031: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9032: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9033: <p>If a package installs font files, you will need to rebuild
                   9034:     the fonts database in the directory where they get installed at
                   9035:     installation and deinstallation time.  This can be automatically
                   9036:     done by using the pkginstall framework.</p>
                   9037: <p>You can list the directories where fonts are installed in the
                   9038:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9039:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9040:     <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  9041:     Also make sure that the database file
                   9042:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9043: <p>Note that you should not create new directories for fonts;
                   9044:     instead use the standard ones to avoid that the user needs to
                   9045:     manually configure his X server to find them.</p>
                   9046: </div>
1.23      wiz      9047: <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
1.1       dsieger  9048: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9049: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  9050: <p>If a package installs GTK2 immodules or loaders, you need to
                   9051:     take some extra steps to get them registered in the GTK2 database
                   9052:     properly:</p>
1.23      wiz      9053: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9054: <li class="listitem"><p>Include
1.1       dsieger  9055:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9056:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9057:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      9058: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  9059:       your package installs GTK2 immodules.</p></li>
1.23      wiz      9060: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  9061:       GTK2 loaders.</p></li>
1.23      wiz      9062: <li class="listitem">
1.1       dsieger  9063: <p>Patch the package to not touch any of the GTK2
                   9064:       databases directly.  These are:</p>
1.23      wiz      9065: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9066: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9067: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  9068: </ul></div>
                   9069: </li>
1.23      wiz      9070: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  9071:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9072:       directory, as they will be handled automatically.</p></li>
                   9073: </ol></div>
                   9074: </div>
1.23      wiz      9075: <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
1.1       dsieger  9076: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9077: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9078: <p>If a package installs SGML or XML data files that need to be
                   9079:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9080:     etc.), you need to take some extra steps:</p>
1.23      wiz      9081: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9082: <li class="listitem"><p>Include
1.1       dsieger  9083:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9084:        your <code class="filename">Makefile</code>, which takes care of
                   9085:        registering those files in system-wide catalogs at
                   9086:        installation and deinstallation time.</p></li>
1.23      wiz      9087: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9088:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9089: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9090:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9091: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9092:        to be added to the SGML catalog.  These come in groups of
                   9093:        three strings; see xmlcatmgr(1) for more information
                   9094:        (specifically, arguments recognized by the 'add' action).
                   9095:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9096: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9097:        to be added to the XML catalog.  These come in groups of three
                   9098:        strings; see xmlcatmgr(1) for more information (specifically,
                   9099:        arguments recognized by the 'add' action).  Note that you will
                   9100:        normally not use this variable.</p></li>
                   9101: </ol></div>
                   9102: </div>
1.23      wiz      9103: <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
1.1       dsieger  9104: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9105: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9106: <p>If a package provides extensions to the MIME database by
                   9107:     installing <code class="filename">.xml</code> files inside
                   9108:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9109:     need to take some extra steps to ensure that the database is kept
                   9110:     consistent with respect to these new files:</p>
1.23      wiz      9111: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9112: <li class="listitem"><p>Include
1.1       dsieger  9113:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9114:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9115:        this same directory, which is reserved for inclusion from
                   9116:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9117:        care of rebuilding the MIME database at installation and
                   9118:        deinstallation time, and disallows any access to it directly
                   9119:        from the package.</p></li>
1.23      wiz      9120: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9121:        <code class="filename">share/mime</code> directory,
                   9122:        <span class="emphasis"><em>except</em></span> for files saved under
                   9123:        <code class="filename">share/mime/packages</code>.  The former are
                   9124:        handled automatically by
                   9125:        the update-mime-database program, but the latter are
                   9126:        package-dependent and must be removed by the package that
                   9127:        installed them in the first place.</p></li>
1.23      wiz      9128: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9129:        from the PLIST.  They will be handled by the shared-mime-info
                   9130:        package.</p></li>
                   9131: </ol></div>
                   9132: </div>
1.23      wiz      9133: <div class="sect2" title="19.6.15. Packages using intltool">
1.1       dsieger  9134: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9135: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9136: <p>If a package uses intltool during its build, add
                   9137:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9138:     which forces it to use the intltool package provided by pkgsrc,
                   9139:     instead of the one bundled with the distribution file.</p>
                   9140: <p>This tracks intltool's build-time dependencies and uses the
                   9141:     latest available version; this way, the package benefits of any
                   9142:     bug fixes that may have appeared since it was released.</p>
                   9143: </div>
1.23      wiz      9144: <div class="sect2" title="19.6.16. Packages installing startup scripts">
1.1       dsieger  9145: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9146: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9147: <p>If a package contains a rc.d script, it won't be copied into
                   9148:     the startup directory by default, but you can enable it, by adding
                   9149:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9150:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9151:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9152:     it will automatically remove the scripts when the package is
                   9153:     deinstalled.</p>
                   9154: </div>
1.23      wiz      9155: <div class="sect2" title="19.6.17. Packages installing TeX modules">
1.1       dsieger  9156: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9157: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9158: <p>If a package installs TeX packages into the texmf tree,
                   9159:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9160:     updated.</p>
1.23      wiz      9161: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9162: <h3 class="title">Note</h3>
1.22      jakllsch 9163: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9164:     packages should install files
1.22      jakllsch 9165:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9166:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9167: </div>
1.23      wiz      9168: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9169: <li class="listitem"><p>Include
1.22      jakllsch 9170:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9171:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9172:       database at installation and deinstallation time.</p></li>
1.23      wiz      9173: <li class="listitem">
1.1       dsieger  9174: <p>If your package installs files into a texmf
                   9175:       tree other than the one
1.22      jakllsch 9176:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9177:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9178:       trees that need database update.</p>
                   9179: <p>If your package also installs font map files that need
1.10      hubertf  9180:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9181:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9182:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9183:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9184:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9185:       be run automatically at installation/deinstallation to
                   9186:       enable/disable font map files for TeX output
                   9187:       drivers.</p>
                   9188: </li>
1.23      wiz      9189: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9190:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9191:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9192: </ol></div>
                   9193: </div>
1.23      wiz      9194: <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
1.1       dsieger  9195: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9196: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  9197:     emulation</h3></div></div></div>
                   9198: <p>There are some packages that provide libraries and
                   9199:     executables for running binaries from a one operating system
                   9200:     on a different one (if the latter supports it).  One example
                   9201:     is running Linux binaries on NetBSD.</p>
                   9202: <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>
                   9203:     helps in extracting and packaging Linux rpm packages.</p>
                   9204: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9205:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9206:     if all libraries for each installed executable can be found by
                   9207:     the dynamic linker.  Since the standard dynamic linker is run,
                   9208:     this fails for emulation packages, because the libraries used
                   9209:     by the emulation are not in the standard directories.</p>
                   9210: </div>
1.23      wiz      9211: <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
1.1       dsieger  9212: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9213: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9214: <p>If a package installs images under the
                   9215:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9216:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9217:     database, you need to take some extra steps to make sure that the
                   9218:     shared theme directory is handled appropriately and that the cache
                   9219:     database is rebuilt:</p>
1.23      wiz      9220: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9221: <li class="listitem"><p>Include
1.1       dsieger  9222:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      9223: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  9224:        entry that refers to the theme cache.</p></li>
1.23      wiz      9225: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  9226:          directories from the <code class="filename">share/icons/hicolor</code>
                   9227:          hierarchy because they will be handled automatically.</p></li>
                   9228: </ol></div>
                   9229: <p>The best way to verify that the PLIST is correct with
                   9230:       respect to the last two points is to regenerate it using
1.10      hubertf  9231:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  9232: </div>
1.23      wiz      9233: <div class="sect2" title="19.6.20. Packages installing desktop files">
1.1       dsieger  9234: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9235: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  9236: <p>If a package installs <code class="filename">.desktop</code> files
                   9237:       under <code class="filename">share/applications</code> and these include
                   9238:       MIME information, you need to take extra steps to ensure that they
                   9239:       are registered into the MIME database:</p>
1.23      wiz      9240: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9241: <li class="listitem"><p>Include
1.1       dsieger  9242:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      9243: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  9244:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9245:          It will be handled automatically.</p></li>
                   9246: </ol></div>
                   9247: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  9248:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  9249:       print-PLIST</strong></span>.</p>
                   9250: </div>
                   9251: </div>
1.23      wiz      9252: <div class="sect1" title="19.7. Marking packages as having problems">
1.1       dsieger  9253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9254: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9255: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 9256:   immediately. In this case, one can plainly mark a package as broken.  For
                   9257:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9258:   reason why the package is broken (similar to the
                   9259:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9260:   the package will immediately be shown this message, and the build
                   9261:   will not be even tried.</p>
                   9262: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  9263:   intervals.</p>
                   9264: </div>
                   9265: </div>
1.23      wiz      9266: <div class="chapter" title="Chapter 20. Debugging">
1.1       dsieger  9267: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9268: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9269: <p>To check out all the gotchas when building a package, here are
                   9270:   the steps that I do in order to get a package working.  Please note
                   9271:   this is basically the same as what was explained in the previous
                   9272:   sections, only with some debugging aids.</p>
1.23      wiz      9273: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9274: <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>
                   9275: <li class="listitem">
1.1       dsieger  9276: <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>,
                   9277:       create a directory for a new package, change into it, then run
1.10      hubertf  9278:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  9279: <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>
                   9280: <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>
                   9281: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9282: </li>
1.23      wiz      9283: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9284: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9285: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9286: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  9287:       configure step to the package's
                   9288:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      9289: <li class="listitem">
1.1       dsieger  9290: <p>Make the package compile, doing multiple rounds of</p>
                   9291: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9292: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9293: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9294: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9295: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9296: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9297: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9298: <p>Doing this step as non-root user will ensure that no files
                   9299:       are modified that shouldn't be, especially during the build
1.10      hubertf  9300:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9301:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1       dsieger  9302:       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>
                   9303:       package.</p>
                   9304: </li>
1.23      wiz      9305: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9306:       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>
                   9307: <li class="listitem">
1.1       dsieger  9308: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9309: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9310: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9311: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9312: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9313: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9314: <p>You usually need to be <code class="username">root</code> to do
                   9315:       this.  Look if there are any files left:</p>
                   9316: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9317: <p>If this reveals any files that are missing in
                   9318:       <code class="filename">PLIST</code>, add them.</p>
                   9319: </li>
1.23      wiz      9320: <li class="listitem">
1.1       dsieger  9321: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9322:       package again and make a binary package:</p>
                   9323: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9324: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9325: </li>
1.23      wiz      9326: <li class="listitem">
1.1       dsieger  9327: <p>Delete the installed package:</p>
                   9328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9329: </li>
1.23      wiz      9330: <li class="listitem">
1.10      hubertf  9331: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  9332:       command, which shouldn't find anything now:</p>
                   9333: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9334: </li>
1.23      wiz      9335: <li class="listitem">
1.1       dsieger  9336: <p>Reinstall the binary package:</p>
                   9337: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9338: </li>
1.23      wiz      9339: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9340: <li class="listitem">
1.10      hubertf  9341: <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  9342:       reports:</p>
                   9343: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9344: </li>
1.23      wiz      9345: <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  9346: </ul></div>
                   9347: </div>
1.23      wiz      9348: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.1       dsieger  9349: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9350: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9351: <div class="toc">
                   9352: <p><b>Table of Contents</b></p>
                   9353: <dl>
1.6       rillig   9354: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9355: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9356: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9357: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9358: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      9359: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9360: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9361: </dl>
                   9362: </div>
1.23      wiz      9363: <div class="sect1" title="21.1. Submitting binary packages">
1.1       dsieger  9364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9365: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9366: <p>Our policy is that we accept binaries only from pkgsrc
                   9367:        developers to guarantee that the packages don't contain any
                   9368:        trojan horses etc. This is not to annoy anyone but rather to
                   9369:        protect our users! You're still free to put up your home-made
                   9370:        binary packages and tell the world where to get them. NetBSD
                   9371:        developers doing bulk builds and wanting to upload them please
1.10      hubertf  9372:        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  9373: </div>
1.23      wiz      9374: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.1       dsieger  9375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9376: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9377: <p>First, check that your package is complete, compiles and
1.10      hubertf  9378:        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 9379:        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  9380:        archive that contains all files that make up the package.
                   9381:        Finally, send this package to the pkgsrc bug tracking system,
1.29      dholland 9382:        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  9383:        that, go to the web page
1.10      hubertf  9384:        <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      9385:        which contains some instructions and a link to a form where you
                   9386:        can submit packages.  The
                   9387:        <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
                   9388:        also available as a substitute for either of the above two tools.
                   9389:        </p>
1.1       dsieger  9390: <p>In the form of the problem report, the category should be
1.23      wiz      9391:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9392:        and version number, and the description field should contain a
                   9393:        short description of your package (contents of the COMMENT
                   9394:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      9395:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  9396: <p>If you want to submit several packages, please send a
                   9397:        separate PR for each one, it's easier for us to track things
                   9398:        that way.</p>
                   9399: <p>Alternatively, you can also import new packages into
1.23      wiz      9400:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.10      hubertf  9401:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger  9402:        for details.</p>
                   9403: </div>
1.23      wiz      9404: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.1       dsieger  9405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9406: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9407: <p>Please note all package additions, updates, moves, and
                   9408:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9409:        important to keep this file up to date and conforming to the
                   9410:        existing format, because it will be used by scripts to
1.10      hubertf  9411:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9412:        sites. Additionally, check the
                   9413:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9414:        for the package you updated or removed, in case it was mentioned
                   9415:        there.</p>
                   9416: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9417:        bumped, the change should appear in
                   9418:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9419:        related or otherwise relevant. Mass bumps that result from a
                   9420:        dependency being updated should not be mentioned. In all other
                   9421:        cases it's the developer's decision.</p>
                   9422: <p>There is a make target that helps in creating proper
1.10      hubertf  9423:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9424:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9425:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9426:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9427:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9428:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9429:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9430:   For new packages, or package moves or removals, set the
                   9431:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9432:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9433:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9434:   not the same as your NetBSD login name. The target also automatically
                   9435:   removes possibly existing entries for the package in the
                   9436:   <code class="filename">TODO</code> file. Don't forget to commit
                   9437:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
                   9438:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9439:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9440:   makes the cvs commands use the main repository.
                   9441:   </p>
1.1       dsieger  9442: </div>
1.23      wiz      9443: <div class="sect1" title="21.4. Committing: Importing a package into CVS">
1.1       dsieger  9444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9445: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1       dsieger  9446: <p>This section is only of interest for pkgsrc developers with write
                   9447:   access to the pkgsrc repository. Please remember that cvs
                   9448:   imports files relative to the current working directory, and that
                   9449:   the pathname that you
1.10      hubertf  9450:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.1       dsieger  9451:   to place the files in the repository.  Newly created packages should be
1.23      wiz      9452:   imported with a vendor tag of <span class="quote">&#8220;<span class="quote">TNF</span>&#8221;</span> and a release tag of
                   9453:   <span class="quote">&#8220;<span class="quote">pkgsrc-base</span>&#8221;</span>, e.g:</p>
1.1       dsieger  9454: <pre class="programlisting">
                   9455: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9456: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   9457: </pre>
                   9458: <p>Remember to move the directory from which you imported out of
1.23      wiz      9459:   the way, or cvs will complain the next time you <span class="quote">&#8220;<span class="quote">cvs
                   9460:   update</span>&#8221;</span> your source tree.  Also don't forget to add the new
1.1       dsieger  9461:   package to the category's <code class="filename">Makefile</code>.</p>
                   9462: <p>The commit message of the initial import should include part of the
                   9463:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9464:   what the package is/does.</p>
1.23      wiz      9465: <p>For new packages, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> is preferred to <span class="quote">&#8220;<span class="quote">cvs
                   9466:   add</span>&#8221;</span> because the former gets everything with a single command,
1.1       dsieger  9467:   and provides a consistent tag.</p>
                   9468: </div>
1.23      wiz      9469: <div class="sect1" title="21.5. Updating a package to a newer version">
1.1       dsieger  9470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9471: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9472: <p>Please always put a concise, appropriate and relevant summary of the
                   9473:   changes between old and new versions into the commit log when updating
                   9474:   a package. There are various reasons for this:</p>
1.23      wiz      9475: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9476: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9477:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9478: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9479:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9480: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9481:   repository is very useful for people who read the pkgsrc-changes mailing
                   9482:   list, so that they can make tactical decisions about when to upgrade
                   9483:   the package.</p></li>
                   9484: </ul></div>
                   9485: <p>Please also recognize that, just because a new version of a package
                   9486:   has been released, it should not automatically be upgraded in the CVS
                   9487:   repository.  We prefer to be conservative in the packages that are
                   9488:   included in pkgsrc - development or beta packages are not really the
                   9489:   best thing for most places in which pkgsrc is used. Please use your
                   9490:   judgement about what should go into pkgsrc, and bear in mind that
                   9491:   stability is to be preferred above new and possibly untested features.</p>
                   9492: </div>
1.23      wiz      9493: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.1       dsieger  9494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20      snj      9495: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9496: <p>Renaming packages is not recommended.</p>
                   9497: <p>When renaming packages, be sure to fix any references to old name
                   9498:   in other Makefiles, options, buildlink files, etc.</p>
                   9499: <p>Also When renaming a package, please define
                   9500:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9501:   pattern(s) of the previous package name.
                   9502:   This may be repeated for multiple renames.
                   9503:   The new package would be an exact replacement.
                   9504: </p>
1.23      wiz      9505: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9506:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9507:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9508:   not be an exact replacement but is a suggestion for the replaced
                   9509:   functionality.</p>
                   9510: </div>
1.23      wiz      9511: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.20      snj      9512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9513: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9514: <p>It is preferred that packages are not renamed or moved, but if needed
                   9515:   please follow these steps.
                   9516: </p>
1.23      wiz      9517: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9518: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9519: <li class="listitem">
1.1       dsieger  9520: <p>Remove all CVS dirs.</p>
                   9521: <p>Alternatively to the first two steps you can also do:</p>
                   9522: <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>
                   9523: <p>and use that for further work.</p>
                   9524: </li>
1.23      wiz      9525: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9526: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9527: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9528: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      9529: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9530: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9531: for doing an update using pkgsrc building; for example, it can
1.29      dholland 9532: 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      9533: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9534: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9535: it may have multiple matches, so the tool should also check on the
                   9536: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9537: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9538: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9539: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9540: place.</p></li>
1.23      wiz      9541: <li class="listitem">
1.1       dsieger  9542: <p>Check if any package depends on it:
                   9543: </p>
                   9544: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9545: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9546: </li>
1.23      wiz      9547: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9548: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9549: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9550: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9551: <li class="listitem">
1.1       dsieger  9552: <p>Commit the changed and removed files:</p>
                   9553: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9554: <p>(and any packages from step 5, of course).</p>
                   9555: </li>
                   9556: </ol></div>
                   9557: </div>
                   9558: </div>
1.23      wiz      9559: <div class="chapter" title="Chapter 22. Frequently Asked Questions">
1.1       dsieger  9560: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9561: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9562: <p>This section contains the answers to questions that may
                   9563:        arise when you are writing a package. If you don't find your
                   9564:        question answered here, first have a look in the other chapters,
                   9565:        and if you still don't have the answer, ask on the
                   9566:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.23      wiz      9567: <div class="qandaset" title="Frequently Asked Questions">
1.30    ! wiz      9568: <a name="id1168229300237"></a><dl>
1.6       rillig   9569: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9570:        MAKEFLAGS, .MAKEFLAGS and
                   9571:        MAKE_FLAGS?</a>
                   9572: </dt>
1.6       rillig   9573: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9574:        MAKE, GMAKE and
                   9575:        MAKE_PROGRAM?</a>
                   9576: </dt>
1.6       rillig   9577: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9578:        CC, PKG_CC and
                   9579:        PKGSRC_COMPILER?</a>
                   9580: </dt>
1.6       rillig   9581: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9582:        BUILDLINK_LDFLAGS,
                   9583:        BUILDLINK_LDADD and
                   9584:        BUILDLINK_LIBS?</a>
                   9585: </dt>
1.6       rillig   9586: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9587:        VARNAME=BUILDLINK_PREFIX.foo
                   9588:        say it's empty?</a>
                   9589: </dt>
1.6       rillig   9590: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9591:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9592:        don't understand the := inside
                   9593:        it.</a>
                   9594: </dt>
1.6       rillig   9595: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9596:        developers?</a>
                   9597: </dt>
1.6       rillig   9598: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9599:        documentation?</a>
                   9600: </dt>
1.6       rillig   9601: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9602: do?</a>
                   9603: </dt>
                   9604: </dl>
1.23      wiz      9605: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  9606: <col align="left" width="1%">
1.23      wiz      9607: <col>
1.1       dsieger  9608: <tbody>
1.23      wiz      9609: <tr class="question" title="22.1.">
1.1       dsieger  9610: <td align="left" valign="top">
1.30    ! wiz      9611: <a name="devfaq.makeflags"></a><a name="id1168229300241"></a><p><b>22.1.</b></p>
1.1       dsieger  9612: </td>
                   9613: <td align="left" valign="top"><p>What is the difference between
                   9614:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9615:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9616: </tr>
                   9617: <tr class="answer">
                   9618: <td align="left" valign="top"></td>
                   9619: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29      dholland 9620:        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  9621:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9622:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9623:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9624: </tr>
1.23      wiz      9625: <tr class="question" title="22.2.">
1.1       dsieger  9626: <td align="left" valign="top">
1.30    ! wiz      9627: <a name="devfaq.make"></a><a name="id1168229300274"></a><p><b>22.2.</b></p>
1.1       dsieger  9628: </td>
                   9629: <td align="left" valign="top"><p>What is the difference between
                   9630:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9631:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9632: </tr>
                   9633: <tr class="answer">
                   9634: <td align="left" valign="top"></td>
                   9635: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29      dholland 9636:        <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  9637:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9638:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9639:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9640:        Make program that is used for building the
                   9641:        package.</p></td>
                   9642: </tr>
1.23      wiz      9643: <tr class="question" title="22.3.">
1.1       dsieger  9644: <td align="left" valign="top">
1.30    ! wiz      9645: <a name="devfaq.cc"></a><a name="id1168229300345"></a><p><b>22.3.</b></p>
1.1       dsieger  9646: </td>
                   9647: <td align="left" valign="top"><p>What is the difference between
                   9648:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9649:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9650: </tr>
                   9651: <tr class="answer">
                   9652: <td align="left" valign="top"></td>
                   9653: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9654:        compiler, which can be configured by the pkgsrc user.
                   9655:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9656:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9657:        path to a compiler, but the type of compiler that should be
                   9658:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9659:        information about the latter variable.</p></td>
                   9660: </tr>
1.23      wiz      9661: <tr class="question" title="22.4.">
1.1       dsieger  9662: <td align="left" valign="top">
1.30    ! wiz      9663: <a name="devfaq.bl3flags"></a><a name="id1168229300379"></a><p><b>22.4.</b></p>
1.1       dsieger  9664: </td>
                   9665: <td align="left" valign="top"><p>What is the difference between
                   9666:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9667:        <code class="varname">BUILDLINK_LDADD</code> and
                   9668:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9669: </tr>
                   9670: <tr class="answer">
                   9671: <td align="left" valign="top"></td>
                   9672: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9673: </tr>
1.23      wiz      9674: <tr class="question" title="22.5.">
1.1       dsieger  9675: <td align="left" valign="top">
1.30    ! wiz      9676: <a name="devfaq.bl3prefix"></a><a name="id1168229300398"></a><p><b>22.5.</b></p>
1.1       dsieger  9677: </td>
1.10      hubertf  9678: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9679:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9680:        say it's empty?</p></td>
                   9681: </tr>
                   9682: <tr class="answer">
                   9683: <td align="left" valign="top"></td>
                   9684: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9685:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9686:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9687:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9688:        command.</p></td>
                   9689: </tr>
1.23      wiz      9690: <tr class="question" title="22.6.">
1.1       dsieger  9691: <td align="left" valign="top">
1.30    ! wiz      9692: <a name="devfaq.master_sites"></a><a name="id1168229300424"></a><p><b>22.6.</b></p>
1.1       dsieger  9693: </td>
                   9694: <td align="left" valign="top"><p>What does
                   9695:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9696:        don't understand the <code class="literal">:=</code> inside
                   9697:        it.</p></td>
                   9698: </tr>
                   9699: <tr class="answer">
                   9700: <td align="left" valign="top"></td>
                   9701: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9702:        assignment operator, like you might expect at first sight.
                   9703:        Instead, it is a degenerate form of
                   9704:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29      dholland 9705:        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  9706:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9707:        case of <code class="varname">MASTER_SITE_*</code>,
                   9708:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9709:        <em class="replaceable"><code>new_string</code></em> is
                   9710:        <code class="literal">package/</code>. That's where the
                   9711:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9712:        together.</p></td>
                   9713: </tr>
1.23      wiz      9714: <tr class="question" title="22.7.">
1.1       dsieger  9715: <td align="left" valign="top">
1.30    ! wiz      9716: <a name="devfaq.mailinglists"></a><a name="id1168229300560"></a><p><b>22.7.</b></p>
1.1       dsieger  9717: </td>
                   9718: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9719:        developers?</p></td>
                   9720: </tr>
                   9721: <tr class="answer">
                   9722: <td align="left" valign="top"></td>
                   9723: <td align="left" valign="top"><div class="variablelist"><dl>
1.10      hubertf  9724: <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  9725: <dd><p>This is a list for technical discussions related
                   9726:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9727:        pkgsrc infrastructure, proposed new features, questions related
                   9728:        to porting pkgsrc to a new platform, advice for maintaining a
                   9729:        package, patches that affect many packages, help requests moved
                   9730:        from pkgsrc-users when an infrastructure bug is found,
                   9731:        etc.</p></dd>
1.10      hubertf  9732: <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  9733: <dd><p>All bug reports in category "pkg" sent with
1.29      dholland 9734:        <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  9735:        directly; use one of the other mailing
                   9736:        lists.</p></dd>
                   9737: </dl></div></td>
                   9738: </tr>
1.23      wiz      9739: <tr class="question" title="22.8.">
1.1       dsieger  9740: <td align="left" valign="top">
1.30    ! wiz      9741: <a name="devfaq.documentation"></a><a name="id1168229300590"></a><p><b>22.8.</b></p>
1.1       dsieger  9742: </td>
                   9743: <td align="left" valign="top"><p>Where is the pkgsrc
                   9744:        documentation?</p></td>
                   9745: </tr>
                   9746: <tr class="answer">
                   9747: <td align="left" valign="top"></td>
                   9748: <td align="left" valign="top">
                   9749: <p>There are many places where you can find
                   9750:        documentation about pkgsrc:</p>
1.23      wiz      9751: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9752: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9753:        of chapters that explain large parts of pkgsrc, but some
                   9754:        chapters tend to be outdated. Which ones they are is hard to
                   9755:        say.</p></li>
1.23      wiz      9756: <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  9757:        about certain features, announcements of new parts of the pkgsrc
                   9758:        infrastructure and sometimes even announcements that a certain
                   9759:        feature has been marked as obsolete. The benefit here is that
                   9760:        each message has a date appended to it.</p></li>
1.23      wiz      9761: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9762:        <code class="filename">mk/</code> directory start with a comment that
                   9763:        describes the purpose of the file and how it can be used by the
                   9764:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9765:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9766:        help</strong></span>.</p></li>
1.23      wiz      9767: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9768:        information, but they tend to be highly abbreviated, especially
                   9769:        for actions that occur often. Some contain a detailed
                   9770:        description of what has changed, but they are geared towards the
                   9771:        other pkgsrc developers, not towards an average pkgsrc user.
                   9772:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9773:        don't know what has been before, these messages may not be worth
                   9774:        too much to you.</p></li>
1.23      wiz      9775: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9776:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9777:        mind of the developer who wrote the code. To get this
1.10      hubertf  9778:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9779:        to see who has written it and ask on the
                   9780:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9781:        find your questions later (see above). To be sure that the
                   9782:        developer in charge reads the mail, you may CC him or
                   9783:        her.</p></li>
                   9784: </ul></div>
                   9785: </td>
                   9786: </tr>
1.23      wiz      9787: <tr class="question" title="22.9.">
1.1       dsieger  9788: <td align="left" valign="top">
1.30    ! wiz      9789: <a name="devfaq.too-much-time"></a><a name="id1168229300713"></a><p><b>22.9.</b></p>
1.1       dsieger  9790: </td>
                   9791: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9792: do?</p></td>
                   9793: </tr>
                   9794: <tr class="answer">
                   9795: <td align="left" valign="top"></td>
                   9796: <td align="left" valign="top">
                   9797: <p>This is not really an FAQ yet, but here's the answer
                   9798: anyway.</p>
1.23      wiz      9799: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9800: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1       dsieger  9801:     <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
                   9802:     will tell you about newer versions of installed packages that are
                   9803:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9804: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9805:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9806:     cleanups and enhancements for pkgsrc that would be nice to
                   9807:     have.</p></li>
1.23      wiz      9808: <li class="listitem"><p>Review packages for which review was requested on
1.10      hubertf  9809:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1       dsieger  9810:     mailing list.</p></li>
                   9811: </ul></div>
                   9812: </td>
                   9813: </tr>
                   9814: </tbody>
                   9815: </table>
                   9816: </div>
                   9817: </div>
1.23      wiz      9818: <div class="chapter" title="Chapter 23. GNOME packaging and porting">
1.1       dsieger  9819: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9820: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9821: <div class="toc">
                   9822: <p><b>Table of Contents</b></p>
                   9823: <dl>
1.6       rillig   9824: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9825: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9826: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9827: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9828: </dl>
                   9829: </div>
1.10      hubertf  9830: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9831: site</a>:</p>
                   9832: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9833:   environment, an intuitive and attractive desktop for users, and the
                   9834:   GNOME development platform, an extensive framework for building
                   9835:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9836: <p>pkgsrc provides a seamless way to automatically build and install
                   9837: a complete GNOME environment <span class="emphasis"><em>under many different
                   9838: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9839: the most advanced build and packaging systems for GNOME due to its
                   9840: included technologies buildlink3, the wrappers and tools framework and
                   9841: automatic configuration file management.  Lots of efforts are put into
                   9842: achieving a completely clean deinstallation of installed software
                   9843: components.</p>
1.10      hubertf  9844: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9845: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9846: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9847: pkgsrc as its preferred packaging system, contributing lots of
                   9848: portability fixes to make GNOME build and install under it.</p>
                   9849: <p>This chapter is aimed at pkgsrc developers and other people
                   9850: interested in helping our GNOME porting and packaging efforts.  It
                   9851: provides instructions on how to manage the existing packages and some
                   9852: important information regarding their internals.</p>
1.23      wiz      9853: <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9854: <h3 class="title">We need your help!</h3>
                   9855: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9856:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9857:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9858:   work</a> list!  There is still a long way to go to get a
                   9859:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9860:   achieve it!</p>
                   9861: </div>
1.23      wiz      9862: <div class="sect1" title="23.1. Meta packages">
1.1       dsieger  9863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9864: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9865: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.23      wiz      9866: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9867: <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  9868:     the core GNOME desktop environment.  It only includes the necessary
                   9869:     bits to get it to boot correctly, although it may lack important
                   9870:     functionality for daily operation.  The idea behind this package is
                   9871:     to let end users build their own configurations on top of this one,
                   9872:     first installing this meta package to achieve a functional setup and
                   9873:     then adding individual applications.</p></li>
1.23      wiz      9874: <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  9875:     complete installation of the GNOME platform and desktop as defined
                   9876:     by the GNOME project; this is based on the components distributed in
                   9877:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9878:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9879:     official FTP server.  Developer-only tools found in those
                   9880:     directories are not installed unless required by some other
                   9881:     component to work properly.  Similarly, packages from the bindings
                   9882:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9883:     in unless required as a dependency for an end-user component.  This
                   9884:     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      9885: <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  9886:     Installs all the tools required to build a GNOME component when
                   9887:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9888:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9889: </ul></div>
                   9890: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9891: sorted in a way that eases updates: a package may depend on other
                   9892: packages listed before it but not on any listed after it.  It is very
                   9893: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9894: change it to alphabetical sorting!</em></span></p>
                   9895: </div>
1.23      wiz      9896: <div class="sect1" title="23.2. Packaging a GNOME application">
1.1       dsieger  9897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9898: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9899: <p>Almost all GNOME applications are written in C and use a common
                   9900: set of tools as their build system.  Things get different with the new
                   9901: bindings to other languages (such as Python), but the following will
                   9902: give you a general idea on the minimum required tools:</p>
1.23      wiz      9903: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9904: <li class="listitem">
1.1       dsieger  9905: <p>Almost all GNOME applications use the GNU Autotools as their
                   9906:     build system.  As a general rule you will need to tell this to your
                   9907:     package:</p>
                   9908: <pre class="programlisting">
                   9909: GNU_CONFIGURE=yes
                   9910: USE_LIBTOOL=yes
                   9911: USE_TOOLS+=gmake
                   9912: </pre>
                   9913: </li>
1.23      wiz      9914: <li class="listitem">
1.1       dsieger  9915: <p>If the package uses pkg-config to detect dependencies, add this
                   9916:     tool to the list of required utilities:</p>
                   9917: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   9918: <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
                   9919:     the end of the build process to ensure that you did not miss to
                   9920:     specify any dependency in your package and that the version
                   9921:     requirements are all correct.</p>
                   9922: </li>
1.23      wiz      9923: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9924:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9925:     to handle dependencies and to force the package to use the latest
                   9926:     available version.</p></li>
1.23      wiz      9927: <li class="listitem">
1.1       dsieger  9928: <p>If the package uses gtk-doc (a documentation generation
                   9929:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9930:     tool is rather big and the distfile should come with pregenerated
                   9931:     documentation anyway; if it does not, it is a bug that you ought to
                   9932:     report.  For such packages you should disable gtk-doc (unless it is
                   9933:     the default):</p>
                   9934: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9935: <p>The default location of installed HTML files
                   9936:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9937:     and should not be changed unless the package insists on installing
                   9938:     them somewhere else.  Otherwise programs as
1.10      hubertf  9939:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9940:     do that with an entry similar to:</p>
                   9941: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   9942: </li>
                   9943: </ul></div>
                   9944: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9945: files under the installation prefix to maintain databases.  In this
                   9946: context, shared means that those exact same directories and files are
                   9947: used among several different packages, leading to conflicts in the
                   9948: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9949: handle the most common cases, so you have to forget about using
                   9950: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9951: omitting shared files from them.  If you find yourself doing those,
                   9952: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9953: <p>The following table lists the common situations that result in
                   9954: using shared directories or files.  For each of them, the appropriate
                   9955: solution is given.  After applying the solution be sure to
                   9956: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  9957: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  9958: <div class="table">
1.6       rillig   9959: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  9960: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   9961: <colgroup>
                   9962: <col>
                   9963: <col>
                   9964: </colgroup>
                   9965: <thead><tr>
                   9966: <th>If the package...</th>
                   9967: <th>Then...</th>
                   9968: </tr></thead>
                   9969: <tbody>
                   9970: <tr>
                   9971: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18      snj      9972: <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  9973: </tr>
                   9974: <tr>
                   9975: <td>Installs icons under the
                   9976:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9977:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  9978: <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  9979: </tr>
                   9980: <tr>
                   9981: <td>Installs files under
                   9982:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  9983: <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  9984: </tr>
                   9985: <tr>
                   9986: <td>Installs <code class="filename">.desktop</code> files under
                   9987:         <code class="filename">share/applications</code> and these include MIME
                   9988:         information.</td>
1.10      hubertf  9989: <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  9990: </tr>
                   9991: </tbody>
                   9992: </table></div>
                   9993: </div>
                   9994: <br class="table-break">
                   9995: </div>
1.23      wiz      9996: <div class="sect1" title="23.3. Updating GNOME to a newer version">
1.1       dsieger  9997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9998: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  9999: <p>When seeing GNOME as a whole, there are two kinds of
                   10000: updates:</p>
                   10001: <div class="variablelist"><dl>
                   10002: <dt><span class="term">Major update</span></dt>
                   10003: <dd>
                   10004: <p>Given that there is still a very long way for GNOME 3 (if it
                   10005:       ever appears), we consider a major update one that goes from a
                   10006:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10007:       where <code class="literal">Y</code> is even and greater than
                   10008:       <code class="literal">X</code>.  These are hard to achieve because they
                   10009:       introduce lots of changes in the components' code and almost all
                   10010:       GNOME distfiles are updated to newer versions.  Some of them can
                   10011:       even break API and ABI compatibility with the previous major
                   10012:       version series.  As a result, the update needs to be done all at
                   10013:       once to minimize breakage.</p>
                   10014: <p>A major update typically consists of around 80 package
                   10015:       updates and the addition of some new ones.</p>
                   10016: </dd>
                   10017: <dt><span class="term">Minor update</span></dt>
                   10018: <dd>
                   10019: <p>We consider a minor update one that goes from a
                   10020:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10021:       one where <code class="literal">Y</code> is greater than
                   10022:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10023:       not update all GNOME components, can be done in an incremental way
                   10024:       and do not break API nor ABI compatibility.</p>
                   10025: <p>A minor update typically consists of around 50 package
                   10026:       updates, although the numbers here may vary a lot.</p>
                   10027: </dd>
                   10028: </dl></div>
                   10029: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10030: release (either major or minor), the following steps should be
                   10031: followed:</p>
1.23      wiz      10032: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10033: <li class="listitem">
1.1       dsieger  10034: <p>Get a list of all the tarballs that form the new release by
                   10035:     using the following commands.  These will leave the full list of the
1.18      snj      10036:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  10037:     file:</p>
                   10038: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10039:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10040:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10041: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10042:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10043:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10044: </li>
1.23      wiz      10045: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  10046:     bump their version to the release you are updating them to.  The
                   10047:     three meta packages should be always consistent with versioning.
                   10048:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10049:     in them.</p></li>
1.23      wiz      10050: <li class="listitem">
1.1       dsieger  10051: <p>For each meta package, update all its
                   10052:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10053:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10054:     newer version (even if found in the FTP) because the meta packages
                   10055:     are supposed to list the exact versions that form a specific GNOME
                   10056:     release.  Exceptions are permitted here if a newer version solves a
                   10057:     serious issue in the overall desktop experience; these typically
                   10058:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10059:     from the developers.</p>
                   10060: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10061:     should be updated to the latest version available (if found in
                   10062:     pkgsrc).  This is the case, for example, of the dependencies on the
                   10063:     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>
                   10064: </li>
1.23      wiz      10065: <li class="listitem">
1.1       dsieger  10066: <p>Generate a patch from the modified meta packages and extract the
                   10067:     list of "new" lines.  This will provide you an outline on what
                   10068:     packages need to be updated in pkgsrc and in what order:</p>
                   10069: <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>
                   10070: </li>
1.23      wiz      10071: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  10072:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      10073: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  10074:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10075:     it in order.  For major desktop updates none of these should be
                   10076:     committed until the entire set is completed because there are chances
                   10077:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      10078: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  10079:     the tree one by one with appropriate log messages.  At the end,
                   10080:     commit the three meta package updates and all the corresponding
                   10081:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10082:     <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>
                   10083: </ol></div>
                   10084: </div>
1.23      wiz      10085: <div class="sect1" title="23.4. Patching guidelines">
1.1       dsieger  10086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10087: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  10088: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10089: packages.  Please, it is very important that you always, always,
                   10090: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  10091: 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  10092: their attention on portability issues and to ensure that future versions
                   10093: can be built out-of-the box on NetBSD.  The less custom patches in
                   10094: pkgsrc, the easier further updates are.  Those developers in charge of
                   10095: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  10096: <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  10097: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10098: of them do.  Do not be short on your reports: always provide detailed
                   10099: explanations of the current failure, how it can be improved to achieve
                   10100: maximum portability and, if at all possible, provide a patch against CVS
                   10101: head.  The more verbose you are, the higher chances of your patch being
                   10102: accepted.</p>
                   10103: <p>Also, please avoid using preprocessor magic to fix portability
                   10104: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10105: GNOME to their operating system, the official GNOME sources are now
                   10106: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10107: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  10108: 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  10109: details.</p>
                   10110: </div>
                   10111: </div>
                   10112: </div>
1.23      wiz      10113: <div class="part" title="Part III. The pkgsrc infrastructure internals">
1.1       dsieger  10114: <div class="titlepage"><div><div><h1 class="title">
                   10115: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.23      wiz      10116: <div class="partintro" title="The pkgsrc infrastructure internals">
1.1       dsieger  10117: <div></div>
                   10118: <p>This part of the guide deals with everything
                   10119:        from the infrastructure that is behind the interfaces described
                   10120:        in the developer's guide. A casual package maintainer should not
                   10121:        need anything from this part.</p>
                   10122: <div class="toc">
                   10123: <p><b>Table of Contents</b></p>
                   10124: <dl>
1.6       rillig   10125: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10126: <dd><dl>
1.6       rillig   10127: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10128: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10129: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10130: <dd><dl>
1.6       rillig   10131: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10132: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10133: </dl></dd>
1.6       rillig   10134: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10135: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10136: <dd><dl>
1.6       rillig   10137: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10138: <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  10139: </dl></dd>
1.6       rillig   10140: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10141: <dd><dl>
1.23      wiz      10142: <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>
                   10143: <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  10144: </dl></dd>
                   10145: </dl></dd>
1.6       rillig   10146: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10147: <dd><dl>
1.6       rillig   10148: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10149: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10150: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10151: <dd><dl>
1.6       rillig   10152: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10153: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10154: </dl></dd>
                   10155: </dl></dd>
1.6       rillig   10156: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10157: <dd><dl>
1.6       rillig   10158: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10159: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10160: </dl></dd>
                   10161: </dl>
                   10162: </div>
                   10163: </div>
1.23      wiz      10164: <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
1.1       dsieger  10165: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10166: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10167: <div class="toc">
                   10168: <p><b>Table of Contents</b></p>
                   10169: <dl>
1.6       rillig   10170: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10171: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10172: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10173: <dd><dl>
1.6       rillig   10174: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10175: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10176: </dl></dd>
1.6       rillig   10177: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10178: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10179: <dd><dl>
1.6       rillig   10180: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10181: <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  10182: </dl></dd>
1.6       rillig   10183: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10184: <dd><dl>
1.23      wiz      10185: <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>
                   10186: <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  10187: </dl></dd>
                   10188: </dl>
                   10189: </div>
                   10190: <p>The pkgsrc infrastructure consists of many small Makefile
                   10191:        fragments. Each such fragment needs a properly specified
                   10192:        interface. This chapter explains how such an interface looks
                   10193:        like.</p>
1.23      wiz      10194: <div class="sect1" title="24.1. The meaning of variable definitions">
1.1       dsieger  10195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10196: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10197: <p>Whenever a variable is defined in the pkgsrc
                   10198:        infrastructure, the location and the way of definition provide
                   10199:        much information about the intended use of that variable.
                   10200:        Additionally, more documentation may be found in a header
                   10201:        comment or in this pkgsrc guide.</p>
                   10202: <p>A special file is
                   10203:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10204:        variables that are intended to be user-defined. They are either
                   10205:        defined using the <code class="literal">?=</code> operator or they are
                   10206:        left undefined because defining them to anything would
1.23      wiz      10207:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10208:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10209:        file.</p>
                   10210: <p>Outside this file, the following conventions apply:
                   10211:        Variables that are defined using the <code class="literal">?=</code>
                   10212:        operator may be overridden by a package.</p>
                   10213: <p>Variables that are defined using the <code class="literal">=</code>
                   10214:        operator may be used read-only at run-time.</p>
                   10215: <p>Variables whose name starts with an underscore must not be
                   10216:        accessed outside the pkgsrc infrastructure at all. They may
                   10217:        change without further notice.</p>
1.23      wiz      10218: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10219: <h3 class="title">Note</h3>
                   10220: <p>These conventions are currently not applied
                   10221:        consistently to the complete pkgsrc
                   10222:        infrastructure.</p>
                   10223: </div>
                   10224: </div>
1.23      wiz      10225: <div class="sect1" title="24.2. Avoiding problems before they arise">
1.1       dsieger  10226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10227: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10228: <p>All variables that contain lists of things should default
                   10229:        to being empty. Two examples that do not follow this rule are
                   10230:        <code class="varname">USE_LANGUAGES</code> and
                   10231:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10232:        modified using the <code class="literal">+=</code> operator in package
                   10233:        <code class="filename">Makefile</code>s (or other files included by
                   10234:        them), since there is no guarantee whether the variable is
                   10235:        already set or not, and what its value is. In the case of
1.23      wiz      10236:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10237:        the default value and just define it as in the following
                   10238:        example.</p>
                   10239: <pre class="programlisting">
                   10240: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10241: </pre>
                   10242: <p>Because of the selection of this default value, the same
                   10243:        value appears in many package Makefiles. Similarly for
                   10244:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10245:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10246:        doesn't stand out. Nevertheless it is mentioned in many
                   10247:        files.</p>
                   10248: </div>
1.23      wiz      10249: <div class="sect1" title="24.3. Variable evaluation">
1.1       dsieger  10250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10251: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.23      wiz      10252: <div class="sect2" title="24.3.1. At load time">
1.1       dsieger  10253: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10254: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10255: <p>Variable evaluation takes place either at load time or at
                   10256:        runtime, depending on the context in which they occur. The
                   10257:        contexts where variables are evaluated at load time are:</p>
1.23      wiz      10258: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   10259: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10260:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10261: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10262:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10263: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10264: </ul></div>
                   10265: <p>A special exception are references to the iteration
                   10266:        variables of <code class="literal">.for</code> loops, which are expanded
                   10267:        inline, no matter in which context they appear.</p>
                   10268: <p>As the values of variables may change during load time,
                   10269:        care must be taken not to evaluate them by accident. Typical
                   10270:        examples for variables that should not be evaluated at load time
                   10271:        are <code class="varname">DEPENDS</code> and
                   10272:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10273:        clear, here is an example:</p>
                   10274: <pre class="programlisting">
                   10275: CONFIGURE_ARGS=         # none
                   10276: CFLAGS=                 -O
                   10277: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10278: 
                   10279: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10280: 
                   10281: CFLAGS+=                -Wall
                   10282:        </pre>
                   10283: <p>This code shows how the use of the <code class="literal">:=</code>
                   10284:        operator can quickly lead to unexpected results. The first
                   10285:        paragraph is fairly common code. The second paragraph evaluates
                   10286:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10287:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10288:        <code class="literal">-Wall</code> is appended to the
                   10289:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10290:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10291:        paragraphs from above typically occur in completely unrelated
                   10292:        files.</p>
                   10293: </div>
1.23      wiz      10294: <div class="sect2" title="24.3.2. At runtime">
1.1       dsieger  10295: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10296: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10297: <p>After all the files have been loaded, the values of the
                   10298:        variables cannot be changed anymore. Variables that are used in
                   10299:        the shell commands are expanded at this point.</p>
                   10300: </div>
                   10301: </div>
1.23      wiz      10302: <div class="sect1" title="24.4. How can variables be specified?">
1.1       dsieger  10303: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10304: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10305: <p>There are many ways in which the definition and use of a
                   10306:        variable can be restricted in order to detect bugs and
                   10307:        violations of the (mostly unwritten) policies. See the
                   10308:        <code class="literal">pkglint</code> developer's documentation for further
                   10309:        details.</p>
                   10310: </div>
1.23      wiz      10311: <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
1.1       dsieger  10312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10313: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10314: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10315:        of the following classes. Cases where a file falls into more
                   10316:        than one class should be avoided as it often leads to subtle
                   10317:        bugs.</p>
1.23      wiz      10318: <div class="sect2" title="24.5.1. Procedures with parameters">
1.1       dsieger  10319: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10320: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10321: <p>In a traditional imperative programming language some of
                   10322:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10323:        procedures. They take some input parameters and&mdash;after
                   10324:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10325:        variables in <code class="filename">Makefile</code>s have global scope
                   10326:        care must be taken not to use parameter names that have already
                   10327:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10328:        bad choice for a parameter name.</p>
                   10329: <p>Procedures are completely evaluated at preprocessing time.
                   10330:        That is, when calling a procedure all input parameters must be
                   10331:        completely resolvable. For example,
                   10332:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10333:        parameter since it is very likely that further text will be
                   10334:        added after calling the procedure, which would effectively apply
                   10335:        the procedure to only a part of the variable. Also, references
                   10336:        to other variables wit will be modified after calling the
                   10337:        procedure.</p>
                   10338: <p>A procedure can declare its output parameters either as
                   10339:        suitable for use in preprocessing directives or as only
                   10340:        available at runtime. The latter alternative is for variables
                   10341:        that contain references to other runtime variables.</p>
                   10342: <p>Procedures shall be written such that it is possible to
                   10343:        call the procedure more than once. That is, the file must not
                   10344:        contain multiple-inclusion guards.</p>
                   10345: <p>Examples for procedures are
                   10346:        <code class="filename">mk/bsd.options.mk</code> and
                   10347:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10348:        that the parameters are evaluated at load time, they should be
                   10349:        assigned using the <code class="literal">:=</code> operator, which should
                   10350:        be used only for this purpose.</p>
                   10351: </div>
1.23      wiz      10352: <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
1.1       dsieger  10353: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10354: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10355: <p>Action files take some input parameters and may define
                   10356:        runtime variables. They shall not define loadtime variables.
                   10357:        There are action files that are included implicitly by the
                   10358:        pkgsrc infrastructure, while other must be included
                   10359:        explicitly.</p>
                   10360: <p>An example for action files is
                   10361:        <code class="filename">mk/subst.mk</code>.</p>
                   10362: </div>
                   10363: </div>
1.23      wiz      10364: <div class="sect1" title="24.6. The order in which files are loaded">
1.1       dsieger  10365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10366: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10367: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10368:        a set of variable definitions, and include the file
                   10369:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10370:        Before that, they may also include various other
                   10371:        <code class="filename">*.mk</code> files if they need to query the
                   10372:        availability of certain features like the type of compiler or
                   10373:        the X11 implementation. Due to the heavy use of preprocessor
                   10374:        directives like <code class="literal">.if</code> and
                   10375:        <code class="literal">.for</code>, the order in which the files are loaded
                   10376:        matters.</p>
                   10377: <p>This section describes at which point the various files
                   10378:        are loaded and gives reasons for that order.</p>
1.23      wiz      10379: <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
1.1       dsieger  10380: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10381: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10382: </h3></div></div></div>
                   10383: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10384:        is to define some essential variables like
                   10385:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10386:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10387: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10388:        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   10389:        After that, those variables
1.1       dsieger  10390:        that have not been overridden by the user are loaded from
                   10391:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10392: <p>After the user settings, the system settings and platform
                   10393:        settings are loaded, which may override the user
                   10394:        settings.</p>
                   10395: <p>Then, the tool definitions are loaded. The tool wrappers
                   10396:        are not yet in effect. This only happens when building a
                   10397:        package, so the proper variables must be used instead of the
                   10398:        direct tool names.</p>
                   10399: <p>As the last steps, some essential variables from the
                   10400:        wrapper and the package system flavor are loaded, as well as the
                   10401:        variables that have been cached in earlier phases of a package
                   10402:        build.</p>
                   10403: </div>
1.23      wiz      10404: <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
1.1       dsieger  10405: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10406: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10407: </h3></div></div></div>
                   10408: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10409: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10410:        loaded, which fill default values for those variables that have
                   10411:        not been defined by the package. These variables may later
                   10412:        be used even in unrelated files.</p>
                   10413: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10414:        provides the target <code class="literal">error-check</code> that is added
                   10415:        as a special dependency to all other targets that use
                   10416:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10417:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10418: <p>Then, the package-specific hacks from
                   10419:        <code class="filename">hacks.mk</code> are included.</p>
                   10420: <p>Then, various other files follow. Most of them don't have
                   10421:        any dependencies on what they need to have included before or
                   10422:        after them, though some do.</p>
                   10423: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10424:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10425:        restricts the use of these variables to all the files that have
                   10426:        been included before. Appearances in later files will be
                   10427:        silently ignored.</p>
                   10428: <p>Then, the files for the main targets are included, in the
                   10429:        order of later execution, though the actual order should not
                   10430:        matter.</p>
                   10431: <p>At last, some more files are included that don't set any
                   10432:        interesting variables but rather just define make targets to be
                   10433:        executed.</p>
                   10434: </div>
                   10435: </div>
                   10436: </div>
1.23      wiz      10437: <div class="chapter" title="Chapter 25. Regression tests">
1.1       dsieger  10438: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10439: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10440: <div class="toc">
                   10441: <p><b>Table of Contents</b></p>
                   10442: <dl>
1.6       rillig   10443: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10444: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10445: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10446: <dd><dl>
1.6       rillig   10447: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10448: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10449: </dl></dd>
                   10450: </dl>
                   10451: </div>
                   10452: <p>The pkgsrc infrastructure consists of a large codebase,
                   10453:        and there are many corners where every little bit of a file is
                   10454:        well thought out, making pkgsrc likely to fail as soon as
                   10455:        anything is changed near those parts. To prevent most changes
                   10456:        from breaking anything, a suite of regression tests should go
                   10457:        along with every important part of the pkgsrc infrastructure.
                   10458:        This chapter describes how regression tests work in pkgsrc and
                   10459:        how you can add new tests.</p>
1.23      wiz      10460: <div class="sect1" title="25.1. The regression tests framework">
1.1       dsieger  10461: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10462: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10463: <p></p>
                   10464: </div>
1.23      wiz      10465: <div class="sect1" title="25.2. Running the regression tests">
1.1       dsieger  10466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10467: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10468: <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  10469:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10470:        can simply run that command, which will run all tests in the
                   10471:        <code class="filename">regress</code> category.</p>
                   10472: </div>
1.23      wiz      10473: <div class="sect1" title="25.3. Adding a new regression test">
1.1       dsieger  10474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10475: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10476: <p>Every directory in the <code class="filename">regress</code>
                   10477:        category that contains a file called <code class="filename">spec</code>
                   10478:        is considered a regression test. This file is a shell program
1.10      hubertf  10479:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10480:        The following functions can be overridden to suit your
                   10481:        needs.</p>
1.23      wiz      10482: <div class="sect2" title="25.3.1. Overridable functions">
1.1       dsieger  10483: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10484: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10485: <p>These functions do not take any parameters. They are all
1.23      wiz      10486:        called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
1.1       dsieger  10487:        to check the exitcodes of any commands you run in the
                   10488:        test.</p>
                   10489: <div class="variablelist"><dl>
                   10490: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10491: <dd><p>This function prepares the environment for the
                   10492:        test. By default it does nothing.</p></dd>
                   10493: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10494: <dd><p>This function runs the actual test. By default,
                   10495:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10496:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10497:        error messages into the file
                   10498:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10499: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10500: <dd><p>This function is run after the test and is
                   10501:        typically used to compare the actual output from the one that is
                   10502:        expected. It can make use of the various helper functions from
                   10503:        the next section.</p></dd>
                   10504: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10505: <dd><p>This function cleans everything up after the
                   10506:        test has been run. By default it does nothing.</p></dd>
                   10507: </dl></div>
                   10508: </div>
1.23      wiz      10509: <div class="sect2" title="25.3.2. Helper functions">
1.1       dsieger  10510: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10511: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1       dsieger  10512: <div class="variablelist"><dl>
                   10513: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10514: <dd><p>This function compares the exitcode of the
1.10      hubertf  10515:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1       dsieger  10516:        If they differ, the test will fail.</p></dd>
                   10517: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10518: <dd><p>This function checks for each of its parameters
1.10      hubertf  10519:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1       dsieger  10520:        extended regular expression. If it does not, the test will
                   10521:        fail.</p></dd>
                   10522: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10523: <dd><p>This function checks for each of its parameters
1.10      hubertf  10524:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10525:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10526:        If any of the regular expressions matches, the test will
                   10527:        fail.</p></dd>
                   10528: </dl></div>
                   10529: </div>
                   10530: </div>
                   10531: </div>
1.23      wiz      10532: <div class="chapter" title="Chapter 26. Porting pkgsrc">
1.1       dsieger  10533: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10534: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10535: <div class="toc">
                   10536: <p><b>Table of Contents</b></p>
                   10537: <dl>
1.6       rillig   10538: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10539: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10540: </dl>
                   10541: </div>
                   10542: <p>The pkgsrc system has already been ported to many
                   10543:        operating systems, hardware architectures and compilers. This
                   10544:        chapter explains the necessary steps to make pkgsrc even more
                   10545:        portable.</p>
1.23      wiz      10546: <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
1.1       dsieger  10547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10548: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10549: <p>To port pkgsrc to a new operating system (called
                   10550:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10551:        following files:</p>
                   10552: <div class="variablelist"><dl>
                   10553: <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>
                   10554: <dd><p>This file contains some basic definitions, for
                   10555:        example the name of the C
                   10556:        compiler.</p></dd>
                   10557: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10558: <dd><p>Insert code that defines the variables
                   10559:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10560:        <code class="varname">LOWER_OS_VERSION</code>,
                   10561:        <code class="varname">LOWER_VENDOR</code>,
                   10562:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10563:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10564:        appear in this file.</p></dd>
                   10565: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10566: <dd><p>This file contains the platform-specific
                   10567:        definitions that are used by pkgsrc. Start by copying one of the
                   10568:        other files and edit it to your
                   10569:        needs.</p></dd>
                   10570: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10571: <dd><p>This file contains a list of directories,
                   10572:        together with their permission bits and ownership. These
                   10573:        directories will be created automatically with every package
                   10574:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10575:        be removed.</p></dd>
                   10576: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10577: <dd><p>Just copy one of the pre-existing x11.dist files
                   10578:        to your
                   10579:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10580: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10581: <dd><p>On some operating systems, the tools that are
                   10582:        provided with the base system are not good enough for pkgsrc.
1.29      dholland 10583:        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  10584:        narrow limit on the line length they can process. Therefore
                   10585:        pkgsrc brings its own tools, which can be enabled
                   10586:        here.</p></dd>
                   10587: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10588: <dd><p>This file defines the paths to all the tools
                   10589:        that are needed by one or the other package in pkgsrc, as well
                   10590:        as by pkgsrc itself. Find out where these tools are on your
                   10591:        platform and add them.</p></dd>
                   10592: </dl></div>
                   10593: <p>Now, you should be able to build some basic packages, like
                   10594:        <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>
                   10595: </div>
1.23      wiz      10596: <div class="sect1" title="26.2. Adding support for a new compiler">
1.1       dsieger  10597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10598: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10599: <p>TODO</p>
                   10600: </div>
                   10601: </div>
                   10602: </div>
1.23      wiz      10603: <div class="appendix" title="Appendix A. A simple example package: bison">
1.1       dsieger  10604: <div class="titlepage"><div><div><h2 class="title">
                   10605: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10606: <div class="toc">
                   10607: <p><b>Table of Contents</b></p>
                   10608: <dl>
                   10609: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10610: <dd><dl>
                   10611: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10612: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10613: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10614: <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  10615: </dl></dd>
                   10616: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10617: </dl>
                   10618: </div>
                   10619: <p>We checked to find a piece of software that wasn't in the packages
                   10620:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10621:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10622:     present in the tree is beyond us, but it's useful for the purposes of
                   10623:     this exercise.</p>
1.23      wiz      10624: <div class="sect1" title="A.1. files">
1.1       dsieger  10625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10626: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.23      wiz      10627: <div class="sect2" title="A.1.1. Makefile">
1.1       dsieger  10628: <div class="titlepage"><div><div><h3 class="title">
                   10629: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10630: <pre class="programlisting">
                   10631: # $NetBSD$
                   10632: #
                   10633: 
                   10634: DISTNAME=       bison-1.25
                   10635: CATEGORIES=     devel
                   10636: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10637: 
1.29      dholland 10638: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10639: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10640: COMMENT=        GNU yacc clone
                   10641: 
                   10642: GNU_CONFIGURE=  yes
                   10643: INFO_FILES=     bison.info
                   10644: 
                   10645: .include "../../mk/bsd.pkg.mk"
                   10646: </pre>
                   10647: </div>
1.23      wiz      10648: <div class="sect2" title="A.1.2. DESCR">
1.1       dsieger  10649: <div class="titlepage"><div><div><h3 class="title">
                   10650: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10651: <pre class="programlisting">
                   10652: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.29      dholland 10653: 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  10654: of the NetBSD source tree is beyond me.
                   10655: </pre>
                   10656: </div>
1.23      wiz      10657: <div class="sect2" title="A.1.3. PLIST">
1.1       dsieger  10658: <div class="titlepage"><div><div><h3 class="title">
                   10659: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10660: <pre class="programlisting">
                   10661: @comment $NetBSD$
                   10662: bin/bison
                   10663: man/man1/bison.1.gz
                   10664: share/bison.simple
                   10665: share/bison.hairy
                   10666: </pre>
                   10667: </div>
1.23      wiz      10668: <div class="sect2" title="A.1.4. Checking a package with pkglint">
1.1       dsieger  10669: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10670: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10671: </h3></div></div></div>
                   10672: <p>The NetBSD package system comes with
                   10673:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10674:        which helps to check the contents of these
                   10675:        files. After installation it is quite easy to use, just change to the
                   10676:        directory of the package you wish to examine and execute
1.10      hubertf  10677:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10678: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10679: looks fine.</pre>
                   10680: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10681:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10682:        -Wall</strong></span> for a very thorough check.</p>
                   10683: </div>
                   10684: </div>
1.23      wiz      10685: <div class="sect1" title="A.2. Steps for building, installing, packaging">
1.1       dsieger  10686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10687: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10688: <p>Create the directory where the package lives,
                   10689:       plus any auxiliary directories:</p>
                   10690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10691: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10692: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10693: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10694: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  10695:       <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  10696:       then continue with fetching the distfile:</p>
                   10697: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10698: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10699: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10700: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10701: ftp: Error retrieving file: 500 Internal error
                   10702: 
                   10703: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10704: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10705: ftp: Error retrieving file: 500 Internal error
                   10706: 
                   10707: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10708: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10709: Successfully retrieved file.</pre>
                   10710: <p>Generate the checksum of the distfile into
                   10711:       <code class="filename">distinfo</code>:</p>
                   10712: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10713: <p>Now compile:</p>
                   10714: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10715: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10716: ===&gt;  Extracting for bison-1.25
                   10717: ===&gt;  Patching for bison-1.25
                   10718: ===&gt;   Ignoring empty patch directory
                   10719: ===&gt;  Configuring for bison-1.25
                   10720: creating cache ./config.cache
                   10721: checking for gcc... cc
                   10722: checking whether we are using GNU C... yes
                   10723: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10724: checking how to run the C preprocessor... cc -E
                   10725: checking for minix/config.h... no
                   10726: checking for POSIXized ISC... no
                   10727: checking whether cross-compiling... no
                   10728: checking for ANSI C header files... yes
                   10729: checking for string.h... yes
                   10730: checking for stdlib.h... yes
                   10731: checking for memory.h... yes
                   10732: checking for working const... yes
                   10733: checking for working alloca.h... no
                   10734: checking for alloca... yes
                   10735: checking for strerror... yes
                   10736: updating cache ./config.cache
                   10737: creating ./config.status
                   10738: creating Makefile
                   10739: ===&gt;  Building for bison-1.25
                   10740: 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
                   10741: 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
                   10742: 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
                   10743: 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
                   10744: 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
                   10745: 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
                   10746: 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
                   10747: 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
                   10748: 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
                   10749: 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
                   10750: 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
                   10751: 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
                   10752: 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
                   10753: 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
                   10754: 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
                   10755: 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
                   10756: 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
                   10757: 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
                   10758: 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
                   10759: 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
                   10760: 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
                   10761: 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
                   10762: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10763: rm -f bison.s1
                   10764: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10765: <p>Everything seems OK, so install the files:</p>
                   10766: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10767: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10768: ===&gt;  Installing for bison-1.25
                   10769: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10770: rm -f /usr/pkg/bin/bison
                   10771: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10772: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10773: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10774: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10775: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10776: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10777: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10778: ===&gt;  Registering installation for bison-1.25</pre>
                   10779: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10780:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10781:       binary package, do this now:</p>
                   10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10783: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10784: ===&gt;  Building package for bison-1.25
                   10785: Creating package bison-1.25.tgz
                   10786: Registering depends:.
                   10787: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10788: <p>Now that you don't need the source and object files
                   10789:       any more, clean up:</p>
                   10790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10791: ===&gt;  Cleaning for bison-1.25</pre>
                   10792: </div>
                   10793: </div>
1.23      wiz      10794: <div class="appendix" title="Appendix B. Build logs">
1.1       dsieger  10795: <div class="titlepage"><div><div><h2 class="title">
                   10796: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10797: <div class="toc">
                   10798: <p><b>Table of Contents</b></p>
                   10799: <dl>
                   10800: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10801: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10802: </dl>
                   10803: </div>
1.23      wiz      10804: <div class="sect1" title="B.1. Building figlet">
1.1       dsieger  10805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10806: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10807: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10808: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10809: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10810: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10811: =&gt; [172219 bytes]
                   10812: Connected to ftp.plig.net.
                   10813: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10814: 331 Guest login ok, send your complete e-mail address as password.
                   10815: 230-You are user #5 of 500 simultaneous users allowed.
                   10816: 230-
                   10817: 230-  ___ _             _ _
                   10818: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10819: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10820: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10821: 230-         |_|   |_|     |___|         |___|
                   10822: 230-
                   10823: 230-** Welcome to ftp.plig.org **
                   10824: 230-
                   10825: 230-Please note that all transfers from this FTP site are logged. If you
                   10826: 230-do not like this, please disconnect now.
                   10827: 230-
1.18      snj      10828: 230-This archive is available via
1.1       dsieger  10829: 230-
                   10830: 230-HTTP:  http://ftp.plig.org/
                   10831: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10832: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10833: 230-
                   10834: 230-Please email comments, bug reports and requests for packages to be
                   10835: 230-mirrored to ftp-admin@plig.org.
                   10836: 230-
                   10837: 230-
                   10838: 230 Logged in anonymously.
                   10839: Remote system type is UNIX.
                   10840: Using binary mode to transfer files.
                   10841: 200 Type okay.
                   10842: 250 "/pub" is new cwd.
                   10843: 250-"/pub/figlet" is new cwd.
                   10844: 250-
                   10845: 250-Welcome to the figlet archive at ftp.figlet.org
                   10846: 250-
                   10847: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10848: 250-
                   10849: 250-The official FIGlet web page is:
                   10850: 250-   http://www.figlet.org/
                   10851: 250-
                   10852: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10853: 250-contribute a font or something else, you can email us.
                   10854: 250
                   10855: 250 "/pub/figlet/program" is new cwd.
                   10856: 250 "/pub/figlet/program/unix" is new cwd.
                   10857: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10858: 502 Unimplemented command.
                   10859: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10860: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10861: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10862: 226 Transfer completed.
                   10863: 172219 bytes received in 00:02 (75.99 KB/s)
                   10864: 221 Goodbye.
                   10865: =&gt; Checksum OK for figlet221.tar.gz.
                   10866: ===&gt; Extracting for figlet-2.2.1nb2
                   10867: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10868: ===&gt; Patching for figlet-2.2.1nb2
                   10869: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10870: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10871: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10872: ===&gt; Configuring for figlet-2.2.1nb2
                   10873: ===&gt; Building for figlet-2.2.1nb2
                   10874: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10875: chmod a+x figlet
                   10876: gcc -O2 -o chkfont chkfont.c
                   10877: =&gt; Unwrapping files-to-be-installed.
                   10878: <code class="prompt">#</code>
                   10879: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10880: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10881: ===&gt; Installing for figlet-2.2.1nb2
                   10882: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10883: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10884: mkdir -p /usr/pkg/share/figlet
                   10885: cp figlet /usr/pkg/bin
                   10886: cp chkfont /usr/pkg/bin
                   10887: chmod 555 figlist showfigfonts
                   10888: cp figlist /usr/pkg/bin
                   10889: cp showfigfonts /usr/pkg/bin
                   10890: cp fonts/*.flf /usr/pkg/share/figlet
                   10891: cp fonts/*.flc /usr/pkg/share/figlet
                   10892: cp figlet.6 /usr/pkg/man/man6
                   10893: ===&gt; Registering installation for figlet-2.2.1nb2
                   10894: <code class="prompt">#</code></pre>
                   10895: </div>
1.23      wiz      10896: <div class="sect1" title="B.2. Packaging figlet">
1.1       dsieger  10897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10898: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10899: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10900: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10901: ===&gt; Packaging figlet-2.2.1nb2
                   10902: ===&gt; Building binary package for figlet-2.2.1nb2
                   10903: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10904: Using SrcDir value of /usr/pkg
                   10905: Registering depends:.
                   10906: <code class="prompt">#</code></pre>
                   10907: </div>
                   10908: </div>
1.23      wiz      10909: <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
1.1       dsieger  10910: <div class="titlepage"><div><div><h2 class="title">
                   10911: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10912: <div class="toc">
                   10913: <p><b>Table of Contents</b></p>
                   10914: <dl>
1.23      wiz      10915: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10916: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10917: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10918: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10919: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10920: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10921: source packages</a></span></dt>
                   10922: </dl>
                   10923: </div>
                   10924: <p>As in other big projects, the directory layout of pkgsrc
                   10925:        is quite complex for newbies. This chapter explains where you
                   10926:        find things on the FTP server. The base directory on
1.10      hubertf  10927:        <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  10928:        On other servers it may be different, but inside this directory,
                   10929:        everything should look the same, no matter on which server you
                   10930:        are. This directory contains some subdirectories, which are
                   10931:        explained below.</p>
1.23      wiz      10932: <div class="sect1" title="C.1. distfiles: The distributed source files">
1.1       dsieger  10933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10934: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10935: <p>The directory <code class="filename">distfiles</code> contains lots
                   10936:        of archive files from all pkgsrc packages, which are mirrored
                   10937:        here. The subdirectories are called after their package names
                   10938:        and are used when the distributed files have names that don't
                   10939:        explicitly contain a version number or are otherwise too generic
                   10940:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10941: </div>
1.23      wiz      10942: <div class="sect1" title="C.2. misc: Miscellaneous things">
1.1       dsieger  10943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10944: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10945: <p>This directory contains things that individual pkgsrc
                   10946:        developers find worth publishing.</p>
                   10947: </div>
1.23      wiz      10948: <div class="sect1" title="C.3. packages: Binary packages">
1.1       dsieger  10949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10950: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10951: <p>This directory contains binary packages for the various
                   10952:        platforms that are supported by pkgsrc.
                   10953:        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      10954: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   10955: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10956:        operating system for which the packages have been built. The
1.10      hubertf  10957:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10958:        command, so it may differ from the one you are used to
                   10959:        hear.</p></li>
1.23      wiz      10960: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10961:        architecture of the platform for which the packages have been
1.10      hubertf  10962:        built. It also includes the <code class="varname">ABI</code> (Application
                   10963:        Binary Interface) for platforms that have several of
                   10964:        them.</p></li>
1.23      wiz      10965: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10966:        the operating system. For version numbers that change often (for
                   10967:        example NetBSD-current), the often-changing part should be
                   10968:        replaced with an <code class="literal">x</code>, for example
                   10969:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10970: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10971:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10972:        for a stable branch, or <code class="literal">head</code> for packages
                   10973:        built from the HEAD branch. The latter should only be used when
                   10974:        the packages are updated on a regular basis. Otherwise the date
                   10975:        from checking out pkgsrc should be appended, for example
                   10976:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10977: </ul></div>
                   10978: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10979:        can quickly click through the directories on the
                   10980:        server and find the best binary packages for their machines. Since they
                   10981:        usually know the operating system and the hardware architecture, OPSYS
                   10982:        and ARCH are placed first. After these choices, they can select the
                   10983:        best combination of OSVERSION and TAG together, since it is usually the
                   10984:        case that packages stay compatible between different version of the
                   10985:        operating system.</p>
                   10986: <p>In each of these directories, there is a
                   10987:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  10988:        <code class="filename">All</code> which contains all binary packages.
                   10989:        Besides that, there are various category directories that
                   10990:        contain symbolic links to the real binary packages.</p>
                   10991: </div>
1.23      wiz      10992: <div class="sect1" title="C.4. reports: Bulk build reports">
1.1       dsieger  10993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10994: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   10995: <p>Here are the reports from bulk builds, for those who want
                   10996:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      10997:        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   10998: </div>
1.23      wiz      10999: <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
1.8       rillig   11000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11001: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11002: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11003: source packages</h2></div></div></div>
1.23      wiz      11004: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11005:        that is the files that define how to create binary packages from
                   11006:        source archives.</p>
                   11007: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11008:        snapshot of the CVS repository, which is updated regularly. The
                   11009:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11010:        directory, ready to be downloaded as a whole.</p>
                   11011: <p>In the directories for the quarterly branches, there is an
                   11012:        additional file called
1.22      jakllsch 11013:        <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  11014:        which contains the state of pkgsrc when it was branched.</p>
                   11015: </div>
                   11016: </div>
1.23      wiz      11017: <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
1.1       dsieger  11018: <div class="titlepage"><div><div><h2 class="title">
                   11019: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11020: <div class="toc">
                   11021: <p><b>Table of Contents</b></p>
                   11022: <dl>
                   11023: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   11024: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11025: </dl>
                   11026: </div>
                   11027: <p>This section contains information on editing the pkgsrc
                   11028:        guide itself.</p>
1.23      wiz      11029: <div class="sect1" title="D.1. Make targets">
1.1       dsieger  11030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11031: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11032: <p>The pkgsrc guide's source code is stored in
                   11033:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11034:        are created from it:</p>
1.23      wiz      11035: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   11036: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11037: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11038: <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>
                   11039: <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  11040:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      11041: <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  11042:        PostScript version of the pkgsrc guide.</p></li>
                   11043: </ul></div>
                   11044: </div>
1.23      wiz      11045: <div class="sect1" title="D.2. Procedure">
1.1       dsieger  11046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11047: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   11048: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      11049: <div class="procedure"><ol class="procedure" type="1">
                   11050: <li class="step" title="Step 1"><p>Make sure you have the packages needed to
1.1       dsieger  11051:        regenerate the pkgsrc guide (and other XML-based NetBSD
                   11052:        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
                   11053:        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
                   11054:        PostScript and PDF versions. You will need both packages
                   11055:        installed, to make sure documentation is consistent across all
                   11056:        formats.</p></li>
1.23      wiz      11057: <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  11058:        right directory. All further steps will take place
                   11059:        here.</p></li>
1.23      wiz      11060: <li class="step" title="Step 3"><p>Edit the XML file(s) in
1.1       dsieger  11061:        <code class="filename">files/</code>.</p></li>
1.23      wiz      11062: <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  11063:        guide for valid XML and to build the final output files. If you
                   11064:        get any errors at this stage, you can just edit the files, as
                   11065:        there are only symbolic links in the working directory, pointing
                   11066:        to the files in <code class="filename">files/</code>.</p></li>
1.23      wiz      11067: <li class="step" title="Step 5"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  11068:        commit)</strong></span></p></li>
1.23      wiz      11069: <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  11070:        regenerate the output files with the proper RCS
                   11071:        Ids.</p></li>
1.23      wiz      11072: <li class="step" title="Step 7">
1.10      hubertf  11073: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  11074:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11075:        <code class="filename">htdocs</code>.</p>
1.23      wiz      11076: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  11077: <h3 class="title">Note</h3>
                   11078: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  11079:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11080:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  11081:        directory.</p>
                   11082: </div>
                   11083: </li>
                   11084: </ol></div>
                   11085: </div>
                   11086: </div>
                   11087: </div></body>
                   11088: </html>

CVSweb <webmaster@jp.NetBSD.org>