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

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.41      asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
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.41      asau       35: <div><div class="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>
1.45      obache     82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.7. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.8. Solaris</a></span></dt>
1.1       dsieger    90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   118: <dd><dl>
1.4       rillig    119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   122: </dl></dd>
1.4       rillig    123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.1       dsieger   133: <dd><dl>
1.6       rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    148: <dd><dl>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    151: </dl></dd>
1.6       rillig    152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    154: </dl></dd>
                    155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    156: <dd><dl>
1.23      wiz       157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    158: <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    159: </dl></dd>
                    160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    161: <dd><dl>
                    162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    167: <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>
                    168: <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       169: <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    170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       171: <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
                    172: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    173: <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    174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       177: <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    178: <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       179: <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   180: </dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    183: <dd><dl>
1.6       rillig    184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   185: <dd><dl>
1.6       rillig    186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   187: <dd><dl>
1.6       rillig    188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil      190: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger   191: </dl></dd>
1.6       rillig    192: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    193: <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>
                    194: </dl></dd>
                    195: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    196: <dd><dl>
1.23      wiz       197: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    198: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig    199: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    200: <dd><dl>
                    201: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    205: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    206: </dl></dd>
                    207: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    208: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    209: <dd><dl>
                    210: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    212: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    213: </dl></dd>
1.23      wiz       214: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    215: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig    216: </dl></dd>
1.23      wiz       217: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    218: <dd><dl>
                    219: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz       220: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig    221: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    222: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    223: <dd><dl>
                    224: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    226: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    227: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    228: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    229: </dl></dd>
                    230: </dl></dd>
                    231: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    232: <dd><dl>
                    233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz       234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    235: <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    236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz       238: <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    239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    241: </dl></dd>
                    242: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    243: <dd><dl>
                    244: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz       245: <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    246: <dd><dl>
                    247: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz       248: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    249:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    250:       and
                    251:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    252:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    253: </dl></dd>
1.23      wiz       254: <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    255: <dd><dl>
1.23      wiz       256: <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    257: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    258: </dl></dd>
                    259: </dl></dd>
                    260: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    261: <dd><dl>
                    262: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    263: <dd><dl>
                    264: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    265: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    266: </dl></dd>
                    267: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    268: <dd><dl>
1.23      wiz       269: <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    270: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    271: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    272: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    273: </dl></dd>
                    274: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    275: <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>
                    276: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    277: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    278: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    279: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    280: <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>
                    281: </dl></dd>
                    282: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    283: <dd><dl>
                    284: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz       285: <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    286: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    287: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    288: </dl></dd>
                    289: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    290: <dd><dl>
                    291: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz       295: <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    296: <dd><dl>
                    297: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    298: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    299: </dl></dd>
1.23      wiz       300: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    306: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    308: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    309: <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    310: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    311: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    312: </dl></dd>
                    313: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    314: <dd><dl>
                    315: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    316: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    317: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    318: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    319: </dl></dd>
                    320: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    321: <dd><dl>
                    322: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    323: <dd><dl>
                    324: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz       325: <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    326: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    327: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    328: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    329: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    330: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    331: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    332: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    333: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    334: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    335: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    336: </dl></dd>
1.23      wiz       337: <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    338: <dd><dl>
                    339: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    340: <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>
                    341: </dl></dd>
1.23      wiz       342: <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    343: <dd><dl>
                    344: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    345: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    346: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    347: </dl></dd>
                    348: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    349: <dd><dl>
                    350: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    351: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    352: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz       353: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    354: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig    355: </dl></dd>
1.23      wiz       356: <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    357: <dd><dl>
                    358: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    359: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz       360: <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    361: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    362: </dl></dd>
1.23      wiz       363: <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    364: <dd><dl>
                    365: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    366: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    367: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    368: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    369: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    370: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    371: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    372: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    373: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj       374: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig    375: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    376: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    377: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    378: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    379: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    380: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    381: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    382: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   383:     emulation</a></span></dt>
1.6       rillig    384: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    385: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   386: </dl></dd>
1.6       rillig    387: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   388: </dl></dd>
1.6       rillig    389: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    390: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   391: <dd><dl>
1.6       rillig    392: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    394: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz       395: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig    396: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj       397: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    398: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig    399: </dl></dd>
                    400: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    401: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    402: <dd><dl>
                    403: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    404: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    405: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    406: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   407: </dl></dd>
                    408: </dl></dd>
                    409: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    410: <dd><dl>
1.6       rillig    411: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   412: <dd><dl>
1.6       rillig    413: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    414: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    415: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   416: <dd><dl>
1.6       rillig    417: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    418: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   419: </dl></dd>
1.6       rillig    420: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    421: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   422: <dd><dl>
1.6       rillig    423: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    424: <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   425: </dl></dd>
1.6       rillig    426: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   427: <dd><dl>
1.23      wiz       428: <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>
                    429: <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   430: </dl></dd>
                    431: </dl></dd>
1.6       rillig    432: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   433: <dd><dl>
1.6       rillig    434: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    435: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    436: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   437: <dd><dl>
1.6       rillig    438: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    439: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   440: </dl></dd>
                    441: </dl></dd>
1.6       rillig    442: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   443: <dd><dl>
1.6       rillig    444: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    445: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   446: </dl></dd>
                    447: </dl></dd>
                    448: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    449: <dd><dl>
                    450: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    451: <dd><dl>
                    452: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    453: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    454: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       455: <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   456: </dl></dd>
                    457: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    458: </dl></dd>
                    459: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    460: <dd><dl>
                    461: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    462: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    463: </dl></dd>
                    464: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    465: <dd><dl>
1.23      wiz       466: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    467: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    468: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    469: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    470: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    471: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   472: source packages</a></span></dt>
                    473: </dl></dd>
                    474: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    475: <dd><dl>
                    476: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    477: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    478: </dl></dd>
                    479: </dl>
                    480: </div>
                    481: <div class="list-of-tables">
                    482: <p><b>List of Tables</b></p>
                    483: <dl>
                    484: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    485: </dt>
1.6       rillig    486: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   487: </dt>
1.6       rillig    488: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   489: </dt>
                    490: </dl>
                    491: </div>
1.41      asau      492: <div class="chapter">
                    493: <div class="titlepage"><div><div><h1 class="title">
                    494: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1       dsieger   495: <div class="toc">
                    496: <p><b>Table of Contents</b></p>
                    497: <dl>
                    498: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    499: <dd><dl>
                    500: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    501: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    502: </dl></dd>
                    503: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    504: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    505: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    506: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    507: </dl>
                    508: </div>
1.41      asau      509: <div class="sect1">
1.1       dsieger   510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    511: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    512: <p>There is a lot of software freely available for Unix-based
                    513: systems, which is usually available in form of the source code. Before
                    514: such software can be used, it needs to be configured to the local
                    515: system, compiled and installed, and this is exactly what The NetBSD
                    516: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    517: to handle binary packages, so that not every user has to build the
                    518: packages for himself, which is a time-costly task.</p>
                    519: <p>pkgsrc currently contains several thousand packages,
                    520:       including:</p>
1.41      asau      521: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       522: <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   523:          web server</p></li>
1.23      wiz       524: <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   525:          web browser</p></li>
1.23      wiz       526: <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   527:          Desktop Environment</p></li>
1.23      wiz       528: <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   529:          Desktop Environment</p></li>
                    530: </ul></div>
                    531: <p>...just to name a few.</p>
                    532: <p>pkgsrc has built-in support for handling varying dependencies,
                    533:       such as pthreads and X11, and extended features such as IPv6 support on
                    534:       a range of platforms.</p>
1.41      asau      535: <div class="sect2">
1.1       dsieger   536: <div class="titlepage"><div><div><h3 class="title">
                    537: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    538: <p>
                    539: pkgsrc provides the following key features:
                    540: </p>
1.41      asau      541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       542: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   543:   and installation of binary packages. The source and latest
                    544:   patches are retrieved from a master or mirror download site, checksum
                    545:   verified, then built on your system. Support for binary-only
                    546:   distributions is available for both native platforms and NetBSD
                    547:   emulated platforms.</p></li>
1.23      wiz       548: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   549:   including binaries, libraries, man pages and other
                    550:   documentation.</p></li>
1.23      wiz       551: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1       dsieger   552:   are handled automatically. The configuration files of various
                    553:   packages are handled automatically during updates, so local changes
                    554:   are preserved.</p></li>
1.23      wiz       555: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   556:   consists of highly portable code. This allows the greatest speed of
1.25      spz       557:   development when porting to a new platform. This portability also
1.1       dsieger   558:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    559:   platforms</em></span>.</p></li>
1.23      wiz       560: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   561:   international encryption requirements and build-time options for a
                    562:   large number of packages are all set in a simple, central
                    563:   configuration file.</p></li>
1.23      wiz       564: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   565:   freely available under a BSD license, so you may extend and adapt
                    566:   pkgsrc to your needs. Support for local packages and patches is
                    567:   available right out of the box, so you can configure it specifically
                    568:   for your environment.</p></li>
                    569: </ul></div>
                    570: <p>The following principles are basic to pkgsrc:</p>
1.41      asau      571: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       572: <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  573: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   574: them and to complain about them rather than to just install the package
                    575: and hope that it works. There are numerous checks in pkgsrc that try to
                    576: 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
                    577: of shell scripts), and post-installation checks (installed files,
                    578: references to shared libraries, script interpreters).</p></li>
1.23      wiz       579: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  580: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   581: pkgsrc has been ported to many operating systems. Care is taken that
                    582: packages behave the same on all platforms.</p></li>
                    583: </ul></div>
                    584: </div>
1.41      asau      585: <div class="sect2">
1.1       dsieger   586: <div class="titlepage"><div><div><h3 class="title">
                    587: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    588: <p>pkgsrc consists of both a source distribution and a binary
                    589: distribution for these operating systems. After retrieving the required
                    590: source or binaries, you can be up and running with pkgsrc in just
                    591: minutes!</p>
                    592: <p>pkgsrc was derived from FreeBSD's ports system, and
                    593:       initially developed for NetBSD only. Since then, pkgsrc has
                    594:       grown a lot, and now supports the following platforms:</p>
                    595: <div class="table">
                    596: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    597: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    598: <colgroup>
                    599: <col>
                    600: <col>
                    601: </colgroup>
                    602: <thead><tr>
                    603: <th>Platform</th>
                    604: <th>Date Support Added</th>
                    605: </tr></thead>
                    606: <tbody>
                    607: <tr>
1.10      hubertf   608: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   609: <td align="center">Aug 1997</td>
                    610: </tr>
                    611: <tr>
1.10      hubertf   612: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   613: <td align="center">Mar 1999</td>
                    614: </tr>
                    615: <tr>
1.10      hubertf   616: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   617: <td align="center">Jun 1999</td>
                    618: </tr>
                    619: <tr>
                    620: <td>
1.10      hubertf   621:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    622:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1       dsieger   623:         </td>
                    624: <td align="center">Oct 2001</td>
                    625: </tr>
                    626: <tr>
1.10      hubertf   627: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   628: <td align="center">Nov 2002</td>
                    629: </tr>
                    630: <tr>
1.10      hubertf   631: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   632: <td align="center">Nov 2002</td>
                    633: </tr>
                    634: <tr>
1.10      hubertf   635: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   636: <td align="center">Dec 2002</td>
                    637: </tr>
                    638: <tr>
                    639: <td>BSD/OS</td>
                    640: <td align="center">Dec 2003</td>
                    641: </tr>
                    642: <tr>
1.10      hubertf   643: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   644: <td align="center">Dec 2003</td>
                    645: </tr>
                    646: <tr>
                    647: <td>
1.10      hubertf   648:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   649:           (Microsoft Windows Services for Unix)
                    650:         </td>
                    651: <td align="center">Mar 2004</td>
                    652: </tr>
                    653: <tr>
1.10      hubertf   654: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   655: <td align="center">Oct 2004</td>
                    656: </tr>
                    657: <tr>
1.10      hubertf   658: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   659: <td align="center">Nov 2004</td>
                    660: </tr>
                    661: <tr>
1.10      hubertf   662: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   663: <td align="center">Apr 2007</td>
                    664: </tr>
1.23      wiz       665: <tr>
                    666: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    667: <td align="center">Sep 2010</td>
                    668: </tr>
1.45      obache    669: <tr>
                    670: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
                    671: <td align="center">Aug 2011</td>
                    672: </tr>
                    673: <tr>
                    674: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    675: <td align="center">Nov 2011</td>
                    676: </tr>
                    677: <tr>
                    678: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    679: <td align="center">Mar 2013</td>
                    680: </tr>
1.1       dsieger   681: </tbody>
                    682: </table></div>
                    683: </div>
                    684: <br class="table-break">
                    685: </div>
                    686: </div>
1.41      asau      687: <div class="sect1">
1.1       dsieger   688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    689: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    690: <p>This document is divided into three parts. The first,
1.10      hubertf   691:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   692:        describes how one can use one of the packages in the Package
                    693:        Collection, either by installing a precompiled binary package,
                    694:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   695:        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   696:        package so it can be easily built by other NetBSD users without
                    697:        knowing about the package's building details. The third part,
1.10      hubertf   698:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   699:        is intended for those who want to understand how pkgsrc is
                    700:        implemented.</p>
                    701: <p>This document is available in various formats:
1.10      hubertf   702:        <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   703: </div>
1.41      asau      704: <div class="sect1">
1.1       dsieger   705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    706: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       707: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    708:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   709:       terminology used within this document.</p>
1.41      asau      710: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   711: <dt><span class="term">Package</span></dt>
                    712: <dd><p>A set of files and building instructions
                    713:            that describe what's necessary
                    714:            to build a certain piece of software using
                    715:             pkgsrc. Packages are traditionally stored under
                    716:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    717: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       718: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   719:          is part of the NetBSD operating system and can be bootstrapped
                    720:          to run on non-NetBSD operating systems as well.  It handles
                    721:          building (compiling), installing, and removing of
                    722:          packages.</p></dd>
                    723: <dt><span class="term">Distfile</span></dt>
                    724: <dd><p>This term describes the file or files that are
                    725:            provided by the author of the piece of software to
                    726:            distribute his work. All the changes necessary to build on
                    727:            NetBSD are reflected in the corresponding package. Usually
                    728:            the distfile is in the form of a compressed tar-archive,
                    729:            but other types are possible, too. Distfiles are usually
                    730:            stored below
                    731:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    732: <dt><span class="term">Port</span></dt>
                    733: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    734:            for what we call a package.
1.23      wiz       735:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   736:            architecture.</p></dd>
                    737: <dt><span class="term">Precompiled/binary package</span></dt>
                    738: <dd>
                    739: <p>A set of binaries built with pkgsrc from a distfile
                    740:            and stuffed together in a single <code class="filename">.tgz</code>
                    741:            file so it can be installed on machines of the same
                    742:            machine architecture without the need to
                    743:            recompile. Packages are usually generated in
                    744:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       745:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       746: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   747:            especially in the context of precompiled packages.</p>
                    748: </dd>
                    749: <dt><span class="term">Program</span></dt>
                    750: <dd><p>The piece of software to be installed which will be
                    751:          constructed from all the files in the distfile by the
                    752:          actions defined in the corresponding package.</p></dd>
                    753: </dl></div>
1.41      asau      754: <div class="sect2">
1.1       dsieger   755: <div class="titlepage"><div><div><h3 class="title">
                    756: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41      asau      757: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   758: <dt><span class="term">pkgsrc users</span></dt>
                    759: <dd>
                    760: <p>The
                    761:        pkgsrc users are people who use the packages provided by pkgsrc.
                    762:        Typically they are system administrators. The people using the
1.23      wiz       763:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    764:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   765: <p>There are two kinds of pkgsrc users: Some only want to
                    766:        install pre-built binary packages. Others build the pkgsrc
                    767:        packages from source, either for installing them directly or for
1.10      hubertf   768:        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   769:        documentation.</p>
                    770: </dd>
                    771: <dt><span class="term">package maintainers</span></dt>
                    772: <dd><p>A
1.10      hubertf   773:        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   774: <dt><span class="term">infrastructure developers</span></dt>
                    775: <dd><p>These people are involved in all those files
                    776:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   777:        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   778:        too.</p></dd>
                    779: </dl></div>
                    780: </div>
                    781: </div>
1.41      asau      782: <div class="sect1">
1.1       dsieger   783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    784: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    785: <p>When giving examples for commands, shell prompts are used to
                    786:       show if the command should/can be issued as root, or if
1.23      wiz       787:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.1       dsieger   788:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    789:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    790: </div>
                    791: </div>
1.41      asau      792: <div class="part">
1.1       dsieger   793: <div class="titlepage"><div><div><h1 class="title">
                    794: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    795: <div class="toc">
                    796: <p><b>Table of Contents</b></p>
                    797: <dl>
                    798: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    799: <dd><dl>
                    800: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    801: <dd><dl>
                    802: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       803: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   804: </dl></dd>
                    805: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    806: <dd><dl>
                    807: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    808: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    809: </dl></dd>
                    810: </dl></dd>
                    811: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    812: <dd><dl>
                    813: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    814: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    815: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    816: <dd><dl>
1.45      obache    817: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                    818: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                    819: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
                    820: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
                    821: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
                    822: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
                    823: <dt><span class="sect2"><a href="#openbsd">3.3.7. OpenBSD</a></span></dt>
                    824: <dt><span class="sect2"><a href="#solaris">3.3.8. Solaris</a></span></dt>
1.1       dsieger   825: </dl></dd>
                    826: </dl></dd>
                    827: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    828: <dd><dl>
                    829: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    830: <dd><dl>
                    831: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    832: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    833: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    834: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    835: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    836: <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>
                    837: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    838: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    839: </dl></dd>
                    840: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    841: <dd><dl>
                    842: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    843: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    844: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    845: </dl></dd>
                    846: </dl></dd>
                    847: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    848: <dd><dl>
                    849: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    850: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    851: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    852: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   853: <dd><dl>
1.4       rillig    854: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       855: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    856: <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   857: </dl></dd>
1.4       rillig    858: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    859: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   860: </dl></dd>
                    861: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    862: <dd><dl>
                    863: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    864: <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    865: </dl></dd>
                    866: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    867: builds)</a></span></dt>
1.1       dsieger   868: <dd><dl>
1.6       rillig    869: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    870: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    871: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    872: <dd><dl>
                    873: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    874: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    875: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    876: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    877: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    878: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    879: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    880: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    881: </dl></dd>
                    882: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    883: <dd><dl>
                    884: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    885: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    886: </dl></dd>
1.6       rillig    887: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    888: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    889: </dl></dd>
                    890: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    891: <dd><dl>
1.23      wiz       892: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    893: <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    894: </dl></dd>
                    895: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    896: <dd><dl>
                    897: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    898: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    899: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    900: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    901: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    902: <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>
                    903: <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       904: <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    905: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       906: <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
                    907: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    908: <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    909: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    910: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    911: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       912: <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    913: <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       914: <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   915: </dl></dd>
                    916: </dl>
                    917: </div>
1.41      asau      918: <div class="chapter">
1.1       dsieger   919: <div class="titlepage"><div><div><h2 class="title">
                    920: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    921: <div class="toc">
                    922: <p><b>Table of Contents</b></p>
                    923: <dl>
                    924: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    925: <dd><dl>
                    926: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       927: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   928: </dl></dd>
                    929: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    930: <dd><dl>
                    931: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    932: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    933: </dl></dd>
                    934: </dl>
                    935: </div>
                    936: <p>Before you download and extract the files, you need to decide
                    937: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    938: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    939: free to install the sources and binary packages wherever you want in
                    940: your filesystem, provided that the pathname does not contain white-space
                    941: or other characters that are interpreted specially by the shell and some
                    942: other programs. A safe bet is to use only letters, digits, underscores
                    943: and dashes.</p>
1.41      asau      944: <div class="sect1">
1.1       dsieger   945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    946: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    947: <p>Before you download any pkgsrc files, you should decide
                    948:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    949:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    950:        quarterly basis from the current branch and only gets modified
                    951:        for security updates. The names of the stable branches are built
                    952:        from the year and the quarter, for example
1.21      snj       953:        <code class="literal">2009Q1</code>.</p>
1.1       dsieger   954: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       955:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    956:        Both ways are described here.</p>
1.41      asau      957: <div class="sect2">
1.1       dsieger   958: <div class="titlepage"><div><div><h3 class="title">
                    959: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    960: <p>The primary download location for all pkgsrc files is
1.10      hubertf   961:        <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   962:        number of subdirectories for different purposes, which are
1.10      hubertf   963:        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   964: <p>The tar file for the current branch is in the directory
1.10      hubertf   965:        <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   966:        It is autogenerated daily.</p>
1.21      snj       967: <p>The tar file for the stable branch 2009Q1 is in the
                    968:        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    969: <p>To download a pkgsrc stable tarball, run:</p>
                    970: <pre class="screen">
1.22      jakllsch  971: <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>
                    972: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12      weinem    973:        stable branch to be downloaded, for example, 
1.23      wiz       974:        <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</p>
1.12      weinem    975: <p>Then, extract it with:</p>
1.22      jakllsch  976: <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    977: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    978:        in <code class="filename">/usr/</code> and all the package source will be 
                    979:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    980: <p>To download pkgsrc-current, run:</p>
                    981: <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   982: </div>
1.41      asau      983: <div class="sect2">
1.1       dsieger   984: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz       985: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    986: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39      wiz       987: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23      wiz       988: </pre>
                    989: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
                    990:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
                    991: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    992:        in your <code class="filename">/usr/</code> directory and all the package source 
                    993:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    994: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz       995: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger   996: </pre>
1.29      dholland  997: <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       998: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz       999: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23      wiz      1000: </pre>
                   1001: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1002:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1003:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1004: <pre class="programlisting">
                   1005: # set CVS remote shell command
                   1006: CVS_RSH=ssh
                   1007: export CVS_RSH
                   1008: </pre>
                   1009: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1010:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1011:        in your home directory and saving the following lines to it.
                   1012:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1013:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1014: <pre class="programlisting">
                   1015: # recommended CVS configuration file from the pkgsrc guide
1.39      wiz      1016: cvs -q -z2
1.2       rillig   1017: checkout -P
1.4       rillig   1018: update -dP
                   1019: diff -upN
1.2       rillig   1020: rdiff -u
1.23      wiz      1021: release -d
1.2       rillig   1022: </pre>
1.1       dsieger  1023: </div>
                   1024: </div>
1.41      asau     1025: <div class="sect1">
1.1       dsieger  1026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1027: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1028: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1029:        (which also works if you have first installed it via a tar
                   1030:        file). It saves bandwidth and hard disk activity, compared to
                   1031:        downloading the tar file again.</p>
1.41      asau     1032: <div class="sect2">
1.1       dsieger  1033: <div class="titlepage"><div><div><h3 class="title">
                   1034: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41      asau     1035: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1036: <h3 class="title">Warning</h3>
                   1037: <p>When updating from a tar file, you first need to
                   1038:        completely remove the old pkgsrc directory. Otherwise those
                   1039:        files that have been removed from pkgsrc in the mean time will
                   1040:        not be removed on your local disk, resulting in inconsistencies.
                   1041:        When removing the old files, any changes that you have done to
                   1042:        the pkgsrc files will be lost after updating. Therefore updating
                   1043:        via CVS is strongly recommended.</p>
                   1044: </div>
                   1045: <p>Note that by default the distfiles and the binary packages
                   1046:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1047:        before updating. You can also configure pkgsrc to use other than
                   1048:        the default directories by setting the
                   1049:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1050:        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  1051: <p>To update pkgsrc from a tar file, download the tar file as
                   1052:        explained above. Then, make sure that you have not made any
                   1053:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1054:        directory and extract the new tar file. Done.</p>
                   1055: </div>
1.41      asau     1056: <div class="sect2">
1.1       dsieger  1057: <div class="titlepage"><div><div><h3 class="title">
                   1058: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25      spz      1059: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1060: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1061: </pre>
                   1062: <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>
                   1063: <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>
                   1064: </pre>
1.41      asau     1065: <div class="sect3">
1.1       dsieger  1066: <div class="titlepage"><div><div><h4 class="title">
                   1067: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1068: <p>When updating pkgsrc, the CVS program keeps track of the
                   1069:        branch you selected. But if you, for whatever reason, want to
                   1070:        switch from the stable branch to the current one, you can do it
1.23      wiz      1071:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1072:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1073:        back to the stable branch, add the
1.23      wiz      1074:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1.1       dsieger  1075: </div>
1.41      asau     1076: <div class="sect3">
1.1       dsieger  1077: <div class="titlepage"><div><div><h4 class="title">
                   1078: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1079: <p>When you update pkgsrc, the CVS program will only touch
                   1080:        those files that are registered in the CVS repository. That
                   1081:        means that any packages that you created on your own will stay
                   1082:        unmodified. If you change files that are managed by CVS, later
                   1083:        updates will try to merge your changes with those that have been
                   1084:        done by others. See the CVS manual, chapter
1.23      wiz      1085:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1086: </div>
                   1087: </div>
                   1088: </div>
                   1089: </div>
1.41      asau     1090: <div class="chapter">
1.1       dsieger  1091: <div class="titlepage"><div><div><h2 class="title">
                   1092: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1093: <div class="toc">
                   1094: <p><b>Table of Contents</b></p>
                   1095: <dl>
                   1096: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1097: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1098: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1099: <dd><dl>
1.45      obache   1100: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                   1101: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
                   1106: <dt><span class="sect2"><a href="#openbsd">3.3.7. OpenBSD</a></span></dt>
                   1107: <dt><span class="sect2"><a href="#solaris">3.3.8. Solaris</a></span></dt>
1.1       dsieger  1108: </dl></dd>
                   1109: </dl>
                   1110: </div>
1.41      asau     1111: <div class="sect1">
1.1       dsieger  1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1113: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1114: <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  1115: </div>
1.41      asau     1116: <div class="sect1">
1.1       dsieger  1117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1118: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1119: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1120:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1121:     to privileged one all programs are installed under one particular user
1.43      asau     1122:     and cannot utilise privileged operations (packages don't create
                   1123:     special users and all special file permissions like setuid are ignored).
                   1124:     </p>
1.1       dsieger  1125: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1126: <pre class="screen">
                   1127: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1128: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1129: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1130:     </pre>
1.43      asau     1131: <p>To bootstrap in unprivileged mode pass <span class="quote">&#8220;<span class="quote">--unprivileged</span>&#8221;</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
                   1132: <p>By default, in privileged mode pkgsrc uses
                   1133:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1134:     where programs will be installed in,
1.1       dsieger  1135:     and <code class="filename">/var/db/pkg</code> for the package database
1.43      asau     1136:     directory where pkgsrc will do its internal bookkeeping,
                   1137:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1138:     where packages install their persistent data.
                   1139:     In unprivileged mode pkgsrc uses
                   1140:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
                   1141:     <code class="filename">~/pkg/var/db/pkg</code> for the package database,
                   1142:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1143:     </p>
                   1144: <p>You can change default layout using command-line arguments.
                   1145:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1146:     </p>
1.41      asau     1147: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1148: <h3 class="title">Note</h3>
1.10      hubertf  1149: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1150:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1151:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1152:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1153: </div>
1.43      asau     1154: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1155: <h3 class="title">Note</h3>
                   1156: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1157:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1158:       corresponding to the installation you're working with to build
                   1159:       and install packages.
                   1160:       </p>
                   1161: </div>
1.1       dsieger  1162: </div>
1.41      asau     1163: <div class="sect1">
1.1       dsieger  1164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1165: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1166: <p>Here are some platform-specific notes you should be aware of.</p>
1.41      asau     1167: <div class="sect2">
1.1       dsieger  1168: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1169: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
                   1170: <p>Cygwin 1.7.x and later are supported.</p>
                   1171: <p>You need to install minimal base packages in `Base' category
                   1172:       plus any of compiler, gcc, gcc4, and/or clang.
                   1173:       For gcc and gcc4, C and C++ compiler will be installed by default,
                   1174:       but you can install Fortran compiler additionally
                   1175:       because it will be required to use libtool.
                   1176:       If it is not installed (or too old), Fortran compiler will be
                   1177:       installed with pkgsrc automatically.</p>
                   1178: <p>As noted in
                   1179:       <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
                   1180:       su(1) command has been in Cygwin distribution, but it has never worked.
                   1181:       Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
                   1182:       </p>
                   1183: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
                   1184:           then pick "Run as administrator".</p></li></ul></div>
                   1185: </div>
                   1186: <div class="sect2">
                   1187: <div class="titlepage"><div><div><h3 class="title">
                   1188: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.41      asau     1189: <p>Darwin 5.x and up are supported.</p>
                   1190: <p>Before you start, you need to download and install
                   1191:       the Mac OS X Developer Tools from Apple's Developer Connection.
                   1192:       This requires (free) membership. See
1.22      jakllsch 1193:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41      asau     1194:       for details. Also, make sure you install X11 (an optional
                   1195:       package included with the Developer Tools) if you intend
                   1196:       to build packages that use the X11 Window System.
                   1197:       (If you don't want or need the full Xcode GUI,
                   1198:       download and install Command Line Tools for Xcode.)</p>
1.1       dsieger  1199: </div>
1.41      asau     1200: <div class="sect2">
1.1       dsieger  1201: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1202: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29      dholland 1203: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1       dsieger  1204:       other versions may work.</p>
                   1205: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1206:       with the FreeBSD userland tools. There are several steps:</p>
1.23      wiz      1207: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1208: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1       dsieger  1209:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1210:          recommended that you choose a different location (e.g.
                   1211:          <code class="filename">/usr/pkgdb</code>) by
                   1212:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1213: <li class="listitem">
1.1       dsieger  1214: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1215:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1216: <pre class="screen">
                   1217: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1218: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1219: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1220: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1221: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1222:          </pre>
                   1223: </li>
1.23      wiz      1224: <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  1225:          <code class="filename">/etc/mk.conf.example</code> file
                   1226:          when you use the bootstrap script.</p></li>
                   1227: </ol></div>
                   1228: </div>
1.41      asau     1229: <div class="sect2">
1.1       dsieger  1230: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1231: <a name="interix"></a>3.3.4. Interix</h3></div></div></div>
1.1       dsieger  1232: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1233:       providing a Unix-like environment with a tighter kernel integration than
                   1234:       available with Cygwin.  It is part of the Windows Services for Unix
                   1235:       package, available for free for any licensed copy of Windows 2000, XP
1.10      hubertf  1236:       (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  1237: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1238:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1239:       of pthreads, but other parts of libc may also be lacking.)</p>
1.24      wiz      1240: <p>Services for Unix Applications (aka SUA) is an integrated
                   1241:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1242:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1243:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1244:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1245:       work as well. The Interix 5.x subsystem has not yet been tested
                   1246:       with pkgsrc.</p>
1.41      asau     1247: <div class="sect3">
1.1       dsieger  1248: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1249: <a name="platform.interix-sfu-install"></a>3.3.4.1. When installing Interix/SFU</h4></div></div></div>
1.1       dsieger  1250: <p>At an absolute minimum, the following packages must be installed from
                   1251:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41      asau     1252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1253: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1254: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1255: <li class="listitem"><p>Remote Connectivity</p></li>
                   1256: <li class="listitem"><p>Interix SDK</p></li>
1.1       dsieger  1257: </ul></div>
                   1258: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1259:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1260:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1261:        pkgsrc (or from a binary package).</p>
                   1262: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1263:        not need to be installed, but Remote Connectivity itself should be
                   1264:        installed in order to have a working inetd.</p>
                   1265: <p>During installation you may be asked whether to enable setuid
                   1266:        behavior for Interix programs, and whether to make pathnames default to
                   1267:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1268:        enabled.  (Without case-sensitivity, a large number of packages including
                   1269:        perl will not build.)</p>
                   1270: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1271:        works (via the Data Execution Prevention feature).  In order to use
                   1272:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1273:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1274:        must be installed.  Hotfixes are available from Microsoft through a
1.14      jmcneill 1275:        support contract; however, Debian Interix Port has made most Interix
                   1276:        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  1277: <p>In addition to the hotfix noted above, it may be necessary to
                   1278:        disable Data Execution Prevention entirely to make Interix functional.
                   1279:        This may happen only with certain types of CPUs; the cause is not fully
                   1280:        understood at this time.  If gcc or other applications still segfault
                   1281:        repeatedly after installing one of the hotfixes note above, the
                   1282:        following option can be added to the appropriate "boot.ini" line on the
                   1283:        Windows boot drive:  /NoExecute=AlwaysOff
                   1284:        (WARNING, this will disable DEP completely, which may be a security
                   1285:        risk if applications are often run as a user in the Administrators
                   1286:        group!)</p>
                   1287: </div>
1.41      asau     1288: <div class="sect3">
1.1       dsieger  1289: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1290: <a name="platform.interix-sfu-postinstall"></a>3.3.4.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.1       dsieger  1291: <p>If SFU is already installed and you wish to alter these settings to work
                   1292:        with pkgsrc, note the following things.</p>
1.41      asau     1293: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1294: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1       dsieger  1295:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1296:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.23      wiz      1297: <li class="listitem">
1.1       dsieger  1298: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1299:            change the following registry key:</p>
                   1300: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1301: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1302: </li>
1.23      wiz      1303: <li class="listitem">
1.1       dsieger  1304: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1305:            following registry key:</p>
                   1306: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1307: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1308: </li>
                   1309: </ul></div>
                   1310: </div>
1.41      asau     1311: <div class="sect3">
1.1       dsieger  1312: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1313: <a name="platform.interix-notes"></a>3.3.4.3. Important notes for using pkgsrc</h4></div></div></div>
1.1       dsieger  1314: <p>The package manager (either the pkgsrc "su" user, or the user
                   1315:        running "pkg_add") must be a member of the local Administrators
                   1316:        group.  Such a user must also be used to run the bootstrap.  This is
                   1317:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1318: <p>The package manager should use a umask of 002.  "make install" will
                   1319:        automatically complain if this is not the case.  This ensures that
                   1320:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1321: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1322:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1323:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1324:        the same time as the pkgsrc packages, ensure that you use the proper
                   1325:        pkg_* tools for each type of binary package.</p>
                   1326: <p>The TERM setting used for DOS-type console windows (including those
                   1327:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1328:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1329:        entry provides adequate emulation in most cases:</p>
                   1330: <pre class="programlisting">
                   1331: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1332:        </pre>
                   1333: </div>
1.41      asau     1334: <div class="sect3">
1.1       dsieger  1335: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1336: <a name="platform.interix-limits"></a>3.3.4.4. Limitations of the Interix platform</h4></div></div></div>
1.1       dsieger  1337: <p>Though Interix suffices as a familiar and flexible substitute
                   1338:        for a full Unix-like platform, it has some drawbacks that should
                   1339:        be noted for those desiring to make the most of Interix.</p>
1.41      asau     1340: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1341: <li class="listitem">
1.1       dsieger  1342: <p><span class="strong"><strong>X11:</strong></span></p>
                   1343: <p>Interix comes with the standard set of X11R6 client libraries,
                   1344:          and can run X11 based applications, but it does
                   1345:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.10      hubertf  1346:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1347:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1       dsieger  1348:          (available in a trimmed version for Interix from Interop Systems as the
1.10      hubertf  1349:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1       dsieger  1350:          and the free X11 server included with
1.10      hubertf  1351:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1       dsieger  1352: </li>
1.23      wiz      1353: <li class="listitem">
1.1       dsieger  1354: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1355: <p>Because Interix runs in a completely different NT subsystem from
                   1356:          Win32 applications, it does not currently support various X11
                   1357:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1358:          Most interactive applications to a local X server will run
                   1359:          reasonably fast, but full motion video and other graphics
                   1360:          intensive applications may require a faster-than-expected CPU.</p>
                   1361: </li>
1.23      wiz      1362: <li class="listitem">
1.1       dsieger  1363: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1364: <p>Interix has no native support for audio output.  For audio
1.10      hubertf  1365:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1       dsieger  1366:          audio system on Interix.  Unlike on most platforms, the
                   1367:          <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  1368:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1       dsieger  1369:          server component.  To output audio via an Interix host, the
                   1370:          <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
                   1371:          must also be installed.</p>
                   1372: </li>
1.23      wiz      1373: <li class="listitem">
1.1       dsieger  1374: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1375: <p>Direct device access is not currently supported in Interix, so it
                   1376:          is not currently possible to access CD/DVD drives, USB devices,
                   1377:          or SCSI devices through non-filesystem means.  Among other things,
                   1378:          this makes it impossible to use Interix directly for CD/DVD
                   1379:          burning.</p>
                   1380: </li>
1.23      wiz      1381: <li class="listitem">
1.1       dsieger  1382: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1383: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1384:          drives are also not directly accessible in Interix.  However,
                   1385:          support is in work to make tape drive access possible by using
                   1386:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1387:          esound server).</p>
                   1388: </li>
                   1389: </ul></div>
                   1390: </div>
1.41      asau     1391: <div class="sect3">
1.1       dsieger  1392: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1393: <a name="platform.interix-knownissues"></a>3.3.4.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1       dsieger  1394: <p>It is not necessary, in general, to have a "root" user on the
                   1395:        Windows system; any member of the local Administrators group will
                   1396:        suffice.  However, some packages currently assume that the user
                   1397:        named "root" is the privileged user.  To accommodate these, you
                   1398:        may create such a user; make sure it is in the local group
                   1399:        Administrators (or your language equivalent).</p>
1.10      hubertf  1400: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1       dsieger  1401:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1402:        time being, install packages as the local Administrator (or
                   1403:        your language equivalent), or run the following command after
                   1404:        installing a package to work around the issue:</p>
                   1405: <pre class="screen">
                   1406: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1407:        </pre>
                   1408: </div>
                   1409: </div>
1.41      asau     1410: <div class="sect2">
1.1       dsieger  1411: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1412: <a name="irix"></a>3.3.5. IRIX</h3></div></div></div>
1.1       dsieger  1413: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1414:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1415:       according to your preference.  If you do not have a license for the MIPSpro
1.10      hubertf  1416:       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  1417: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29      dholland 1418:       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  1419:       etc.</p>
                   1420: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1421:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1422:        you start out using "abi=n32", that's what all your packages will be built
                   1423:        with.</p>
                   1424: <p>Therefore, please make sure that you have no conflicting
                   1425:       <code class="varname">CFLAGS</code> in your environment or the
1.10      hubertf  1426:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1427:       try to link n32 object files with lib64 or vice versa.  Check your
                   1428:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1429: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1430:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1431:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1432:       link over a network-mounted file system.</p>
                   1433: <p>The bootstrapping process should set all the right options for programs such
                   1434:       as imake(1), but you may want to set some options depending on your local
                   1435:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1436:       course, your compiler's man pages for details.</p>
                   1437: <p>If you are using SGI's MIPSPro compiler, please set
                   1438: 
                   1439:       </p>
                   1440: <pre class="programlisting">
                   1441: PKGSRC_COMPILER=        mipspro
                   1442:       </pre>
                   1443: <p>
                   1444: 
1.10      hubertf  1445:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1446:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1447:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1448:       default.</p>
                   1449: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1450:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1451:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1452:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1453:       '--preserve-path' flag.</p>
                   1454: </div>
1.41      asau     1455: <div class="sect2">
1.1       dsieger  1456: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1457: <a name="linux"></a>3.3.6. Linux</h3></div></div></div>
1.1       dsieger  1458: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1459:       either libtermcap or libcurses (libncurses).  Installing the
                   1460:       distributions libncurses-dev package (or equivalent) should fix
                   1461:       the problem.</p>
                   1462: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1463:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1464:       i386 have been tested.</p>
                   1465: <p>To bootstrap using icc, assuming the default icc installation
                   1466:       directory:</p>
                   1467: <pre class="programlisting">
1.31      wiz      1468: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1       dsieger  1469:       </pre>
1.41      asau     1470: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1471: <h3 class="title">Note</h3>
1.31      wiz      1472: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1473: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1474: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1475: </div>
                   1476: <p>Use a value for ICCBASE that corresponds to the directory
                   1477:       where icc is installed. After bootstrapping, set
                   1478:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30      wiz      1479: <pre class="programlisting">
1.31      wiz      1480: ICCBASE=                /opt/intel/cc/10.1.008
1.1       dsieger  1481:       </pre>
1.31      wiz      1482: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1483:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1484:       install directory for icc 8.0. If you are using a more recent
                   1485:       version, be sure to set the correct path explicitly.
                   1486:       </p>
1.1       dsieger  1487: <p>pkgsrc uses the static linking method of the runtime libraries
                   1488:       provided by icc, so binaries can be run on other systems which do not
                   1489:       have the shared libraries installed.</p>
                   1490: <p>Libtool, however, extracts a list of libraries from the
1.29      dholland 1491:       <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  1492:       records it, throwing away the -Bstatic and -Bdynamic options
                   1493:       interspersed between the libraries.  This means that
                   1494:       libtool-linked C++ shared libraries will have a runtime
                   1495:       dependency on the icc libraries until this is fixed in
                   1496:       libtool.</p>
                   1497: </div>
1.41      asau     1498: <div class="sect2">
1.1       dsieger  1499: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1500: <a name="openbsd"></a>3.3.7. OpenBSD</h3></div></div></div>
1.29      dholland 1501: <p>OpenBSD 5.1 has been tested and supported,
                   1502:       other versions may work.</p>
1.1       dsieger  1503: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1504:       with the OpenBSD userland tools. There are several steps:</p>
1.23      wiz      1505: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1506: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1       dsieger  1507:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1508:          recommended that you choose a different location (e.g.
                   1509:          <code class="filename">/usr/pkgdb</code>) by
                   1510:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1511: <li class="listitem">
1.1       dsieger  1512: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1513:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1514: <pre class="screen">
                   1515: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1516: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1517: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1518: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1519: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1520:          </pre>
                   1521: </li>
1.23      wiz      1522: <li class="listitem">
1.10      hubertf  1523: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1524:          <code class="filename">/etc/mk.conf.example</code> file
                   1525:          when you use the bootstrap script. OpenBSD's make program uses
1.10      hubertf  1526:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1527:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1528:          of the file with:</p>
                   1529: <pre class="programlisting">
                   1530: .ifdef BSD_PKG_MK
                   1531: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1532: .else
                   1533: # OpenBSD stuff
                   1534: .endif
                   1535:          </pre>
                   1536: </li>
                   1537: </ol></div>
                   1538: </div>
1.41      asau     1539: <div class="sect2">
1.1       dsieger  1540: <div class="titlepage"><div><div><h3 class="title">
1.45      obache   1541: <a name="solaris"></a>3.3.8. Solaris</h3></div></div></div>
1.35      wiz      1542: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
                   1543:       You will need a working C compiler. Both gcc 4.5.3 and
1.1       dsieger  1544:       Sun WorkShop 5 have been tested.</p>
                   1545: <p>The following packages are required on Solaris 8 for the bootstrap
                   1546:       process and to build packages.</p>
1.41      asau     1547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1548: <li class="listitem"><p>SUNWsprot</p></li>
                   1549: <li class="listitem"><p>SUNWarc</p></li>
                   1550: <li class="listitem"><p>SUNWbtool</p></li>
                   1551: <li class="listitem"><p>SUNWtoo</p></li>
                   1552: <li class="listitem"><p>SUNWlibm</p></li>
1.1       dsieger  1553: </ul></div>
                   1554: <p>Please note that the use of GNU binutils on Solaris is
                   1555:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1556: <p>Whichever compiler you use, please ensure the compiler tools and
                   1557:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1558:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1559:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41      asau     1560: <div class="sect3">
1.1       dsieger  1561: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1562: <a name="solaris-gcc-note"></a>3.3.8.1. If you are using gcc</h4></div></div></div>
1.1       dsieger  1563: <p>It makes life much simpler if you only use the same gcc consistently
                   1564:        for building all packages.</p>
                   1565: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1566:        then either build gcc from
1.35      wiz      1567:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1       dsieger  1568:        package, then remove gcc used during bootstrapping.</p>
1.10      hubertf  1569: <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  1570: </div>
1.41      asau     1571: <div class="sect3">
1.1       dsieger  1572: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1573: <a name="solaris-sun-workshop-note"></a>3.3.8.2. If you are using Sun WorkShop</h4></div></div></div>
1.1       dsieger  1574: <p>You will need at least the following packages installed (from WorkShop
                   1575:        5.0)</p>
1.41      asau     1576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1577: <li class="listitem"><p>SPROcc
1.1       dsieger  1578:          - Sun WorkShop Compiler C 5.0</p></li>
1.23      wiz      1579: <li class="listitem"><p>SPROcpl
1.1       dsieger  1580:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.23      wiz      1581: <li class="listitem"><p>SPROild
1.1       dsieger  1582:          - Sun WorkShop Incremental Linker</p></li>
1.23      wiz      1583: <li class="listitem"><p>SPROlang
1.1       dsieger  1584:          - Sun WorkShop Compilers common components</p></li>
                   1585: </ul></div>
                   1586: <p>You should set the following variables in your
1.10      hubertf  1587:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1588: <pre class="programlisting">
                   1589: CC=     cc
                   1590: CXX=    CC
                   1591: CPP=    cc -E
                   1592: CXXCPP= CC -E
                   1593: </pre>
1.41      asau     1594: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1595: <h3 class="title">Note</h3>
                   1596: <p>The <code class="varname">CPP</code> setting might break some
                   1597:        packages that use the C preprocessor for processing things other
                   1598:        than C source code.</p>
                   1599: </div>
                   1600: </div>
1.41      asau     1601: <div class="sect3">
1.1       dsieger  1602: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1603: <a name="solaris-sunpro-64"></a>3.3.8.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1       dsieger  1604: <p>To build 64-bit packages, you just need to have the
1.10      hubertf  1605:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1606: <pre class="programlisting">
                   1607: PKGSRC_COMPILER=        sunpro
                   1608: ABI=                    64
                   1609: </pre>
1.41      asau     1610: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1611: <h3 class="title">Note</h3>
                   1612: <p>This setting has been tested for the SPARC
                   1613:        architecture. Intel and AMD machines need some more
                   1614:        work.</p>
                   1615: </div>
                   1616: </div>
1.41      asau     1617: <div class="sect3">
1.1       dsieger  1618: <div class="titlepage"><div><div><h4 class="title">
1.45      obache   1619: <a name="plat.sunos.problems"></a>3.3.8.4. Common problems</h4></div></div></div>
1.10      hubertf  1620: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1       dsieger  1621:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1622:       The workaround is to use another shell for the configure
                   1623:       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  1624:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1625: <pre class="programlisting">
                   1626: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1627: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1628:       </pre>
                   1629: <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>
                   1630: </div>
                   1631: </div>
                   1632: </div>
                   1633: </div>
1.41      asau     1634: <div class="chapter">
1.1       dsieger  1635: <div class="titlepage"><div><div><h2 class="title">
                   1636: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1637: <div class="toc">
                   1638: <p><b>Table of Contents</b></p>
                   1639: <dl>
                   1640: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1641: <dd><dl>
                   1642: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1643: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1644: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1645: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1646: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1647: <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>
                   1648: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1649: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1650: </dl></dd>
                   1651: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1652: <dd><dl>
                   1653: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1654: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1655: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1656: </dl></dd>
                   1657: </dl>
                   1658: </div>
                   1659: <p>Basically, there are two ways of using pkgsrc. The first
                   1660: is to only install the package tools and to use binary packages
1.23      wiz      1661: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1662: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1663: of pkgsrc, too. Then you are able to build your own packages,
                   1664: and you can still use binary packages from someone else.</p>
1.41      asau     1665: <div class="sect1">
1.1       dsieger  1666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1667: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1668: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1669:   server and its mirrors, there are collections of binary packages,
                   1670:   ready to be installed. These binary packages have been built using the
                   1671:   default settings for the directories, that is:</p>
1.41      asau     1672: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1673: <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>
                   1674: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1675: <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   1676: </ul></div>
                   1677: <p>If you cannot use these directories for whatever reasons (maybe
                   1678:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1679:   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.41      asau     1680: <div class="sect2">
1.1       dsieger  1681: <div class="titlepage"><div><div><h3 class="title">
                   1682: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1683: <p>To install binary packages, you first need to know from where
                   1684:     to get them. The first place where you should look is on the main
1.10      hubertf  1685:     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   1686: <p>This directory contains binary packages for multiple
                   1687:     platforms. First, select your operating system. (Ignore the
                   1688:     directories with version numbers attached to it, they just exist for
                   1689:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1690:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1691: <p>In this directory, you often find a file called
                   1692:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1693:     management tools. If the file is missing, it is likely that your
                   1694:     operating system already provides those tools. Download the file and
                   1695:     extract it in the <code class="filename">/</code> directory. It will create
                   1696:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1697:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1698:     (the database of installed packages).</p>
1.1       dsieger  1699: </div>
1.41      asau     1700: <div class="sect2">
1.1       dsieger  1701: <div class="titlepage"><div><div><h3 class="title">
                   1702: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1703: <p>In the directory from the last section, there is a
                   1704:     subdirectory called <code class="filename">All</code>, which contains all the
                   1705:     binary packages that are available for the platform, excluding those
                   1706:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1707:     medium you are using).</p>
1.9       rillig   1708: <p>To install packages directly from an FTP or HTTP server, run
                   1709:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1710:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1711: <pre class="screen">
                   1712: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1713: <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>
                   1714: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1715: </pre>
                   1716: <p>Instead of URLs, you can also use local paths, for example if
                   1717:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1718:     repository. If you want to install packages from multiple sources,
                   1719:     you can separate them by a semicolon in
                   1720:     <code class="varname">PKG_PATH</code>.</p>
                   1721: <p>After these preparations, installing a package is very
                   1722:     easy:</p>
                   1723: <pre class="screen">
                   1724: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1725: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1726: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1727: </pre>
1.1       dsieger  1728: <p>Note that any prerequisite packages needed to run the
                   1729:     package in question will be installed, too, assuming they are
                   1730:     present where you install from.</p>
1.23      wiz      1731: <p>Adding packages might install vulnerable packages.
                   1732:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1733:     regularly, especially after installing new packages, and verify
                   1734:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1735: <p>After you've installed packages, be sure to have
                   1736:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1737:     <code class="varname">PATH</code> so you can actually start the just
                   1738:     installed program.</p>
                   1739: </div>
1.41      asau     1740: <div class="sect2">
1.1       dsieger  1741: <div class="titlepage"><div><div><h3 class="title">
                   1742: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1743: <p>To deinstall a package, it does not matter whether it was
                   1744:     installed from source code or from a binary package. The
1.10      hubertf  1745:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1746:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1747:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1748:     name can be given with or without version number. Wildcards can
                   1749:     also be used to deinstall a set of packages, for example
                   1750:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1751:     so that the shell does not expand them before
                   1752:     <code class="literal">pkg_delete</code> sees them.</p>
                   1753: <p>The <code class="option">-r</code> option is very powerful: it
                   1754:     removes all the packages that require the package in question
                   1755:     and then removes the package itself. For example:
                   1756: 
                   1757:     </p>
                   1758: <pre class="screen">
                   1759: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1760:     </pre>
                   1761: <p>
                   1762: 
                   1763:     will remove jpeg and all the packages that used it; this allows
                   1764:     upgrading the jpeg package.</p>
                   1765: </div>
1.41      asau     1766: <div class="sect2">
1.1       dsieger  1767: <div class="titlepage"><div><div><h3 class="title">
                   1768: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1769: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1770:     installed packages or binary package files.</p>
                   1771: </div>
1.41      asau     1772: <div class="sect2">
1.1       dsieger  1773: <div class="titlepage"><div><div><h3 class="title">
                   1774: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1775: <p>
                   1776:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1777:       known security vulnerabilities to packages which are (or have been)
                   1778:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1779:       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  1780:     </p>
                   1781: <p>
1.22      jakllsch 1782:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1783:       this list can be downloaded
                   1784:       automatically, and a security audit of all packages installed on a system
                   1785:       can take place.
                   1786:     </p>
                   1787: <p>
1.22      jakllsch 1788:       There are two components to auditing.  The first
                   1789:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1790:       is for downloading
1.1       dsieger  1791:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1792:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1793:       installed packages are vulnerable.  If a package is vulnerable, you
                   1794:       will see output similar to the following:
                   1795:     </p>
                   1796: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1797:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1798: <p>
1.22      jakllsch 1799:       You may wish to have the
1.10      hubertf  1800:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1801:       file downloaded daily so that
                   1802:       it remains current.  This may be done by adding an appropriate entry
1.29      dholland 1803:       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 1804:       </p>
                   1805: <pre class="screen">
                   1806: # download vulnerabilities file
                   1807: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1808:       </pre>
                   1809: <p>
                   1810:       will update the vulnerability list every day at 3AM. You may wish to do
                   1811:       this more often than once a day.
                   1812: 
                   1813:       In addition, you may wish to run the package audit from the daily
                   1814:       security script.  This may be accomplished by adding the following
                   1815:       line to <code class="filename">/etc/security.local</code>:
                   1816:       </p>
                   1817: <pre class="screen">
                   1818: /usr/sbin/pkg_admin audit
                   1819:       </pre>
                   1820: <p>
1.1       dsieger  1821:     </p>
                   1822: </div>
1.41      asau     1823: <div class="sect2">
1.1       dsieger  1824: <div class="titlepage"><div><div><h3 class="title">
                   1825: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1826: <p>
1.12      weinem   1827:       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      1828:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1829:       argument to check if your packages are up-to-date, e.g.
                   1830:     </p>
                   1831: <pre class="screen">
                   1832: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1833: ...
                   1834: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1835:     </pre>
1.10      hubertf  1836: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1837:     package on your system and rebuild any dependencies.
                   1838:     </p>
                   1839: </div>
1.41      asau     1840: <div class="sect2">
1.1       dsieger  1841: <div class="titlepage"><div><div><h3 class="title">
                   1842: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1843: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1844:     administrative functions on the package system.</p>
                   1845: </div>
1.41      asau     1846: <div class="sect2">
1.1       dsieger  1847: <div class="titlepage"><div><div><h3 class="title">
                   1848: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1849: <p>Please pay very careful attention to the warnings
1.29      dholland 1850:     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  1851:     inherent dangers of installing binary packages which you did
                   1852:     not create yourself, and the security holes that can be
                   1853:     introduced onto your system by indiscriminate adding of such
                   1854:     files.</p>
                   1855: <p>The same warning of course applies to every package you
                   1856:     install from source when you haven't completely read and
                   1857:     understood the source code of the package, the compiler that
                   1858:     is used to build the package and all the other tools that are
                   1859:     involved.</p>
                   1860: </div>
                   1861: </div>
1.41      asau     1862: <div class="sect1">
1.1       dsieger  1863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1864: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1865: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1866:   directory now contains a set of packages, organized into
                   1867:   categories. You can browse the online index of packages, or run
1.10      hubertf  1868:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1869:   directory to build local <code class="filename">README.html</code> files for
                   1870:   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>
                   1871: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1872:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1873:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1874:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1875:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1876:   system (inside a chroot is an exception). </p>
                   1877: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1878:   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  1879:   instructions how to create your own packages.</p>
1.41      asau     1880: <div class="sect2">
1.1       dsieger  1881: <div class="titlepage"><div><div><h3 class="title">
                   1882: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1883: <p>To build packages from source, you need a working C
                   1884:     compiler. On NetBSD, you need to install the
1.23      wiz      1885:     <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  1886:     sets. If you want to build X11-related packages, the
1.23      wiz      1887:     <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  1888:     sets are required, too.</p>
                   1889: </div>
1.41      asau     1890: <div class="sect2">
1.1       dsieger  1891: <div class="titlepage"><div><div><h3 class="title">
                   1892: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1893: <p>The first step for building a package is downloading the
                   1894:     distfiles (i.e. the unmodified source). If they have not yet been
                   1895:     downloaded, pkgsrc will fetch them automatically.</p>
                   1896: <p>If you have all files that you need in the
                   1897:     <code class="filename">distfiles</code> directory,
                   1898:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1899:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1900:     </p>
                   1901: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1902: <p>
1.10      hubertf  1903:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1904: <p>By default a list of distribution sites will be randomly
                   1905:     intermixed to prevent huge load on servers which holding popular
                   1906:     packages (for example, SourceForge.net mirrors). Thus, every
                   1907:     time when you need to fetch yet another distfile all the mirrors
                   1908:     will be tried in new (random) order. You can turn this feature
                   1909:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1910:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1911: <p>You can overwrite some of the major distribution sites to
                   1912:     fit to sites that are close to your own.  By setting one or two
                   1913:     variables you can modify the order in which the master sites are
                   1914:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1915:     delimited list of domain suffixes.
                   1916:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1917:     contains a whitespace delimited list of regular expressions.  It
                   1918:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1919:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1920:     some examples.  This may save some of your bandwidth and
                   1921:     time.</p>
                   1922: <p>You can change these settings either in your shell's environment, or,
                   1923:     if you want to keep the settings, by editing the
1.10      hubertf  1924:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1925:     and adding the definitions there.</p>
                   1926: <p>
                   1927:       If a package depends on many other packages (such as
                   1928:       <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
                   1929:       alternate between periods of
                   1930:       downloading source, and compiling. To ensure you have all the source
                   1931:       downloaded initially you can run the command:
                   1932:       </p>
                   1933: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1934: <p>
                   1935:       which will output and run a set of shell commands to fetch the
                   1936:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1937:       also choose to download the files manually.
                   1938:     </p>
                   1939: </div>
1.41      asau     1940: <div class="sect2">
1.1       dsieger  1941: <div class="titlepage"><div><div><h3 class="title">
                   1942: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1943: <p>
                   1944:       Once the software has downloaded, any patches will be applied, then it
                   1945:       will be compiled for you. This may take some time depending on your
                   1946:       computer, and how many other packages the software depends on and their
                   1947:       compile time.
                   1948:     </p>
1.41      asau     1949: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1950: <h3 class="title">Note</h3>
                   1951: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1952:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1953:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1954: </div>
                   1955: <p>For example, type</p>
                   1956: <pre class="screen">
                   1957: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1958: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1959:     </pre>
                   1960: <p>at the shell prompt to build the various components of the
                   1961:     package.</p>
                   1962: <p>The next stage is to actually install the newly compiled
                   1963:     program onto your system. Do this by entering:
                   1964: 
                   1965:     </p>
                   1966: <pre class="screen">
                   1967: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1968:     </pre>
                   1969: <p>
                   1970: 
                   1971:     while you are still in the directory for whatever package you
                   1972:     are installing.</p>
                   1973: <p>Installing the package on your system may require you to
                   1974:     be root.  However, pkgsrc has a
                   1975:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1976:     to only become root for the actual installation step.</p>
                   1977: <p>That's it, the software should now be installed and setup for use.
                   1978:     You can now enter:
                   1979: 
                   1980:     </p>
                   1981: <pre class="screen">
                   1982: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1983:     </pre>
                   1984: <p>
                   1985: 
                   1986:     to remove the compiled files in the work directory, as you shouldn't need
                   1987:     them any more. If other packages were also added to your system
                   1988:     (dependencies) to allow your program to compile, you can tidy these up
                   1989:     also with the command:</p>
                   1990: <pre class="screen">
                   1991: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1992:     </pre>
                   1993: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1994:     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  1995: <p>The program is installed under the default root of the
                   1996:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1997:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1998:     variable in your environment, and it will use that value as the
                   1999:     root of your packages tree. So, to use
                   2000:     <code class="filename">/usr/local</code>, set
                   2001:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2002:     Please note that you should use a directory which is dedicated to
                   2003:     packages and not shared with other programs (i.e., do not try and
                   2004:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2005:     to add any of your own files or directories (such as
                   2006:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2007:     <code class="filename">pkgsrc/</code>) below the
                   2008:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2009:     conflicts between programs and other files installed by the
                   2010:     package system and whatever else may have been installed
                   2011:     there.</p>
1.10      hubertf  2012: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  2013:     alter some configuration options at build time.  Have a look at
                   2014:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2015:     of what will be set there by default.  Environment variables such
                   2016:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  2017:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  2018:     set them each time you want to use pkgsrc.</p>
1.23      wiz      2019: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   2020:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  2021:     or being installed. This may be for debugging purposes, or out of
                   2022:     simple curiosity. A number of utility values have been added to
                   2023:     help with this.</p>
1.23      wiz      2024: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2025: <li class="listitem">
1.29      dholland 2026: <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  2027:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2028:        information will be displayed. For example,</p>
                   2029: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   2030: <p>will show all the commands that are invoked, up to and
1.23      wiz      2031:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  2032: </li>
1.23      wiz      2033: <li class="listitem">
1.29      dholland 2034: <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  2035:        definition, then the <code class="varname">VARNAME</code> definition
                   2036:        should be used, in conjunction with the show-var
1.29      dholland 2037:        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  2038:        variable <code class="varname">LOCALBASE</code>:</p>
                   2039: <pre class="screen">
                   2040: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   2041: /usr/pkg
                   2042: <code class="prompt">%</code>
                   2043:        </pre>
                   2044: </li>
                   2045: </ol></div>
                   2046: <p>If you want to install a binary package that you've either
                   2047:     created yourself (see next section), that you put into
                   2048:     pkgsrc/packages manually or that is located on a remote FTP
                   2049:     server, you can use the "bin-install" target. This target will
1.29      dholland 2050:     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  2051:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  2052:     sites searched is kept in the variable
                   2053:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.29      dholland 2054:     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  2055:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2056:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2057:     details.</p>
                   2058: <p>A final word of warning: If you set up a system that has a
                   2059:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2060:     set that before any packages are installed, as you cannot use
                   2061:     several directories for the same purpose. Doing so will result in
                   2062:     pkgsrc not being able to properly detect your installed packages,
                   2063:     and fail miserably. Note also that precompiled binary packages are
                   2064:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2065:     <code class="filename">/usr/pkg</code>, and that you should
                   2066:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2067:     <code class="varname">LOCALBASE</code>.</p>
                   2068: </div>
                   2069: </div>
                   2070: </div>
1.41      asau     2071: <div class="chapter">
1.1       dsieger  2072: <div class="titlepage"><div><div><h2 class="title">
                   2073: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2074: <div class="toc">
                   2075: <p><b>Table of Contents</b></p>
                   2076: <dl>
                   2077: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2078: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   2079: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2080: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2081: <dd><dl>
1.4       rillig   2082: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz      2083: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2084: <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  2085: </dl></dd>
1.4       rillig   2086: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2087: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2088: </dl>
                   2089: </div>
1.4       rillig   2090: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2091: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2092: that file depends on the installation. On NetBSD, when you use
1.29      dholland 2093: <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  2094: <code class="filename">/etc/</code>. In all other cases the default location is
                   2095: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2096: bootstrap program to install the binary packages.</p>
                   2097: <p>During the bootstrap, an example configuration file is created. To
                   2098: use that, you have to create the directory
                   2099: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2100: there.</p>
                   2101: <p>The format of the configuration file is that of the usual
                   2102: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2103: is done by setting variables in this file. Note that you can define all
                   2104: kinds of variables, and no special error checking (for example for
                   2105: spelling mistakes) takes place, so you have to try it out to see if it
                   2106: works.</p>
1.41      asau     2107: <div class="sect1">
1.1       dsieger  2108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2109: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2110: <p>In this section, you can find some variables that apply to all
                   2111:     pkgsrc packages. A complete list of the variables that can be
                   2112:     configured by the user is available in
                   2113:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2114:     comments that describe each variable's intent.</p>
1.41      asau     2115: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2116: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  2117:            packages will be installed. The default is
                   2118:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2119:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      2120: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2121:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  2122:            installed. The default is
                   2123:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      2124: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  2125:            X11 is installed on the system. The default is
                   2126:            <code class="filename">/usr/X11R6</code>.</p></li>
1.23      wiz      2127: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  2128:            downloaded copies of the original source distributions used
                   2129:            for building pkgsrc packages. The default is
                   2130:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      2131: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  2132:            database about installed packages is stored.  The default is
                   2133:            <code class="filename">/var/db/pkg</code>.</p></li>
1.23      wiz      2134: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  2135:            If set, override the packages'
                   2136:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      2137: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  2138:            Backup location(s) for distribution files and patch files
                   2139:            if not found locally or in
                   2140:            <code class="filename">${MASTER_SITES}</code> or
                   2141:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2142:            The defaults are
1.25      spz      2143:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1       dsieger  2144:            and
                   2145:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      2146: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  2147:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2148:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      2149:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2150:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2151: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 2152:            List of acceptable licenses. License names are case-sensitive.
                   2153:            Whenever you try to build a package whose license is not in this
                   2154:            list, you will get an error message. If the license condition is
                   2155:            simple enough, the error message will include specific
                   2156:            instructions on how to change this variable.</p></li>
1.1       dsieger  2157: </ul></div>
                   2158: </div>
1.41      asau     2159: <div class="sect1">
1.1       dsieger  2160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2161: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2162: <p>XXX
                   2163:       </p>
1.41      asau     2164: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2165: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  2166:            directory for the binary packages. The default is
                   2167:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      2168: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  2169:            The top level directory where, if defined, the separate
                   2170:            working directories will get created, and symbolically
                   2171:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2172:            This is useful for building packages on several
                   2173:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2174:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2175:            is local to every architecture. (It should be noted that
                   2176:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 2177:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2178:            root of the pkgsrc tree. It is possible to have many
                   2179:            pkgsrc tree instances.)</p></li>
1.23      wiz      2180: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  2181:            Directory for local patches that aren't part of pkgsrc.
1.10      hubertf  2182:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2183:            information.</p></li>
1.23      wiz      2184: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  2185:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2186:            BSD-style Makefile. If this is not set,
                   2187:            <code class="varname">MAKECONF</code> is set to
                   2188:            <code class="filename">/dev/null</code> to avoid picking up
                   2189:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23      wiz      2190: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger  2191:            By default, dependencies are only installed, and no binary
                   2192:            package is created for them. You can set this variable to
                   2193:            <code class="literal">package</code> to automatically create binary
                   2194:            packages after installing dependencies.</p></li>
                   2195: </ul></div>
                   2196: </div>
1.41      asau     2197: <div class="sect1">
1.1       dsieger  2198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   2199: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24      wiz      2200: <p>Most packages support installation into a
1.4       rillig   2201:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2202:     to be built, before the actual filesystem is touched. DESTDIR
                   2203:     support exists in two variations:</p>
1.41      asau     2204: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2205: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      2206:       installation and packaging is still run as root.</p></li>
                   2207: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2208:       build, installation and packaging as normal user. Root
                   2209:       privileges are only needed to add packages.</p></li>
                   2210: </ul></div>
                   2211: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                   2212:     you can set
                   2213:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                   2214:     so it's preferable to convert a package to DESTDIR instead.</p>
1.4       rillig   2215: <p>DESTDIR support changes the behaviour of various targets
                   2216:     slightly. To install a package after building it, use
                   2217:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2218:     <code class="literal">install</code> don't do that any
                   2219:     longer. <code class="literal">package-install</code> can be used as
                   2220:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2221:     will ask for the root password to install the package and fail,
                   2222:     <code class="literal">package-install</code> will ask again.</p>
                   2223: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2224:     clean</code></strong> needs to be run as root.</p>
1.17      imil     2225: <p>Considering the <code class="filename">foo/bar</code> package,
                   2226:     DESTDIR full support can be tested using the following commands
                   2227: 
                   2228: </p>
                   2229: <pre class="programlisting">
                   2230: <code class="prompt">$</code> id
                   2231: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2232: <code class="prompt">$</code> mkdir $HOME/packages
                   2233: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2234: </pre>
                   2235: <p>
                   2236: 
                   2237:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2238:     should be needed
                   2239: 
                   2240: </p>
                   2241: <pre class="programlisting">
1.20      snj      2242: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17      imil     2243: </pre>
                   2244: <p>
                   2245: 
                   2246:     Create a package without root privileges
                   2247: 
                   2248: </p>
                   2249: <pre class="programlisting">
1.20      snj      2250: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17      imil     2251: </pre>
                   2252: <p>
                   2253: 
                   2254:     For the following command, you must be able to gain root
1.29      dholland 2255:     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     2256: 
                   2257: </p>
                   2258: <pre class="programlisting">
1.20      snj      2259: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17      imil     2260: </pre>
                   2261: <p>
                   2262: 
                   2263:     Then, as a simple user
                   2264: 
                   2265: </p>
                   2266: <pre class="programlisting">
                   2267: <code class="prompt">$</code> make clean
                   2268: </pre>
                   2269: <p>
                   2270: 
                   2271:     </p>
1.4       rillig   2272: </div>
1.41      asau     2273: <div class="sect1">
1.4       rillig   2274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2275: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     2276: <div class="sect2">
1.1       dsieger  2277: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2278: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2279: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2280:     overridden by setting the following variables in /etc/mk.conf:</p>
1.41      asau     2281: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2282: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2283: <dd>
                   2284: <p>This is a list of values specifying the chain of
                   2285:          compilers to invoke when building packages.  Valid values
                   2286:          are:</p>
1.41      asau     2287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2288: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  2289:            distributed C/C++ (chainable)</p></li>
1.23      wiz      2290: <li class="listitem"><p><code class="varname">ccache</code>:
1.1       dsieger  2291:            compiler cache (chainable)</p></li>
1.23      wiz      2292: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  2293:            GNU C/C++ Compiler</p></li>
1.23      wiz      2294: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2295:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23      wiz      2296: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2297:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      2298: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  2299:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2300: </ul></div>
                   2301: <p>The default is
1.23      wiz      2302:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  2303:          <code class="varname">ccache</code> and/or
                   2304:          <code class="varname">distcc</code> with an appropriate
                   2305:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      2306:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  2307:          variable should always be terminated with a value for
                   2308:          a real compiler.  Note that only one real compiler
1.23      wiz      2309:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  2310:          is not allowed).</p>
                   2311: </dd>
                   2312: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2313: <dd><p>This specifies the minimum version of GCC to use
                   2314:          when building packages.  If the system GCC doesn't
                   2315:          satisfy this requirement, then pkgsrc will build and
                   2316:          install one of the GCC packages to use instead.</p></dd>
                   2317: </dl></div>
                   2318: </div>
1.41      asau     2319: <div class="sect2">
1.1       dsieger  2320: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2321: <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  2322: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2323:        please make sure to use the <code class="literal">+=</code> operator
                   2324:        instead of the <code class="literal">=</code> operator:</p>
                   2325: <pre class="programlisting">
                   2326: CFLAGS+=        -your -flags
                   2327: </pre>
                   2328: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      2329:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  2330:        need to add their own flags.  You may want to take a look
                   2331:        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      2332:        package if you're interested in optimization specifically
                   2333:        for the current CPU. </p>
1.1       dsieger  2334: </div>
1.41      asau     2335: <div class="sect2">
1.1       dsieger  2336: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2337: <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  2338: <p>If you want to pass flags to the linker, both in the configure
                   2339: step and the build step, you can do this in two ways.  Either set
                   2340: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2341: between the two is that <code class="varname">LIBS</code> will be appended to
                   2342: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2343: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2344: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2345: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2346: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2347: settings, use the <code class="literal">+=</code> operator:</p>
                   2348: <pre class="programlisting">
                   2349: LDFLAGS+=        -your -linkerflags
                   2350: </pre>
                   2351: </div>
                   2352: </div>
1.41      asau     2353: <div class="sect1">
1.1       dsieger  2354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2355: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2356: <p>XXX
                   2357:       </p>
1.41      asau     2358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2359: <li class="listitem">
1.1       dsieger  2360: <p><code class="varname">PKG_DEVELOPER</code>:
                   2361:            Run some sanity checks that package developers want:
                   2362:            </p>
1.41      asau     2363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      2364: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  2365:              fuzz</p></li>
1.23      wiz      2366: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  2367:              binaries will find their shared libs.</p></li>
                   2368: </ul></div>
                   2369: <p>
                   2370:        </p>
                   2371: </li>
1.23      wiz      2372: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  2373:        of debugging output which is displayed whilst making and
                   2374:        installing the package.  The default value for this is 0,
                   2375:        which will not display the commands as they are executed
                   2376:        (normal, default, quiet operation); the value 1 will display
                   2377:        all shell commands before their invocation, and the value 2
                   2378:        will display both the shell commands before their invocation,
1.10      hubertf  2379:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger  2380:        -x</strong></span> will be displayed.</p></li>
                   2381: </ul></div>
                   2382: <p>
                   2383:     </p>
                   2384: </div>
1.41      asau     2385: <div class="sect1">
1.1       dsieger  2386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2387: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2388: <p>Some packages have build time options, usually to select
                   2389:     between different dependencies, enable optional support for big
                   2390:     dependencies or enable experimental features.</p>
                   2391: <p>To see which options, if any, a package supports, and which
1.10      hubertf  2392:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2393:     show-options</strong></span>, for example:</p>
                   2394: <pre class="programlisting">
                   2395:     The following options are supported by this package:
                   2396:         ssl      Enable SSL support.
                   2397:     Exactly one of the following gecko options is required:
                   2398:         firefox  Use firefox as gecko rendering engine.
                   2399:         mozilla  Use mozilla as gecko rendering engine.
                   2400:     At most one of the following database options may be selected:
                   2401:         mysql    Enable support for MySQL database.
                   2402:         pgsql    Enable support for PostgreSQL database.
                   2403: 
                   2404:     These options are enabled by default: firefox
                   2405:     These options are currently enabled: mozilla ssl
                   2406: </pre>
                   2407: <p>The following variables can be defined in
1.10      hubertf  2408:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2409:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2410:     which can be used to select or disable options for all packages
                   2411:     that support them, and
                   2412:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2413:     which can be used to select or disable options specifically for
                   2414:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      2415:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2416:     are disabled. A few examples:</p>
                   2417: <pre class="screen">
1.10      hubertf  2418: <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  2419: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2420: PKG_OPTIONS.kdebase=    debug -sasl
                   2421: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2422: <p>It is important to note that options that were specifically
1.18      snj      2423:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   2424:     you do not wish to include the option.  If you are unsure you can view
                   2425:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2426: <p>The following settings are consulted in the order given, and
                   2427:     the last setting that selects or disables an option is
                   2428:     used:</p>
1.23      wiz      2429: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2430: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2431:       maintainer</p></li>
1.23      wiz      2432: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2433:       variables (see below)</p></li>
1.23      wiz      2434: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2435: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  2436: </ol></div>
                   2437: <p>For groups of mutually exclusive options, the last option
                   2438:     selected is used, all others are automatically disabled.  If an
                   2439:     option of the group is explicitly disabled, the previously
                   2440:     selected option, if any, is used.  It is an error if no option
                   2441:     from a required group of options is selected, and building the
                   2442:     package will fail.</p>
                   2443: <p>Before the options framework was introduced, build options
                   2444:     were selected by setting a variable (often named
                   2445:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2446:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2447:     transition to the options framework for the user, these legacy
                   2448:     variables are converted to the appropriate options setting
                   2449:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2450:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2451:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2452:     directly.  Support for the legacy variables will be removed
                   2453:     eventually.</p>
                   2454: </div>
                   2455: </div>
1.41      asau     2456: <div class="chapter">
1.1       dsieger  2457: <div class="titlepage"><div><div><h2 class="title">
                   2458: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2459: <div class="toc">
                   2460: <p><b>Table of Contents</b></p>
                   2461: <dl>
                   2462: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2463: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2464: </dl>
                   2465: </div>
1.41      asau     2466: <div class="sect1">
1.1       dsieger  2467: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2468: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2469: <p>Once you have built and installed a package, you can create
                   2470:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29      dholland 2471:     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  2472:     the same package on a group of hosts and wasting CPU time. It also
                   2473:     provides a simple means for others to install your package, should
                   2474:     you distribute it.</p>
                   2475: <p>To create a binary package, change into the appropriate
1.10      hubertf  2476:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2477:     package</strong></span>:</p>
                   2478: <pre class="screen">
                   2479: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2480: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2481:     </pre>
                   2482: <p>This will build and install your package (if not already done),
                   2483:     and then build a binary package from what was installed. You can
1.10      hubertf  2484:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2485:     it. Binary packages are created by default in
                   2486:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2487:     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  2488:     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  2489: <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  2490:     such a binary package.</p>
                   2491: </div>
1.41      asau     2492: <div class="sect1">
1.1       dsieger  2493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2494: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2495: <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   2496: </div>
                   2497: </div>
1.41      asau     2498: <div class="chapter">
1.6       rillig   2499: <div class="titlepage"><div><div><h2 class="title">
                   2500: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2501: builds)</h2></div></div></div>
                   2502: <div class="toc">
                   2503: <p><b>Table of Contents</b></p>
                   2504: <dl>
                   2505: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2506: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2507: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2508: <dd><dl>
                   2509: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2510: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2511: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2512: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2513: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2514: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2515: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2516: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2517: </dl></dd>
                   2518: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig   2519: <dd><dl>
                   2520: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2521: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2522: </dl></dd>
1.6       rillig   2523: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2524: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2525: </dl>
                   2526: </div>
                   2527: <p>When you have multiple machines that should run the same packages,
                   2528: it is wasted time if they all build their packages themselves from
                   2529: source. There are two ways of getting a set of binary packages: The old
                   2530: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2531: system. This chapter describes how to set them up so that the packages
                   2532: are most likely to be usable later.</p>
1.41      asau     2533: <div class="sect1">
1.6       rillig   2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2535: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2536: <p>Since a bulk build takes several days or even weeks to finish, you
                   2537: should think about the setup before you start everything. Pay attention
                   2538: to at least the following points:</p>
1.41      asau     2539: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2540: <li class="listitem">
1.6       rillig   2541: <p>If you want to upload the binary packages to
                   2542: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2543: packages:</p>
1.41      asau     2544: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      2545: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6       rillig   2546: by a NetBSD developer on a trusted machine (that is, where you and only
                   2547: you have root access).</p></li>
1.23      wiz      2548: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21      snj      2549: the stable branches (like 2009Q1), so that users browsing the available
1.6       rillig   2550: collections can see at a glance how old the packages
                   2551: are.</p></li>
1.23      wiz      2552: <li class="listitem"><p>The packages must be built as root, since some packages
1.6       rillig   2553: require set-uid binaries at runtime, and creating those packages as
                   2554: unprivileged user doesn't work well at the moment.</p></li>
                   2555: </ul></div>
                   2556: </li>
1.23      wiz      2557: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6       rillig   2558: your system. Most bulk builds run as root, so they should be run at least
                   2559: in a chroot environment or something even more restrictive, depending on
                   2560: what the operating system provides. There have been numerous cases where
                   2561: certain packages tried to install files outside the
                   2562: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2563: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2564: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2565: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2566: that you don't need any package during the build.</p></li>
                   2567: </ul></div>
                   2568: </div>
1.41      asau     2569: <div class="sect1">
1.6       rillig   2570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2571: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2572: <p>A complete bulk build requires lots of disk space. Some of the
                   2573: disk space can be read-only, some other must be writable. Some can be on
                   2574: remote filesystems (such as NFS) and some should be local. Some can be
                   2575: temporary filesystems, others must survive a sudden reboot.</p>
1.41      asau     2576: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2577: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2578: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2579: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2580: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2581: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2582: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6       rillig   2583: </ul></div>
1.1       dsieger  2584: </div>
1.41      asau     2585: <div class="sect1">
1.1       dsieger  2586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2587: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.41      asau     2588: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15      rillig   2589: <h3 class="title">Note</h3>
                   2590: <p>There are two ways of doing a bulk build. The old-style
1.23      wiz      2591: one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
1.15      rillig   2592: way.</p>
1.6       rillig   2593: </div>
1.41      asau     2594: <div class="sect2">
1.1       dsieger  2595: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2596: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.41      asau     2597: <div class="sect3">
1.1       dsieger  2598: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2599: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2600: </h4></div></div></div>
                   2601: <p>The <code class="filename">build.conf</code> file is the main
                   2602:        configuration file for bulk builds. You can configure how your
                   2603:        copy of pkgsrc is kept up to date, how the distfiles are
                   2604:        downloaded, how the packages are built and how the report is
                   2605:        generated. You can find an annotated example file in
                   2606:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2607:        it, copy <code class="filename">build.conf-example</code> to
                   2608:        <code class="filename">build.conf</code> and edit it, following the
                   2609:        comments in that file.</p>
                   2610: </div>
1.41      asau     2611: <div class="sect3">
1.1       dsieger  2612: <div class="titlepage"><div><div><h4 class="title">
1.10      hubertf  2613: <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   2614: </h4></div></div></div>
1.10      hubertf  2615: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2616:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2617:        details of the default settings. You will want to ensure that
                   2618:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22      jakllsch 2619:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4       rillig   2620:        completely bypasses the license check.</p>
1.1       dsieger  2621: <pre class="programlisting">
                   2622: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2623: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2624: BSDSRCDIR=      /usr/src
                   2625: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2626: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2627: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2628: PKG_DEVELOPER?= yes
1.22      jakllsch 2629: SKIP_LICENSE_CHECK=    yes
1.1       dsieger  2630: </pre>
                   2631: <p>Some options that are especially useful for bulk builds
                   2632:        can be found at the top lines of the file
                   2633:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2634:        options of these are briefly described here.</p>
1.41      asau     2635: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2636: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1       dsieger  2637:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23      wiz      2638:          <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
                   2639: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1       dsieger  2640:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2641:          to the directory where all log files are created. Otherwise the
                   2642:          log files are created in the pkgsrc directory.</p></li>
1.23      wiz      2643: <li class="listitem"><p>Another important variable is
1.1       dsieger  2644:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2645:          should be always available while building other
                   2646:          packages.</p></li>
                   2647: </ul></div>
                   2648: <p>Some other options are scattered in the pkgsrc
                   2649:        infrastructure:</p>
1.41      asau     2650: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2651: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2652:          should be set to <code class="literal">yes</code>. The purpose of the
                   2653:          bulk builds is creating binary packages, no matter if they
                   2654:          are vulnerable or not. Leaving this variable unset would
                   2655:          prevent the bulk build system from even trying to build
                   2656:          them, so possible building errors would not show
                   2657:          up.</p></li>
                   2658: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1       dsieger  2659:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23      wiz      2660:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
1.1       dsieger  2661:          matches the <code class="filename">PLIST</code>.</p></li>
1.23      wiz      2662: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1       dsieger  2663:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23      wiz      2664:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
                   2665:          <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
1.1       dsieger  2666:          interpreter.</p></li>
1.23      wiz      2667: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2668:          set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
1.1       dsieger  2669:          package's self-test before installing it. Note that some
1.23      wiz      2670:          packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
1.1       dsieger  2671:          numbers, so you need to assure that the machine on which you
                   2672:          are doing the bulk builds is not completely idle. Otherwise
                   2673:          some test programs will seem to hang, while they are just
                   2674:          waiting for new random data to be
                   2675:          available.</p></li>
                   2676: </ul></div>
                   2677: </div>
1.41      asau     2678: <div class="sect3">
1.1       dsieger  2679: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2680: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2681: </h4></div></div></div>
                   2682: <p>It is possible to configure the bulk build to perform
                   2683:        certain site-specific tasks at the end of the pre-build
                   2684:        stage.  If the file
                   2685:        <code class="filename">pre-build.local</code> exists in
                   2686:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29      dholland 2687:        (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  2688:        stage.  An example use of
                   2689:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2690: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2691:        &gt; misc/openoffice/$BROKENF</pre>
                   2692: <p>to prevent the system from trying to build a particular package
                   2693:        which requires nearly 3 GB of disk space.</p>
                   2694: </div>
                   2695: </div>
1.41      asau     2696: <div class="sect2">
1.1       dsieger  2697: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2698: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2699: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2700:       deleted at the start of bulk builds, make sure your login
                   2701:       shell is placed somewhere else. Either drop it into
                   2702:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2703:       shell in the passwd file), or (re-)install it via
1.29      dholland 2704:       <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  2705:       you can login after a reboot (remember that your current
                   2706:       process won't die if the package is removed, you just can't
                   2707:       start any new instances of the shell any more).  Also, if you
                   2708:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2709:       version of ssh for some reason, be sure to install ssh before
                   2710:       starting it from <code class="filename">rc.local</code>:</p>
                   2711: <pre class="programlisting">
                   2712: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2713: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2714:   /usr/pkg/etc/rc.d/sshd
                   2715: fi
                   2716: </pre>
                   2717: <p>Not doing so will result in you being not able to log in
                   2718:       via ssh after the bulk build is finished or if the machine
                   2719:       gets rebooted or crashes. You have been warned! :)</p>
                   2720: </div>
1.41      asau     2721: <div class="sect2">
1.1       dsieger  2722: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2723: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2724: <p>Make sure you don't need any of the packages still
                   2725:       installed.</p>
1.41      asau     2726: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  2727: <h3 class="title">Warning</h3>
                   2728: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2729:        configuration files and some more files from
                   2730:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2731:        possibly other locations will be removed! So don't run a bulk
                   2732:        build with privileges that might harm your
                   2733:        system.</em></span></p>
                   2734: </div>
                   2735: <p>Be sure to remove all other things that might
                   2736:       interfere with builds, like some libs installed in
                   2737:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2738: <pre class="screen">
                   2739: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2740: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2741:       </pre>
                   2742: <p>If for some reason your last build didn't complete (power
                   2743:       failure, system panic, ...), you can continue it by
                   2744:       running:</p>
                   2745: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2746: <p>At the end of the bulk build, you will get a summary via mail,
                   2747:       and find build logs in the directory specified by
                   2748:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2749:       file.</p>
                   2750: </div>
1.41      asau     2751: <div class="sect2">
1.1       dsieger  2752: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2753: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2754: <p>The bulk builds consist of three steps:</p>
1.41      asau     2755: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2756: <dt><span class="term">1. pre-build</span></dt>
                   2757: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2758:            cleans out any broken distfiles, and removes all
                   2759:            packages installed.</p></dd>
                   2760: <dt><span class="term">2. the bulk build</span></dt>
1.23      wiz      2761: <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
1.1       dsieger  2762:            an optimised order in which packages will be
                   2763:            built. Packages that don't require other packages will
                   2764:            be built first, and packages with many dependencies will
                   2765:            be built later.</p></dd>
                   2766: <dt><span class="term">3. post-build</span></dt>
                   2767: <dd><p>Generates a report that's placed in the directory
                   2768:            specified in the <code class="filename">build.conf</code> file
                   2769:            named <code class="filename">broken.html</code>, a short version
                   2770:            of that report will also be mailed to the build's
                   2771:            admin.</p></dd>
                   2772: </dl></div>
                   2773: <p>During the build, a list of broken packages will be compiled
                   2774:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2775:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2776:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2777:       of broken builds can be found in the package's
                   2778:       directory. These files are used by the bulk-targets to mark
                   2779:       broken builds to not waste time trying to rebuild them, and
                   2780:       they can be used to debug these broken package builds
                   2781:       later.</p>
                   2782: </div>
1.41      asau     2783: <div class="sect2">
1.1       dsieger  2784: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2785: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2786: <p>Currently, roughly the following requirements are valid for
                   2787:       NetBSD 2.0/i386:</p>
1.41      asau     2788: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2789: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
                   2790: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2791: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1       dsieger  2792: </ul></div>
                   2793: <p>Note that all pkgs will be de-installed as soon as they are
                   2794:       turned into a binary package, and that sources are removed,
                   2795:       so there is no excessively huge demand to disk
                   2796:       space. Afterwards, if the package is needed again, it will
1.29      dholland 2797:       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  2798:       there are no cycles wasted by recompiling.</p>
                   2799: </div>
1.41      asau     2800: <div class="sect2">
1.1       dsieger  2801: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2802: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2803: <p>If you don't want all the packages nuked from a machine
                   2804:       (rendering it useless for anything but pkg compiling), there
                   2805:       is the possibility of doing the package bulk build inside a
                   2806:       chroot environment.</p>
                   2807: <p>The first step is to set up a chroot sandbox,
                   2808:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2809:       using null mounts, or manually.</p>
                   2810: <p>There is a shell script called
1.36      wiz      2811:       <code class="filename">mksandbox</code> installed by the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mksandbox/README.html" target="_top"><code class="filename">pkgtools/mksandbox</code></a> package, which will set
1.1       dsieger  2812:       up the sandbox environment using null mounts. It will also
                   2813:       create a script called <code class="filename">sandbox</code> in the
                   2814:       root of the sandbox environment, which will allow the null
1.10      hubertf  2815:       mounts to be activated using the <span class="command"><strong>sandbox
1.1       dsieger  2816:       mount</strong></span> command and deactivated using the
1.10      hubertf  2817:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1       dsieger  2818: <p>To set up a sandbox environment by hand, after extracting all
1.10      hubertf  2819:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1       dsieger  2820:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2821:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2822:       are present and properly configured:</p>
1.23      wiz      2823: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     2824: <li class="step">
1.1       dsieger  2825: <p>Kernel</p>
                   2826: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2827: </li>
1.41      asau     2828: <li class="step">
1.1       dsieger  2829: <p><code class="filename">/dev/*</code></p>
                   2830: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2831: </li>
1.41      asau     2832: <li class="step">
1.1       dsieger  2833: <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>
                   2834: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2835: </li>
1.41      asau     2836: <li class="step">
1.1       dsieger  2837: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2838: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2839: </li>
1.41      asau     2840: <li class="step">
1.1       dsieger  2841: <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>
                   2842: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2843: </li>
1.41      asau     2844: <li class="step">
1.1       dsieger  2845: <p><code class="filename">/usr/src</code> (system sources,
1.14      jmcneill 2846:          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  2847: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2848:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2849: </li>
1.41      asau     2850: <li class="step">
1.1       dsieger  2851: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2852: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2853: </li>
1.41      asau     2854: <li class="step">
1.1       dsieger  2855: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2856: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2857: </li>
1.41      asau     2858: <li class="step">
1.1       dsieger  2859: <p>Checkout pkgsrc via cvs into
                   2860:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2861: <pre class="screen">
                   2862: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2863: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2864:          </pre>
                   2865: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2866:          you do development in, as this will likely cause problems!</p>
                   2867: </li>
1.41      asau     2868: <li class="step"><p>Make
1.1       dsieger  2869:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2870:          <code class="filename">.../distfiles</code> point somewhere
                   2871:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.41      asau     2872: <li class="step"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
                   2873: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.1       dsieger  2874: </ol></div>
                   2875: <p>When the chroot sandbox is set up, you can start
                   2876:       the build with the following steps:</p>
                   2877: <pre class="screen">
                   2878: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2879: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2880:       </pre>
                   2881: <p>This will just jump inside the sandbox and start building.  At
                   2882:        the end of the build, mail will be sent with the results of
                   2883:        the build. Created binary pkgs will be in
                   2884:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2885:       (wherever that points/mounts to/from).</p>
                   2886: </div>
1.41      asau     2887: <div class="sect2">
1.1       dsieger  2888: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2889: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2890: <p>In addition to building a complete set of all packages in
                   2891:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2892:       may be used to build a subset of the packages contained in
                   2893:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.10      hubertf  2894:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.41      asau     2895: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2896: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
                   2897: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
                   2898: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
                   2899: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1       dsieger  2900: </ul></div>
                   2901: <p>will define the set of packages which should be built.
                   2902:       The bulk build code will also include any packages which are
                   2903:       needed as dependencies for the explicitly listed packages.</p>
                   2904: <p>One use of this is to do a bulk build with
                   2905:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2906:       periodically to have a complete set of the binary packages
                   2907:       needed for your site available without the overhead of
                   2908:       building extra packages that are not needed.</p>
                   2909: </div>
1.41      asau     2910: <div class="sect2">
1.1       dsieger  2911: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2912: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2913: <p>This section describes how pkgsrc developers can upload binary
                   2914:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2915: <p>If you would like to automatically create checksum files for the
                   2916:       binary packages you intend to upload, remember to set
                   2917:       <code class="varname">MKSUMS=yes</code> in your
                   2918:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2919: <p>If you would like to PGP sign the checksum files (highly
                   2920:       recommended!), remember to set
                   2921:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2922:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2923:       your GPG password to sign the files before uploading everything.</p>
                   2924: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2925:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2926:       file, i.e. adjust it to something like one of the following:</p>
1.25      spz      2927: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
                   2928: <p>Please use appropriate values for "20xxQy" (the branch),
                   2929:       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1       dsieger  2930:       is different from your local login, write your login directly
                   2931:       into the variable, e.g. my local account is "feyrer", but for my
                   2932:       login "hubertf", I use:</p>
1.25      spz      2933: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1       dsieger  2934: <p>A separate <code class="filename">upload</code> directory is used
                   2935:       here to allow "closing" the directory during upload. To do
                   2936:       so, run the following command on ftp.NetBSD.org next:</p>
1.25      spz      2937: <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  2938: <p>Before uploading the binary pkgs, ssh authentication needs
                   2939:       to be set up. This example shows how to set up temporary keys
                   2940:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2941:       (assuming that no keys should be present there usually):</p>
                   2942: <pre class="screen">
                   2943: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2944: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25      spz      2945: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
                   2946: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1       dsieger  2947:       </pre>
1.25      spz      2948: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1       dsieger  2949:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25      spz      2950:       file on ftp.NetBSD.org. You should remove the key after the
1.1       dsieger  2951:       upload is done!</p>
                   2952: <p>Next, test if your ssh connection really works:</p>
                   2953: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2954: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2955: <p>Now after all this works, you can exit the sandbox and start
                   2956:       the upload:</p>
                   2957: <pre class="screen">
                   2958: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2959: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2960: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2961:       </pre>
1.29      dholland 2962: <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
                   2963:       <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  2964:       upload. The upload script will take care of not uploading
1.23      wiz      2965:       restricted packages.</p>
1.1       dsieger  2966: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2967: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2968:       Gdd:x! </pre>
                   2969: <p>Use whatever is needed to remove the key you've entered
                   2970:       before! Last, move the uploaded packages out of the
                   2971:       <code class="filename">upload</code> directory to have them accessible
                   2972:       to everyone:</p>
                   2973: <pre class="screen">
1.25      spz      2974: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1       dsieger  2975: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2976: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25      spz      2977: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
                   2978: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1       dsieger  2979:       </pre>
                   2980: </div>
                   2981: </div>
1.41      asau     2982: <div class="sect1">
1.1       dsieger  2983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2984: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2985: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41      asau     2986: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2987: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2988: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2989: </ul></div>
1.41      asau     2990: <div class="sect2">
1.15      rillig   2991: <div class="titlepage"><div><div><h3 class="title">
                   2992: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
                   2993: <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>
                   2994: <pre class="screen">
                   2995: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2996: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   2997: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   2998: </pre>
                   2999: <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.41      asau     3000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3001: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3002: <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>
                   3003: <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>
                   3004: <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>
                   3005: <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   3006: </ul></div>
                   3007: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3008: <pre class="screen">
                   3009: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3010: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3011: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3012: </pre>
                   3013: <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>
                   3014: </div>
1.41      asau     3015: <div class="sect2">
1.6       rillig   3016: <div class="titlepage"><div><div><h3 class="title">
1.15      rillig   3017: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14      jmcneill 3018: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15      rillig   3019: <p>TODO: continue writing</p>
1.6       rillig   3020: </div>
                   3021: </div>
1.41      asau     3022: <div class="sect1">
1.6       rillig   3023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3024: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  3025: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3026:     create a CD-ROM set of the resulting binary packages to assist
                   3027:     in installing packages on other machines.  The
                   3028:     <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
                   3029:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  3030:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  3031:     way that keeps all the dependencies for a given package on the same
                   3032:     CD as that package.</p>
1.41      asau     3033: <div class="sect2">
1.1       dsieger  3034: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3035: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  3036: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3037:       man page. The following short example assumes that the binary
                   3038:       packages are left in
                   3039:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3040:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3041:       hold the ISO 9660 images.</p>
                   3042: <pre class="screen">
                   3043: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   3044: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   3045: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3046:       </pre>
                   3047: <p>If you wish to include a common set of files
                   3048:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3049:       etc.) on each CD in the collection, then you need to create a
                   3050:       directory which contains these files. e.g.</p>
                   3051: <pre class="screen">
                   3052: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   3053: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3054: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3055: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3056: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3057: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   3058: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3059:       </pre>
                   3060: <p>Now create the images:</p>
                   3061: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   3062: <p>Each image will contain <code class="filename">README</code>,
                   3063:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3064:       in their root directories.</p>
                   3065: </div>
                   3066: </div>
                   3067: </div>
1.41      asau     3068: <div class="chapter">
1.1       dsieger  3069: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3070: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  3071: <div class="toc">
                   3072: <p><b>Table of Contents</b></p>
                   3073: <dl>
1.23      wiz      3074: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3075: <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  3076: </dl>
                   3077: </div>
                   3078: <p>The files that are installed by pkgsrc are organized in a way that
                   3079: is similar to what you find in the <code class="filename">/usr</code> directory
                   3080: of the base system. But some details are different. This is because
                   3081: pkgsrc initially came from FreeBSD and had adopted its file system
                   3082: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3083: which operating system you are using pkgsrc with, you can expect the
                   3084: same layout for pkgsrc.</p>
                   3085: <p>There are mainly four root directories for pkgsrc, which are all
                   3086: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3087: When pkgsrc has been installed as root, the default locations
                   3088: are:</p>
                   3089: <pre class="programlisting">
                   3090: LOCALBASE=              /usr/pkg
                   3091: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3092: VARBASE=                /var
                   3093: PKG_DBDIR=              /var/db/pkg
                   3094: </pre>
                   3095: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3096: user), the default locations are:</p>
                   3097: <pre class="programlisting">
                   3098: LOCALBASE=              ${HOME}/pkg
                   3099: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3100: VARBASE=                ${HOME}/pkg/var
                   3101: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3102: </pre>
                   3103: <p>What these four directories are for, and what they look like is
                   3104: explained below.</p>
1.41      asau     3105: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3106: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  3107: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      3108: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  3109: the well-known subdirectories like <code class="filename">bin</code>,
                   3110: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3111: <code class="filename">share</code> and
                   3112: <code class="filename">sbin</code>.</p></li>
1.23      wiz      3113: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  3114: <code class="filename">/var</code> in the base system. Some programs (especially
                   3115: games, network daemons) need write access to it during normal
                   3116: operation.</p></li>
1.23      wiz      3117: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  3118: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  3119: 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  3120: itself.</p></li>
                   3121: </ul></div>
1.41      asau     3122: <div class="sect1">
1.1       dsieger  3123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3124: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3125: </h2></div></div></div>
                   3126: <p>The following directories exist in a typical pkgsrc installation
                   3127: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     3128: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3129: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3130: <dd><p>Contains executable programs that are intended to be
                   3131: directly used by the end user.</p></dd>
                   3132: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3133: <dd><p>Contains files for the emulation layers of various other
                   3134: operating systems, especially for
                   3135: NetBSD.</p></dd>
                   3136: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3137: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3138: <dd><p>Contains
                   3139: the configuration files.</p></dd>
                   3140: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3141: <dd><p>Contains headers for the C and C++ programming
                   3142: languages.</p></dd>
                   3143: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3144: <dd><p>Contains GNU info files of various
                   3145: packages.</p></dd>
                   3146: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3147: <dd><p>Contains shared and static
                   3148: libraries.</p></dd>
                   3149: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3150: <dd><p>Contains data files that don't change after
                   3151: installation. Other data files belong into
                   3152: <code class="filename">${VARBASE}</code>.</p></dd>
                   3153: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3154: <dd><p>Contains programs that are not intended to be used by
                   3155: end users, such as helper programs or network
                   3156: daemons.</p></dd>
                   3157: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3158: <dd><p>Contains programs that are intended to be executed as
                   3159: CGI scripts by a web server.</p></dd>
                   3160: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3161: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3162: <dd><p>Contains brief
                   3163: documentation in form of manual pages.</p></dd>
                   3164: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3165: <dd><p>Contains programs that are intended to be used only by
                   3166: the super-user.</p></dd>
                   3167: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3168: <dd><p>Contains platform-independent data files that don't
                   3169: change after installation.</p></dd>
                   3170: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3171: <dd><p>Contains documentation files provided by the
                   3172: packages.</p></dd>
                   3173: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3174: <dd><p>Contains example files provided by the packages. Among
                   3175: others, the original configuration files are saved here and copied to
                   3176: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3177: installation.</p></dd>
                   3178: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3179: <dd><p>Contains the original files for rc.d
                   3180: scripts.</p></dd>
                   3181: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3182: <code class="filename">${VARBASE}</code>)</span></dt>
                   3183: <dd><p>Contains files
                   3184: that may be modified after
                   3185: installation.</p></dd>
                   3186: </dl></div>
                   3187: </div>
1.41      asau     3188: <div class="sect1">
1.1       dsieger  3189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3190: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3191: </h2></div></div></div>
1.41      asau     3192: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3193: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3194: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3195: <dd><p>Contains
                   3196: information about the currently installed
                   3197: packages.</p></dd>
                   3198: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3199: <dd><p>Contains highscore
                   3200: files.</p></dd>
                   3201: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3202: <dd><p>Contains log files.</p></dd>
                   3203: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3204: <dd><p>Contains informational files about daemons that are
                   3205: currently running.</p></dd>
                   3206: </dl></div>
                   3207: </div>
                   3208: </div>
1.41      asau     3209: <div class="chapter">
1.1       dsieger  3210: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3211: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3212: <div class="toc">
                   3213: <p><b>Table of Contents</b></p>
                   3214: <dl>
1.6       rillig   3215: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3216: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3217: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3218: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3219: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3220: <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>
                   3221: <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      3222: <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   3223: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz      3224: <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
                   3225: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                   3226: <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   3227: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3228: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3229: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz      3230: <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   3231: <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      3232: <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  3233: </dl>
                   3234: </div>
                   3235: <p>This section contains hints, tips &amp; tricks on special things in
                   3236: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3237: it contains items for both pkgsrc users and developers.</p>
1.41      asau     3238: <div class="sect1">
1.1       dsieger  3239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3240: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3241: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     3242: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3243: <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  3244:          This is a general purpose list for most issues regarding
                   3245:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3246:          for pkgsrc configuration, unexpected build failures, using
                   3247:          particular packages, upgrading pkgsrc installations,
                   3248:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3249:          proposals for changes that impact the pkgsrc user community,
                   3250:          e.g. major infrastructure changes, new features, package
                   3251:          removals, etc., may also be posted.</p></li>
1.23      wiz      3252: <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  3253:          A list where the results of pkgsrc bulk builds are sent and
                   3254:          discussed.</p></li>
1.23      wiz      3255: <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  3256:          This list is for those who are interested in getting a
                   3257:          commit message for every change committed to pkgsrc. It is
                   3258:          also available in digest form, meaning one daily message
                   3259:          containing all commit messages for changes to the package
                   3260:          source tree in that 24 hour period.</p></li>
                   3261: </ul></div>
                   3262: <p>To subscribe, do:</p>
                   3263: <pre class="programlisting">
                   3264: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3265: </pre>
                   3266: <p>Archives for all these mailing lists are available from
1.10      hubertf  3267: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  3268: </div>
1.41      asau     3269: <div class="sect1">
1.1       dsieger  3270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3271: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3272: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3273: pkgviews User's guide in
                   3274: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3275: </div>
1.41      asau     3276: <div class="sect1">
1.1       dsieger  3277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3278: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3279: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3280: a number of useful utilities for both users and developers of pkgsrc.  This
                   3281: section attempts only to make the reader aware of the utilities and when
                   3282: they might be useful, and not to duplicate the documentation that comes
                   3283: with each package.</p>
                   3284: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.41      asau     3285: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1       dsieger  3286:       Symlinks for use by buildlink.</p></li></ul></div>
                   3287: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     3288: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3289: <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  3290:       Calculates various kinds of checksums (including SHA1).</p></li>
1.23      wiz      3291: <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  3292:       Compatibility library for pkgsrc tools.</p></li>
1.23      wiz      3293: <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  3294:       non-BSD systems due to lack of native mtree.</p></li>
1.23      wiz      3295: <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  3296:       Up-to-date replacement for
                   3297:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3298:       systems where pkg_install is not present.</p></li>
                   3299: </ul></div>
                   3300: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     3301: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3302: <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  3303:       Create a binary package from an
1.10      hubertf  3304:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  3305:       save the old package.</p></li>
1.23      wiz      3306: <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  3307:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3308:       from multiple locations. It currently supports the following
                   3309:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23      wiz      3310: <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  3311:       packages someplace else (enabled by default).</p></li>
1.23      wiz      3312: <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  3313:       the best compiler flags to optimise code for your current
1.23      wiz      3314:       CPU and compiler. </p></li>
1.1       dsieger  3315: </ul></div>
                   3316: <p>Utilities for keeping track of installed packages, being up to date,
                   3317: etc:</p>
1.41      asau     3318: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3319: <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  3320:       packages whose installed versions do not match the latest pkgsrc
                   3321:       entries.</p></li>
1.23      wiz      3322: <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  3323:       dependency graphs of packages, to aid in choosing a strategy for
                   3324:       updating.</p></li>
1.23      wiz      3325: <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  3326:       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      3327: <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   3328:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23      wiz      3329: <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  3330:       does various checks on the complete pkgsrc system.</p></li>
1.23      wiz      3331: <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  3332:       packages you have installed.</p></li>
                   3333: </ul></div>
                   3334: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     3335: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3336: <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  3337:       making and maintaining patches for a package (includes pkgdiff,
                   3338:       pkgvi, mkpatches, etc.).</p></li>
1.23      wiz      3339: <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  3340:       <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
                   3341:       converting to pkgsrc.</p></li>
1.23      wiz      3342: <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  3343:       pkgsrc to a Solaris package.</p></li>
                   3344: </ul></div>
                   3345: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3346: utilities)</p>
1.41      asau     3347: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3348: <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  3349:       packages in a chrooted area.</p></li>
1.23      wiz      3350: <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  3351:       kernel version for chrooted cross builds.</p></li>
                   3352: </ul></div>
                   3353: </div>
1.41      asau     3354: <div class="sect1">
1.1       dsieger  3355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3356: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3357: <p>If you want to use pkgsrc as non-root user, you can set some
                   3358: variables to make pkgsrc work under these conditions.  At the very least,
1.23      wiz      3359: 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  3360: will turn on unprivileged mode and set multiple related variables to allow
                   3361: installation of packages as non-root.</p>
                   3362: <p>In case the defaults are not enough, you may want to tune some other
                   3363: variables used.  For example, if the automatic user/group detection leads
                   3364: to incorrect values (or not the ones you would like to use), you can change
                   3365: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3366: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3367: <p>As regards bootstrapping, please note that the
1.10      hubertf  3368: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23      wiz      3369: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.1       dsieger  3370: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3371: installation targets.  These directories can be overridden by the
1.23      wiz      3372: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.1       dsieger  3373: that allow finer tuning of the tree layout.</p>
                   3374: </div>
1.41      asau     3375: <div class="sect1">
1.1       dsieger  3376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3377: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3378: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3379: enable this feature by adding the option
                   3380: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  3381: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3382: distfile is found, pkgsrc will try to resume it.</p>
                   3383: <p>You can also
1.29      dholland 3384: 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  3385: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3386: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3387: by using the value manual.  A value of custom disables the system defaults
                   3388: and dependency tracking for the fetch program.  In that case you have to
                   3389: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3390: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3391: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  3392: <p>For example, if you want to use
1.16      jnemeth  3393: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  3394: like:</p>
                   3395: <pre class="programlisting">
1.16      jnemeth  3396: FETCH_USING=   wget
1.1       dsieger  3397: </pre>
                   3398: </div>
1.41      asau     3399: <div class="sect1">
1.1       dsieger  3400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3401: <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   3402: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3403: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3404: you will have to add the following line into
1.10      hubertf  3405: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3406: <pre class="programlisting">
1.4       rillig   3407: X11_TYPE=modular
1.1       dsieger  3408: </pre>
1.41      asau     3409: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  3410: <h3 class="title">Note</h3>
1.4       rillig   3411: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3412: </p>
1.1       dsieger  3413: </div>
                   3414: </div>
1.41      asau     3415: <div class="sect1">
1.1       dsieger  3416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3417: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3418: <p>If you are sitting behind a firewall which does not allow direct
                   3419: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3420: relevant proxy hosts.  This is done using an environment variable in the
                   3421: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      3422: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  3423: port 80 as the proxy port number.  So the proxy environment variables
                   3424: are:</p>
                   3425: <pre class="programlisting">
                   3426: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3427: http_proxy=http://orpheus.amdahl.com:80/
                   3428: </pre>
                   3429: </div>
1.41      asau     3430: <div class="sect1">
1.1       dsieger  3431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  3432: <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  3433: <p>This depends on which utility is used to retrieve distfiles.  From
                   3434: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3435: the first available command from the following list:</p>
1.41      asau     3436: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3437: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3438: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  3439: </ul></div>
                   3440: <p>On a default NetBSD installation, this will be
                   3441: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3442: connections first, and falls back to active connections if the server
                   3443: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  3444: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3445: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3446: <p>Having that option present will prevent
                   3447: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3448: transfers.</p>
                   3449: </div>
1.41      asau     3450: <div class="sect1">
1.1       dsieger  3451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3452: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3453: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  3454: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      3455: 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  3456: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  3457: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  3458: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3459: resulting list to your machine at work/school and use it there.  If you
1.29      dholland 3460: 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  3461: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3462: URL:</p>
                   3463: <p>At home:</p>
                   3464: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3465: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3466: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3467: <p>At work:</p>
                   3468: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3469: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3470: home.</p>
                   3471: <p>If you have a machine running NetBSD, and you want to get
                   3472: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3473: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  3474: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  3475: directly by running:</p>
                   3476: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3477: <p>If you even decide to ignore
                   3478: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3479: by running:</p>
                   3480: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3481: </div>
1.41      asau     3482: <div class="sect1">
1.1       dsieger  3483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3484: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                   3485: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3486: <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>
                   3487: package, you get the error from make that it doesn't know how to make
                   3488: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      3489: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  3490: the NetBSD base distribution on your machine.  It is recommended to do
                   3491: that to format man pages.</p>
                   3492: <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
                   3493: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  3494: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3495: </div>
1.41      asau     3496: <div class="sect1">
1.1       dsieger  3497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3498: <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  3499: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3500: when you installed your NetBSD machine.  Please get and install it, by
                   3501: extracting it in <code class="filename">/</code>:</p>
                   3502: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3503: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3504: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  3505: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  3506: -r</strong></span>).</p>
                   3507: </div>
1.41      asau     3508: <div class="sect1">
1.1       dsieger  3509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3510: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3511: <p>When installing packages as non-root user and using the just-in-time
1.29      dholland 3512: <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  3513: password for each required package installed.  To avoid this, the sudo
                   3514: package can be used, which does password caching over a limited time.  To
                   3515: use it, install sudo (either as binary package or from
                   3516: <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  3517: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3518: <span class="emphasis"><em>after</em></span> the definition of the
                   3519: <code class="varname">LOCALBASE</code> variable:</p>
                   3520: <pre class="programlisting">
                   3521: .if exists(${LOCALBASE}/bin/sudo)
                   3522: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3523: .endif
                   3524: </pre>
                   3525: </div>
1.41      asau     3526: <div class="sect1">
1.1       dsieger  3527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3528: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3529: <p>As the system administrator, you can choose where configuration files
                   3530: are installed.  The default settings make all these files go into
                   3531: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3532: be suboptimal depending on your expectations (e.g., a read-only,
                   3533: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3534: configuration of the provided packages).</p>
                   3535: <p>In order to change the defaults, you can modify the
                   3536: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3537: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3538: directory; some common examples include <code class="filename">/etc</code> or
                   3539: <code class="filename">/etc/pkg</code>.</p>
                   3540: <p>Furthermore, you can change this value on a per-package basis by
                   3541: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3542: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3543: package you would like to modify, that is, the contents of
                   3544: <code class="varname">PKGBASE</code>.</p>
                   3545: <p>Note that after changing these settings, you must rebuild and
                   3546: reinstall any affected packages.</p>
                   3547: </div>
1.41      asau     3548: <div class="sect1">
1.1       dsieger  3549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3550: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3551: <p>Please be aware that there can often be bugs in third-party software,
                   3552: and some of these bugs can leave a machine vulnerable to exploitation by
                   3553: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3554: maintains a database of known-exploits to packages which have at one time
                   3555: been included in pkgsrc.  The database can be downloaded automatically, and
                   3556: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3557: do this, refer to the following two tools (installed as part of the
                   3558: <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      3559: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3560: <li class="listitem">
1.20      snj      3561: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3562:     download a list of the security vulnerabilities information.  This list
1.25      spz      3563:     is kept up to date by the pkgsrc security team, and is distributed
                   3564:     from the NetBSD ftp server:</p>
                   3565: <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  3566: </li>
1.23      wiz      3567: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3568:     current machine, checking each known vulnerability.  If a
1.1       dsieger  3569:     vulnerable package is installed, it will be shown by output to stdout,
                   3570:     including a description of the type of vulnerability, and a URL
                   3571:     containing more information.</p></li>
                   3572: </ol></div>
1.14      jmcneill 3573: <p>Use of these tools is strongly recommended!  After
1.23      wiz      3574: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.1       dsieger  3575: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14      jmcneill 3576: pkg_install</code></strong>.</p>
1.1       dsieger  3577: <p>If this package is installed, pkgsrc builds will use it to
1.10      hubertf  3578: 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  3579: check.</p>
                   3580: </div>
1.41      asau     3581: <div class="sect1">
1.1       dsieger  3582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3583: <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  3584: <p>When you add your own preferences to the
                   3585:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3586:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3587:        environment variables to the <code class="filename">./configure</code>
1.29      dholland 3588:        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  3589:        <code class="varname">CFLAGS</code> from the environment variable by
                   3590:        overriding them in the <code class="filename">Makefile</code>s of their
                   3591:        package.</p>
                   3592: <p>Currently there is no solution to this problem. If you
                   3593:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3594:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3595:        directory and then inspect any <code class="filename">Makefile</code> and
                   3596:        <code class="filename">Makefile.in</code> for whether they define
                   3597:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3598:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  3599:        programmers write so bad code that it only works for the
                   3600:        specific combination of <code class="varname">CFLAGS</code> they have
                   3601:        chosen.</p>
                   3602: </div>
1.41      asau     3603: <div class="sect1">
1.1       dsieger  3604: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3605: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3606: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     3607: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  3608:        case that occurs often is that people only update pkgsrc in
                   3609:        parts, because of performance reasons. Since pkgsrc is one large
                   3610:        system, not a collection of many small systems, there are
                   3611:        sometimes changes that only work when the whole pkgsrc tree is
                   3612:        updated.</p></li>
1.41      asau     3613: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      wiz      3614:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3615:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  3616:        files.</p></li>
1.41      asau     3617: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3618:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3619:        verify this.</p></li>
1.41      asau     3620: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  3621:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3622: </ol></div>
                   3623: </div>
1.41      asau     3624: <div class="sect1">
1.1       dsieger  3625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3626: <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  3627: <p>You have modified a file from pkgsrc, and someone else has
                   3628: modified that same file afterwards in the CVS repository. Both changes
                   3629: are in the same region of the file, so when you updated pkgsrc, the
                   3630: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3631: file. Because of these markers, the file is no longer a valid
                   3632: <code class="filename">Makefile</code>.</p>
                   3633: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3634: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3635: -dP</strong></span> in that directory to download the current version.</p>
                   3636: </div>
                   3637: </div>
                   3638: </div>
1.41      asau     3639: <div class="part">
1.1       dsieger  3640: <div class="titlepage"><div><div><h1 class="title">
                   3641: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41      asau     3642: <div class="partintro">
1.1       dsieger  3643: <div></div>
                   3644: <p>This part of the book deals with creating and
1.23      wiz      3645:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3646:        guide on creating a new package. The remaining chapters are more
                   3647:        like a reference manual for pkgsrc.</p>
                   3648: <div class="toc">
                   3649: <p><b>Table of Contents</b></p>
                   3650: <dl>
1.6       rillig   3651: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3652: <dd><dl>
1.6       rillig   3653: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3654: <dd><dl>
1.6       rillig   3655: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3656: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3657: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3658: </dl></dd>
1.6       rillig   3659: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3660: <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>
                   3661: </dl></dd>
                   3662: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3663: <dd><dl>
1.23      wiz      3664: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3665: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   3666: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3667: <dd><dl>
                   3668: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3669: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3670: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3671: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3672: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3673: </dl></dd>
                   3674: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3675: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3676: <dd><dl>
                   3677: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3678: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3679: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3680: </dl></dd>
1.23      wiz      3681: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3682: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   3683: </dl></dd>
1.23      wiz      3684: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3685: <dd><dl>
                   3686: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      3687: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   3688: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3689: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3690: <dd><dl>
                   3691: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3692: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3693: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3694: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3695: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3696: </dl></dd>
                   3697: </dl></dd>
                   3698: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3699: <dd><dl>
                   3700: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      3701: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3702: <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   3703: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3704: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      3705: <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   3706: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3707: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3708: </dl></dd>
                   3709: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3710: <dd><dl>
                   3711: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      3712: <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   3713: <dd><dl>
                   3714: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      3715: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3716:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3717:       and
                   3718:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3719:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3720: </dl></dd>
1.23      wiz      3721: <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   3722: <dd><dl>
1.23      wiz      3723: <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   3724: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3725: </dl></dd>
                   3726: </dl></dd>
                   3727: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3728: <dd><dl>
                   3729: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3730: <dd><dl>
                   3731: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3732: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3733: </dl></dd>
                   3734: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3735: <dd><dl>
1.23      wiz      3736: <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   3737: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3738: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3739: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3740: </dl></dd>
                   3741: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3742: <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>
                   3743: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3744: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3745: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3746: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3747: <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>
                   3748: </dl></dd>
                   3749: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3750: <dd><dl>
                   3751: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      3752: <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   3753: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3754: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3755: </dl></dd>
                   3756: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3757: <dd><dl>
                   3758: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3759: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3760: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3761: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      3762: <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   3763: <dd><dl>
                   3764: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3765: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3766: </dl></dd>
1.23      wiz      3767: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3768: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3769: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3770: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3771: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3772: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3773: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3774: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3775: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3776: <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   3777: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3779: </dl></dd>
                   3780: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3781: <dd><dl>
                   3782: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3783: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3784: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3785: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3786: </dl></dd>
                   3787: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3788: <dd><dl>
                   3789: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3790: <dd><dl>
                   3791: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      3792: <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   3793: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3794: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3795: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3796: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3797: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3798: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3799: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3800: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3801: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3802: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3803: </dl></dd>
1.23      wiz      3804: <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   3805: <dd><dl>
                   3806: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3807: <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>
                   3808: </dl></dd>
1.23      wiz      3809: <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   3810: <dd><dl>
                   3811: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3813: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3814: </dl></dd>
                   3815: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3816: <dd><dl>
                   3817: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3818: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3819: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz      3820: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   3821: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   3822: </dl></dd>
1.23      wiz      3823: <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   3824: <dd><dl>
                   3825: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3826: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      3827: <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   3828: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3829: </dl></dd>
1.23      wiz      3830: <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   3831: <dd><dl>
                   3832: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3833: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3834: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3835: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3836: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3837: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3838: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3839: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3840: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      3841: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   3842: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3843: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3844: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3845: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3846: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3847: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3848: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3850:     emulation</a></span></dt>
1.6       rillig   3851: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3853: </dl></dd>
1.6       rillig   3854: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3855: </dl></dd>
1.6       rillig   3856: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3857: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3858: <dd><dl>
1.6       rillig   3859: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3860: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3861: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz      3862: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   3863: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      3864: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3865: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig   3866: </dl></dd>
                   3867: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3868: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3869: <dd><dl>
                   3870: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3871: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3872: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3873: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3874: </dl></dd>
                   3875: </dl>
                   3876: </div>
                   3877: </div>
1.41      asau     3878: <div class="chapter">
1.1       dsieger  3879: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3880: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3881: <div class="toc">
                   3882: <p><b>Table of Contents</b></p>
                   3883: <dl>
1.6       rillig   3884: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3885: <dd><dl>
1.6       rillig   3886: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3887: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3888: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3889: </dl></dd>
1.6       rillig   3890: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3891: <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  3892: </dl>
                   3893: </div>
                   3894: <p>When you find a package that is not yet in pkgsrc, you
                   3895: most likely have a URL from where you can download the source
                   3896: code. Starting with this URL, creating a package involves only a
                   3897: few steps.</p>
1.23      wiz      3898: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     3899: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
                   3900: <li class="step"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3901: category in which you want to place your package. You can also create a
                   3902: directory of your own (maybe called <code class="filename">local</code>). In that
                   3903: category directory, create another directory for your package and change
                   3904: into it.</p></li>
1.41      asau     3905: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3906: you for a URL. Enter the URL of the distribution file (in most cases a
                   3907: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3908: of your package are created automatically. The distribution file is
                   3909: extracted automatically to fill in some details in the
                   3910: <code class="filename">Makefile</code> that would otherwise have to be done
                   3911: manually.</p></li>
1.41      asau     3912: <li class="step">
1.1       dsieger  3913: <p>Examine the extracted files to determine the dependencies of
                   3914: your package. Ideally, this is mentioned in some
                   3915: <code class="filename">README</code> file, but things may differ. For each of
                   3916: these dependencies, look where it exists in pkgsrc, and if there is a
                   3917: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3918: line to your package <code class="filename">Makefile</code> which includes that
                   3919: file just before the last line. If the
1.25      spz      3920: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3921: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3922: <p>If you just need binaries from a package, add a
1.1       dsieger  3923: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3924: version of the dependency and where it can be found in pkgsrc. This line
                   3925: should be placed in the third paragraph. If the dependency is only
                   3926: needed for building the package, but not when using it, use
                   3927: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3928: Your package may then look like this:</p>
                   3929: <pre class="programlisting">
                   3930: [...]
                   3931: 
                   3932: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3933: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3934: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3935: 
                   3936: [...]
                   3937: 
                   3938: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3939: .include "../../devel/glib2/buildlink3.mk"
                   3940: .include "../../mk/bsd.pkg.mk"
                   3941: </pre>
                   3942: </li>
1.41      asau     3943: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23      wiz      3944: 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  3945: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3946: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3947: -e</strong></span>, which outputs additional
                   3948: explanations.</p></li>
1.41      asau     3949: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3950: 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  3951: over there, you can hopefully continue here.</p></li>
1.41      asau     3952: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3953: directory from the extracted files. Besides these files, a lot of cache
                   3954: files and other system information has been saved in the working
                   3955: directory, which may become wrong after you edited the
                   3956: <code class="filename">Makefile</code>.</p></li>
1.41      asau     3957: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10      hubertf  3958: 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.41      asau     3959: <li class="step"><p>When the package builds fine, the next step is to install
1.10      hubertf  3960: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3961: everything works.</p></li>
1.41      asau     3962: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3963: contains a list of the files that are installed by the package, is
1.10      hubertf  3964: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3965: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3966: the file using your preferred text editor to see if the list of
                   3967: files looks plausible.</p></li>
1.41      asau     3968: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3969: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41      asau     3970: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3971: has been registered in the database of installed files, but with an
1.10      hubertf  3972: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3973: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3974: registered with the list of files from
                   3975: <code class="filename">PLIST</code>.</p></li>
1.41      asau     3976: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3977: package from the set of installed files.</p></li>
                   3978: </ol></div>
1.41      asau     3979: <div class="sect1">
1.1       dsieger  3980: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3981: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41      asau     3982: <div class="sect2">
1.1       dsieger  3983: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3984: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3985: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3986: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3987: </div>
1.41      asau     3988: <div class="sect2">
1.1       dsieger  3989: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3990: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  3991: <p>KDE applications should always include
                   3992: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3993: settings that are typical of KDE packages.</p>
                   3994: </div>
1.41      asau     3995: <div class="sect2">
1.17      imil     3996: <div class="titlepage"><div><div><h3 class="title">
                   3997: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3998: <p>Python modules and programs packages are easily created using a
                   3999: set of predefined variables.</p>
1.23      wiz      4000: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   4001: easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   4002: If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
                   4003: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
1.17      imil     4004: pkgsrc will make use of this framework.
1.23      wiz      4005: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   4006: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
1.17      imil     4007: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   4008: to the name of the script.</p>
                   4009: <p>
                   4010: If the default Python versions are not supported by the software, set the
                   4011: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   4012: the software is known to work with, from the most recent to the older
                   4013: one, e.g.
                   4014: </p>
                   4015: <pre class="programlisting">
1.39      wiz      4016: PYTHON_VERSIONS_ACCEPTED=       31 27 26
1.17      imil     4017: </pre>
                   4018: <p>
                   4019: If the packaged software is a Python module, include
1.23      wiz      4020: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
1.17      imil     4021: In this case, the package directory should be called
1.23      wiz      4022: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   4023: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     4024: </p>
                   4025: <pre class="programlisting">
                   4026: DISTNAME=   foopymodule-1.2.10
                   4027: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   4028: </pre>
                   4029: <p>If it is an application, also include
1.23      wiz      4030: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
                   4031: before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
1.17      imil     4032: <p>If the packaged software, either it is an application or a module, is
                   4033: egg-aware, you only need to include
1.23      wiz      4034: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
1.17      imil     4035: <p>In order to correctly set the path to the Python interpreter, use the
                   4036: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35      wiz      4037: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   4038: For example :
1.17      imil     4039: </p>
                   4040: <pre class="programlisting">
1.35      wiz      4041: REPLACE_PYTHON=   *.py
1.17      imil     4042: </pre>
                   4043: </div>
1.1       dsieger  4044: </div>
1.41      asau     4045: <div class="sect1">
1.1       dsieger  4046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4047: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41      asau     4048: <div class="sect2">
1.1       dsieger  4049: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4050: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41      asau     4051: <div class="sect3">
1.1       dsieger  4052: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4053: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  4054: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      4055: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  4056: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      4057: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  4058: <pre class="programlisting">
                   4059: <code class="prompt">$</code> mkdir www/nvu
                   4060: <code class="prompt">$</code> cd www/nvu
                   4061: </pre>
                   4062: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  4063: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  4064: <pre class="programlisting">
                   4065: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4066: </pre>
                   4067: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4068: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      4069: 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  4070: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4071: <code class="varname">COMMENT</code> fields. Then the package
                   4072: <code class="filename">Makefile</code> looked like that:</p>
                   4073: <pre class="programlisting">
                   4074: # $NetBSD$
                   4075: #
                   4076: 
                   4077: DISTNAME=       nvu-1.0-sources
                   4078: PKGNAME=        nvu-1.0
                   4079: CATEGORIES=     www
                   4080: MASTER_SITES=   http://cvs.nvu.com/download/
                   4081: EXTRACT_SUFX=   .tar.bz2
                   4082: 
                   4083: MAINTAINER=     rillig@NetBSD.org
                   4084: HOMEPAGE=       http://cvs.nvu.com/
                   4085: COMMENT=        Web Authoring System
                   4086: 
                   4087: # url2pkg-marker (please do not remove this line.)
                   4088: .include "../../mk/bsd.pkg.mk"
                   4089: </pre>
                   4090: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4091: source archive:</p>
                   4092: <pre class="programlisting">
                   4093: url2pkg&gt; Running "make makesum" ...
                   4094: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4095: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4096: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4097: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4098: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4099: url2pkg&gt; Running "make extract" ...
                   4100: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4101: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4102: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4103: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4104: ===&gt; Installing dependencies for nvu-1.0
                   4105: ===&gt; Overriding tools for nvu-1.0
                   4106: ===&gt; Extracting for nvu-1.0
                   4107: url2pkg&gt; Adjusting the Makefile.
                   4108: 
                   4109: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4110: 
                   4111: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4112: </pre>
                   4113: </div>
1.41      asau     4114: <div class="sect3">
1.1       dsieger  4115: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4116: <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  4117: <p>Now that the package has been extracted, let's see what's inside
                   4118: it. The package has a <code class="filename">README.txt</code>, but that only
                   4119: says something about mozilla, so it's probably useless for seeing what
                   4120: dependencies this package has. But since there is a GNU configure script
                   4121: in the package, let's hope that it will complain about everything it
                   4122: needs.</p>
                   4123: <pre class="programlisting">
                   4124: <code class="prompt">$</code> bmake
                   4125: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4126: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4127: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4128: ===&gt; Patching for nvu-1.0
                   4129: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4130: ===&gt; Configuring for nvu-1.0
                   4131: [...]
                   4132: configure: error: Perl 5.004 or higher is required.
                   4133: [...]
                   4134: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4135: [...]
                   4136: </pre>
                   4137: <p>That worked quite well. So I opened the package Makefile in my
                   4138: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      4139: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  4140: package have changed now, and since a perl wrapper is automatically
1.23      wiz      4141: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  4142: from scratch.</p>
                   4143: <pre class="programlisting">
                   4144: <code class="prompt">$</code> bmake clean
                   4145: ===&gt; Cleaning for nvu-1.0
                   4146: <code class="prompt">$</code> bmake
                   4147: [...]
                   4148: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4149: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4150: [...]
                   4151: </pre>
1.23      wiz      4152: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  4153: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4154: <pre class="programlisting">
                   4155: [...]
                   4156: checking for GTK - version &gt;= 1.2.0... no
                   4157: *** Could not run GTK test program, checking why...
                   4158: [...]
                   4159: </pre>
                   4160: <p>Now to the other dependencies. The first question is: Where is the
                   4161: GTK package hidden in pkgsrc?</p>
                   4162: <pre class="programlisting">
                   4163: <code class="prompt">$</code> echo ../../*/gtk*
                   4164: [many packages ...]
                   4165: <code class="prompt">$</code> echo ../../*/gtk
                   4166: ../../x11/gtk
                   4167: <code class="prompt">$</code> echo ../../*/gtk2
                   4168: ../../x11/gtk2
                   4169: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4170: ../../x11/gtk2/buildlink3.mk
                   4171: </pre>
                   4172: <p>The first try was definitely too broad. The second one had exactly
                   4173: one result, which is very good. But there is one pitfall with GNOME
                   4174: packages. Before GNOME 2 had been released, there were already many
                   4175: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4176: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      4177: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  4178: whether this was the case here, and indeed it was.</p>
                   4179: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4180: file, adding the dependency is very easy. I just inserted an
                   4181: <code class="literal">.include</code> line before the last line of the package
                   4182: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4183: <pre class="programlisting">
                   4184: [...]
                   4185: .include "../../x11/gtk2/buildlink3.mk"
                   4186: .include "../../mk/bsd.pkg.mk
                   4187: </pre>
1.10      hubertf  4188: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  4189: was:</p>
                   4190: <pre class="programlisting">
                   4191: [...]
                   4192: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4193: checking for GTK - version &gt;= 1.2.0... no
                   4194: *** Could not run GTK test program, checking why...
                   4195: *** The test program failed to compile or link. See the file config.log for the
                   4196: *** exact error that occured. This usually means GTK was incorrectly installed
                   4197: *** or that you have moved GTK since it was installed. In the latter case, you
                   4198: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4199: configure: error: Test for GTK failed.
                   4200: [...]
                   4201: </pre>
1.23      wiz      4202: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   4203: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  4204: told me that this package really wanted to have the GNOME 1 version of
                   4205: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  4206: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  4207: So I changed the <code class="literal">x11/gtk2</code> to
                   4208: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4209: and tried again.</p>
                   4210: <pre class="programlisting">
                   4211: [...]
                   4212: 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
                   4213: In file included from xpidl.c:42:
                   4214: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4215: In file included from xpidl.c:42:
                   4216: xpidl.h:132: error: parse error before "IDL_ns"
                   4217: [...]
                   4218: </pre>
                   4219: <p>The package still does not find all of its dependencies. Now the
                   4220: question is: Which package provides the
                   4221: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4222: <pre class="programlisting">
                   4223: <code class="prompt">$</code> echo ../../*/*idl*
                   4224: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4225: <code class="prompt">$</code> echo ../../*/*IDL*
                   4226: ../../net/libIDL
                   4227: </pre>
                   4228: <p>Let's take the one from the second try. So I included the
                   4229: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4230: again. But the error didn't change. After digging through some of the
                   4231: code, I concluded that the build process of the package was broken and
                   4232: couldn't have ever worked, but since the Mozilla source tree is quite
                   4233: large, I didn't want to fix it. So I added the following to the package
                   4234: <code class="filename">Makefile</code> and tried again:</p>
                   4235: <pre class="programlisting">
                   4236: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4237: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4238: </pre>
                   4239: <p>The latter line is needed because the package expects the library
                   4240: <code class="filename">libIDL.so</code>, but only
                   4241: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4242: wrapper to rewrite that on the fly.</p>
                   4243: <p>The next problem was related to a recent change of the FreeType
                   4244: 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>
                   4245: which patch files were relevant for this issue and copied them to the
                   4246: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4247: patches so that they applied cleanly and retried again. This time,
                   4248: everything worked.</p>
                   4249: </div>
1.41      asau     4250: <div class="sect3">
1.1       dsieger  4251: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4252: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4253: <pre class="programlisting">
                   4254: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4255: [...]
                   4256: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4257: <code class="prompt">$</code> bmake deinstall
                   4258: <code class="prompt">$</code> bmake install
                   4259: </pre>
                   4260: </div>
                   4261: </div>
                   4262: </div>
                   4263: </div>
1.41      asau     4264: <div class="chapter">
1.1       dsieger  4265: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4266: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4267: <div class="toc">
                   4268: <p><b>Table of Contents</b></p>
                   4269: <dl>
1.23      wiz      4270: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4271: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   4272: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4273: <dd><dl>
                   4274: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4275: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4276: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4277: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4278: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4279: </dl></dd>
                   4280: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4281: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4282: <dd><dl>
                   4283: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4284: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4285: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4286: </dl></dd>
1.23      wiz      4287: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4288: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  4289: </dl>
                   4290: </div>
                   4291: <p>Whenever you're preparing a package, there are a number of
                   4292: files involved which are described in the following
                   4293: sections.</p>
1.41      asau     4294: <div class="sect1">
1.1       dsieger  4295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4296: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4297: </h2></div></div></div>
                   4298: <p>Building, installation and creation of a binary package are all
                   4299:   controlled by the package's <code class="filename">Makefile</code>.
                   4300:   The <code class="filename">Makefile</code> describes various things about
                   4301:   a package, for example from where to get it, how to configure,
                   4302:   build, and install it.</p>
                   4303: <p>A package <code class="filename">Makefile</code> contains several
                   4304:   sections that describe the package.</p>
                   4305: <p>In the first section there are the following variables, which
                   4306:   should appear exactly in the order given here.  The order and
                   4307:   grouping of the variables is mostly historical and has no further
                   4308:   meaning.</p>
1.41      asau     4309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4310: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  4311:     distribution file to be downloaded from the package's
                   4312:     website.</p></li>
1.23      wiz      4313: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1       dsieger  4314:     package, as used by pkgsrc. You only need to provide it if
                   4315:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4316:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4317:     directory name together with the version number. It must match the
                   4318:     regular expression
                   4319:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4320:     starts with a letter or digit, and contains only letters, digits,
                   4321:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      4322: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1       dsieger  4323:     the package file to create if the <code class="varname">PKGNAME</code>
                   4324:     isn't unique on a SVR4 system. The default is
                   4325:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4326:     <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
                   4327:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4328:     does not produce an unique package name on a SVR4 system.
                   4329:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4330:     characters.</p></li>
1.23      wiz      4331: <li class="listitem">
1.1       dsieger  4332: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4333:     which the package fits in. You can choose any of the top-level
                   4334:     directories of pkgsrc for it.</p>
                   4335: <p>Currently the following values are available for
                   4336:     <code class="varname">CATEGORIES</code>. If more than
                   4337:     one is used, they need to be separated by spaces:</p>
                   4338: <pre class="programlisting">
                   4339: archivers     cross         geography     meta-pkgs     security
                   4340: audio         databases     graphics      misc          shells
                   4341: benchmarks    devel         ham           multimedia    sysutils
                   4342: biology       editors       inputmethod   net           textproc
                   4343: cad           emulators     lang          news          time
                   4344: chat          finance       mail          parallel      wm
                   4345: comms         fonts         math          pkgtools      www
                   4346: converters    games         mbone         print         x11
                   4347: </pre>
                   4348: </li>
1.23      wiz      4349: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  4350:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4351:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4352:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.23      wiz      4353:     <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  4354: </ul></div>
                   4355: <p>The second section contains information about separately
                   4356:   downloaded patches, if any.
                   4357:   </p>
1.41      asau     4358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4359: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1       dsieger  4360:     Name(s) of additional files that contain distribution patches.
                   4361:     There is no default. pkgsrc will look for them at
                   4362:     <code class="varname">PATCH_SITES</code>.
                   4363:     They will automatically be uncompressed before patching if
                   4364:     the names end with <code class="filename">.gz</code> or
                   4365:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      4366: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  4367:     Primary location(s) for distribution patch files (see
                   4368:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4369: </ul></div>
                   4370: <p>The third section contains the following variables.
                   4371:   </p>
1.41      asau     4372: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4373: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 4374:     address of the person who feels responsible for this package,
                   4375:     and who is most likely to look at problems or questions regarding
1.29      dholland 4376:     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 4377:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4378:     before making changes to the package, but are not required to
                   4379:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4380:     to yourself. If you really can't maintain the package for future
                   4381:     updates, set it to
1.10      hubertf  4382:     <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      4383: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 4384:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4385:     developers to update or change the package without contacting
                   4386:     you first. A package Makefile should contain one of
                   4387:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4388:     not both.  </p></li>
1.23      wiz      4389: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  4390:     find more information about the package.</p></li>
1.23      wiz      4391: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  4392:     description of the package (should not include the package
                   4393:     name).</p></li>
                   4394: </ul></div>
                   4395: <p>Other variables that affect the build:
                   4396:   </p>
1.41      asau     4397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  4398: <p><code class="varname">WRKSRC</code>: The directory where the
                   4399:       interesting distribution files of the package are found. The
                   4400:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4401:       works for most packages.</p>
                   4402: <p>If a package doesn't create a subdirectory for itself
                   4403:       (most GNU software does, for instance), but extracts itself in
                   4404:       the current directory, you should set
                   4405:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4406: <p>If a package doesn't create a subdirectory with the
                   4407:       name of <code class="varname">DISTNAME</code> but some different name,
                   4408:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4409:       <code class="filename">${WRKDIR}</code>, for example
                   4410:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4411:       <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>
                   4412: <p>The name of the working directory created by pkgsrc is
                   4413:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4414:       variable. By default, its value is
                   4415:       <code class="filename">work</code>. If you want to use the same
                   4416:       pkgsrc tree for building different kinds of binary packages,
                   4417:       you can change the variable according to your needs. Two
                   4418:       other variables handle common cases of setting
                   4419:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4420:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  4421:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4422:       the host's name is attached to the directory name. If
                   4423:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4424:       is attached, which might look like
                   4425:       <code class="filename">work.i386</code> or
                   4426:       <code class="filename">work.sparc</code>.</p>
                   4427: </li></ul></div>
                   4428: <p>Please pay attention to the following gotchas:</p>
1.41      asau     4429: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4430: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  4431:       installed in compressed form by the package.  For packages using
                   4432:       BSD-style makefiles which honor MANZ, there is
                   4433:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      4434: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4435:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  4436:       below).</p></li>
1.23      wiz      4437: <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  4438: </ul></div>
                   4439: </div>
1.41      asau     4440: <div class="sect1">
1.1       dsieger  4441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4442: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4443: </h2></div></div></div>
                   4444: <p>The <code class="filename">distinfo</code> file contains the message
                   4445:   digest, or checksum, of each distfile needed for the package. This
                   4446:   ensures that the distfiles retrieved from the Internet have not been
                   4447:   corrupted during transfer or altered by a malign force to introduce
                   4448:   a security hole. Due to recent rumor about weaknesses of digest
                   4449:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4450:   message digests, as well as the file size.</p>
                   4451: <p>The <code class="filename">distinfo</code> file also contains the
                   4452:   checksums for all the patches found in the
1.10      hubertf  4453:   <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  4454: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10      hubertf  4455:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1       dsieger  4456:   command.</p>
                   4457: <p>Some packages have different sets of distfiles depending on
1.23      wiz      4458:   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  4459:   <code class="filename">distinfo</code> file and care should be taken when
                   4460:   upgrading such a package to ensure distfile information is not
                   4461:   lost.</p>
                   4462: </div>
1.41      asau     4463: <div class="sect1">
1.1       dsieger  4464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4465: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4466: <p>Many packages still don't work out-of-the box on the various
                   4467:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4468:   patch files are needed to make the package work. These patch files are
                   4469:   found in the <code class="filename">patches/</code> directory.</p>
                   4470: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4471:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.10      hubertf  4472:   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      4473:   order</a>.</p>
1.41      asau     4474: <div class="sect2">
1.1       dsieger  4475: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4476: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4477: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  4478:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  4479:   problems. (To force patches to apply with fuzz you can set
                   4480:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4481:   should contain only changes for a single file, and no file should be
                   4482:   patched by more than one patch file. This helps to keep future
                   4483:   modifications simple.</p>
                   4484: <p>Each patch file is structured as follows: In the first line,
                   4485:   there is the RCS Id of the patch itself. The second line should be
                   4486:   empty for aesthetic reasons. After that, there should be a comment for
                   4487:   each change that the patch does. There are a number of standard
                   4488:   cases:</p>
1.41      asau     4489: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4490: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  4491:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      4492: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  4493:   platform and other environment (for example, the compiler) that the
                   4494:   patch is needed for.</p></li>
                   4495: </ul></div>
1.24      wiz      4496: <p>In all, the patch should be commented so that any
1.1       dsieger  4497:   developer who knows the code of the application can make some use of
                   4498:   the patch. Special care should be taken for the upstream developers,
                   4499:   since we generally want that they accept our patches, so we have less
                   4500:   work in the future.</p>
                   4501: </div>
1.41      asau     4502: <div class="sect2">
1.1       dsieger  4503: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4504: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4505: <p>One important thing to mention is to pay attention that no RCS
                   4506:   IDs get stored in the patch files, as these will cause problems when
                   4507:   later checked into the NetBSD CVS tree. Use the
1.10      hubertf  4508:   <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  4509:   problems.</p>
                   4510: <p>For even more automation, we recommend using
1.10      hubertf  4511:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  4512:   whole set of patches. You just have to backup files before you
                   4513:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  4514:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4515:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  4516:   you upgrade a package this way, you can easily compare the new
                   4517:   set of patches with the previously existing one with
1.24      wiz      4518:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4519:   are replaced by new files, so carefully check if you want to take all
                   4520:   the changes.</p>
1.1       dsieger  4521: <p>When you have finished a package, remember to generate
1.10      hubertf  4522:   the checksums for the patch files by using the <span class="command"><strong>make
1.23      wiz      4523:   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  4524: <p>When adding a patch that corrects a problem in the
                   4525:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4526:   man pages should go), send the patch as a bug report to the
                   4527:   maintainer.  This benefits non-pkgsrc users of the package,
                   4528:   and usually makes it possible to remove the patch in future
                   4529:   version.</p>
1.2       rillig   4530: <p>The file names of the patch files are usually of the form
1.24      wiz      4531:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4532:   Many packages still use the previous convention
                   4533:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4534:   but new patches should be of the form containing the filename.
                   4535:   <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
                   4536:   automatically.</p>
1.1       dsieger  4537: </div>
1.41      asau     4538: <div class="sect2">
1.1       dsieger  4539: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4540: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4541: <p>If you want to share patches between multiple packages
                   4542:   in pkgsrc, e.g. because they use the same distfiles, set
                   4543:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4544:   can be found, e.g.:</p>
                   4545: <pre class="programlisting">
                   4546: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4547: </pre>
                   4548: <p>Patch files that are distributed by the author or other
                   4549:     maintainers can be listed in
                   4550:     <code class="varname">PATCHFILES</code>.</p>
                   4551: <p>If it is desired to store any patches that should not be
                   4552:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4553:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4554:     directory tree there is expected to have the same
1.23      wiz      4555:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  4556:     patches are expected to be stored inside these dirs (also
                   4557:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4558:     example, if you want to keep a private patch for
                   4559:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4560:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4561:     files in the named directory are expected to be patch files,
                   4562:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4563:     applied</em></span>.</p>
                   4564: </div>
1.41      asau     4565: <div class="sect2">
1.1       dsieger  4566: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4567: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4568: <p>When fixing a portability issue in the code do not use
                   4569:       preprocessor magic to check for the current operating system nor
                   4570:       platform.  Doing so hurts portability to other platforms because
                   4571:       the OS-specific details are not abstracted appropriately.</p>
                   4572: <p>The general rule to follow is: instead of checking for the
                   4573:       operating system the application is being built on, check for the
                   4574:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4575:       instead of assuming that kqueue is available under NetBSD and
                   4576:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 4577:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4578:       yes, this generally involves patching the
1.10      hubertf  4579:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  4580:       that prevents some OSes from adopting interfaces from other OSes
                   4581:       (e.g. Linux implementing kqueue), something that the above checks
                   4582:       cannot take into account.</p>
                   4583: <p>Of course, checking for features generally involves more
                   4584:       work on the developer's side, but the resulting changes are
                   4585:       cleaner and there are chances they will work on many other
                   4586:       platforms.  Not to mention that there are higher chances of being
                   4587:       later integrated into the mainstream sources.  Remember:
                   4588:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4589: <p>Some typical examples:</p>
                   4590: <div class="table">
1.6       rillig   4591: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4592: <div class="table-contents"><table summary="Patching examples" border="1">
                   4593: <colgroup>
                   4594: <col>
                   4595: <col>
                   4596: <col>
                   4597: </colgroup>
                   4598: <thead><tr>
                   4599: <th>Where</th>
                   4600: <th>Incorrect</th>
                   4601: <th>Correct</th>
                   4602: </tr></thead>
                   4603: <tbody>
                   4604: <tr>
                   4605: <td>configure script</td>
                   4606: <td>
                   4607: <pre class="programlisting">
                   4608: case ${target_os} in
                   4609: netbsd*) have_kvm=yes ;;
                   4610: *)       have_kvm=no  ;;
                   4611: esac
                   4612: </pre>
                   4613:              </td>
                   4614: <td>
                   4615: <pre class="programlisting">
                   4616: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4617: </pre>
                   4618:              </td>
                   4619: </tr>
                   4620: <tr>
                   4621: <td>C source file</td>
                   4622: <td>
                   4623: <pre class="programlisting">
                   4624: #if defined(__NetBSD__)
                   4625: #  include &lt;sys/event.h&gt;
                   4626: #endif
                   4627: </pre>
                   4628:              </td>
                   4629: <td>
                   4630: <pre class="programlisting">
                   4631: #if defined(HAVE_SYS_EVENT_H)
                   4632: #  include &lt;sys/event.h&gt;
                   4633: #endif
                   4634: </pre>
                   4635:              </td>
                   4636: </tr>
                   4637: <tr>
                   4638: <td>C source file</td>
                   4639: <td>
                   4640: <pre class="programlisting">
                   4641: int
                   4642: monitor_file(...)
                   4643: {
                   4644: #if defined(__NetBSD__)
                   4645:         int fd = kqueue();
                   4646:         ...
                   4647: #else
                   4648:         ...
                   4649: #endif
                   4650: }
                   4651: </pre>
                   4652:              </td>
                   4653: <td>
                   4654: <pre class="programlisting">
                   4655: int
                   4656: monitor_file(...)
                   4657: {
                   4658: #if defined(HAVE_KQUEUE)
                   4659:         int fd = kqueue();
                   4660:         ...
                   4661: #else
                   4662:        ...
                   4663: #endif
                   4664: }
                   4665: </pre>
                   4666:              </td>
                   4667: </tr>
                   4668: </tbody>
                   4669: </table></div>
                   4670: </div>
                   4671: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  4672:       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
                   4673:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  4674:       2</a>).  It summarizes multiple details on how to make
                   4675:       software easier to package; all the suggestions in it were
                   4676:       collected from our experience in pkgsrc work, so they are possibly
                   4677:       helpful when creating patches too.</p>
                   4678: </div>
1.41      asau     4679: <div class="sect2">
1.1       dsieger  4680: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4681: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4682: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4683:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4684:       improvements you do to a package to the mainstream developers.
                   4685:       This is the only way to get their attention on portability issues
                   4686:       and to ensure that future versions can be built out-of-the box on
                   4687:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4688:       the fixes straight from the packaged code.</p>
                   4689: <p>This generally involves cleaning up the patches
                   4690:       (because sometimes the patches that are
1.40      wiz      4691:       added to pkgsrc are quick hacks), filing bug reports in the
1.1       dsieger  4692:       appropriate trackers for the projects and working with the
                   4693:       mainstream authors to accept your changes.  It is
                   4694:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4695:       the packages in pkgsrc are kept simple and thus further changes
                   4696:       can be done without much hassle.</p>
1.24      wiz      4697: <p>When you have done this, please add a URL to the upstream
                   4698:       bug report to the patch comment.</p>
1.1       dsieger  4699: <p>Support the idea of free software!</p>
                   4700: </div>
                   4701: </div>
1.41      asau     4702: <div class="sect1">
1.1       dsieger  4703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4704: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41      asau     4705: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4706: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4707: <dd><p>A multi-line description of the piece of software.  This should include
                   4708:          any credits where they are due.  Please bear in mind that others do not
                   4709:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4710:          will read everything that you write here.</p></dd>
                   4711: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4712: <dd><p>This file governs the files that are installed on your
                   4713:          system: all the binaries, manual pages, etc. There are other
                   4714:          directives which may be entered in this file, to control the
                   4715:          creation and deletion of directories, and the location of
1.10      hubertf  4716:          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  4717:          information.</p></dd>
                   4718: </dl></div>
                   4719: </div>
1.41      asau     4720: <div class="sect1">
1.1       dsieger  4721: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4722: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41      asau     4723: <div class="sect2">
1.1       dsieger  4724: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4725: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41      asau     4726: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4727: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      4728: <dd>
1.29      dholland 4729: <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  4730:            First time after package extraction and before files are
                   4731:            moved in place, the second time after the files to install
                   4732:            are moved in place. This can be used to do any custom
                   4733:            procedures not possible with @exec commands in
1.29      dholland 4734:            <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
                   4735:            <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      4736:            Please note that you can modify variables in it easily by using
                   4737:            <code class="varname">FILES_SUBST</code> in the package's
                   4738:            <code class="filename">Makefile</code>:</p>
                   4739: <pre class="programlisting">
                   4740: FILES_SUBST+=  SOMEVAR="somevalue"
                   4741: </pre>
                   4742: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4743:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4744:            performed for <code class="varname">PREFIX</code>,
                   4745:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4746:            <code class="varname">VARBASE</code>, and a few others, type
                   4747:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4748:            complete list.</p>
                   4749: </dd>
1.1       dsieger  4750: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4751: <dd><p>This script is executed before and after any files are removed.  It is
                   4752:            this script's responsibility to clean up any additional messy details
                   4753:            around the package's installation, since all pkg_delete knows is how to
                   4754:            delete the files created in the original distribution.
1.29      dholland 4755:            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>
                   4756:            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      4757:            The same methods to replace variables can be used as for
                   4758:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4759: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4760: <dd>
                   4761: <p>This file is displayed after installation of the package.
                   4762:            Useful for things like legal notices on almost-free
                   4763:            software and hints for updating config files after
                   4764:            installing modules for apache, PHP etc.
                   4765:            Please note that you can modify variables in it easily by using
                   4766:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4767:            <code class="filename">Makefile</code>:</p>
                   4768: <pre class="programlisting">
                   4769: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4770: </pre>
1.23      wiz      4771: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4772:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4773:            performed for <code class="varname">PKGNAME</code>,
                   4774:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4775:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4776:            <code class="varname">X11BASE</code>,
                   4777:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4778:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4779:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4780: <p>You can display a different or additional files by
                   4781:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4782:            default is <code class="filename">MESSAGE</code>, if the file
                   4783:            exists.</p>
                   4784: </dd>
                   4785: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4786: <dd><p>FIXME: There is no documentation on the
                   4787:        alternatives framework.</p></dd>
                   4788: </dl></div>
                   4789: </div>
1.41      asau     4790: <div class="sect2">
1.1       dsieger  4791: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4792: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41      asau     4793: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4794: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4795: <dd><p>This file contains arbitrary things that could
                   4796:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4797:        to be used by more than one package. This file should only be
                   4798:        used when the packages that will use the file are known in
                   4799:        advance. For other purposes it is often better to write a
                   4800:        <code class="filename">*.mk</code> file and give it a good name that
                   4801:        describes what it does.</p></dd>
                   4802: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4803: <dd><p>This file contains the dependency information
1.10      hubertf  4804:        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  4805: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4806: <dd><p>This file contains workarounds for compiler bugs
                   4807:        and similar things. It is included automatically by the pkgsrc
                   4808:        infrastructure, so you don't need an extra
                   4809:        <code class="literal">.include</code> line for
                   4810:        it.</p></dd>
                   4811: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4812: <dd><p>This file contains the code for the
1.10      hubertf  4813:        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  4814:        selected by the user. If a package has only one or two options,
                   4815:        it is equally acceptable to put the code directly into the
                   4816:        <code class="filename">Makefile</code>.</p></dd>
                   4817: </dl></div>
                   4818: </div>
1.41      asau     4819: <div class="sect2">
1.1       dsieger  4820: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4821: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41      asau     4822: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4823: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4824: <dd><p>These files do not take place in the creation of
                   4825:        a package and thus are purely informative to the package
                   4826:        developer.</p></dd>
                   4827: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4828: <dd><p>This file contains things that need to be done
                   4829:        to make the package even
                   4830:        better.</p></dd>
                   4831: </dl></div>
                   4832: </div>
                   4833: </div>
1.41      asau     4834: <div class="sect1">
1.1       dsieger  4835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4836: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4837: </h2></div></div></div>
1.10      hubertf  4838: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4839:     unpacked into the directory denoted by
                   4840:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4841:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4842:     directory is also used to keep various timestamp files.
                   4843:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4844:     The default is <code class="filename">${.CURDIR}/work</code>
                   4845:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4846:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4847: </div>
1.41      asau     4848: <div class="sect1">
1.1       dsieger  4849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4850: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4851: </h2></div></div></div>
                   4852: <p>If you have any files that you wish to be placed in the package prior
                   4853:     to configuration or building, you could place these files here and use
1.10      hubertf  4854:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4855:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4856:     this. Alternatively, you could simply diff the file against
                   4857:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4858:     the creation of this file.</p>
                   4859: <p>If you want to share files in this way with other
                   4860:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4861:     to the other package's <code class="filename">files</code> directory,
                   4862:     e.g.:</p>
                   4863: <pre class="programlisting">
                   4864: FILESDIR=${.CURDIR}/../xemacs/files
                   4865: </pre>
                   4866: </div>
                   4867: </div>
1.41      asau     4868: <div class="chapter">
1.1       dsieger  4869: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4870: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4871: <div class="toc">
                   4872: <p><b>Table of Contents</b></p>
                   4873: <dl>
1.6       rillig   4874: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      4875: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   4876: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4877: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4878: <dd><dl>
                   4879: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4880: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4881: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4882: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4883: <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  4884: </dl></dd>
                   4885: </dl>
                   4886: </div>
                   4887: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4888:   each of which forms a well-defined part of the pkgsrc system. Using
1.29      dholland 4889:   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  4890:   like pkgsrc requires some discipline to keep the code correct and
                   4891:   understandable.</p>
                   4892: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4893:   programming are variables (which are actually macros) and shell
                   4894:   commands. Among these shell commands may even be more complex ones
1.29      dholland 4895:   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  4896:   as intended it is necessary to quote all variables correctly when they
                   4897:   are used.</p>
                   4898: <p>This chapter describes some patterns, that appear quite often in
                   4899:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4900:   with them.</p>
1.41      asau     4901: <div class="sect1">
1.1       dsieger  4902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4903: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41      asau     4904: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  4905: <p>When you are creating a file as a
                   4906:     target of a rule, always write the data to a temporary file first
                   4907:     and finally rename that file. Otherwise there might occur an error
                   4908:     in the middle of generating the file, and when the user runs
1.29      dholland 4909:     <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  4910:     regenerated properly. Example:</p>
                   4911: <pre class="programlisting">
                   4912: wrong:
                   4913:         @echo "line 1" &gt; ${.TARGET}
                   4914:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4915:         @false
                   4916: 
                   4917: correct:
                   4918:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4919:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4920:         @false
                   4921:         @mv ${.TARGET}.tmp ${.TARGET}
                   4922: </pre>
1.10      hubertf  4923: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4924:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4925:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4926:     correct</strong></span> gives an error message twice, as expected.</p>
1.29      dholland 4927: <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  4928:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4929:     happens when it is interrupted, for example by pressing
                   4930:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29      dholland 4931:     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  4932: </li></ul></div>
                   4933: </div>
1.41      asau     4934: <div class="sect1">
1.1       dsieger  4935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4936: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4937: <p><code class="filename">Makefile</code> variables contain strings that
                   4938:     can be processed using the five operators ``='', ``+='', ``?='',
1.29      dholland 4939:     ``:='', 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  4940:     page.</p>
                   4941: <p>When a variable's value is parsed from a
                   4942:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4943:     backslash character ``\'' are handled specially. If a backslash is
                   4944:     followed by a newline, any whitespace immediately in front of the
                   4945:     backslash, the backslash, the newline, and any whitespace
                   4946:     immediately behind the newline are replaced with a single space. A
                   4947:     backslash character and an immediately following hash character are
                   4948:     replaced with a single hash character. Otherwise, the backslash is
                   4949:     passed as is. In a variable assignment, any hash character that is
                   4950:     not preceded by a backslash starts a comment that continues upto the
                   4951:     end of the logical line.</p>
                   4952: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4953:     the only way to create a variable consisting of a single backslash
                   4954:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4955: <p>So far for defining variables. The other thing you can do with
                   4956:     variables is evaluating them. A variable is evaluated when it is
                   4957:     part of the right side of the ``:='' or the ``!='' operator, or
                   4958:     directly before executing a shell command which the variable is part
1.29      dholland 4959:     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  4960:     is, variables are not evaluated until there's no other way. The
                   4961:     ``modifiers'' mentioned in the man page also evaluate the
                   4962:     variable.</p>
                   4963: <p>Some of the modifiers split the string into words and then
                   4964:     operate on the words, others operate on the string as a whole. When
                   4965:     a string is split into words, it is split as you would expect
1.29      dholland 4966:     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 4967: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.1       dsieger  4968:     loop does not follow the shell quoting rules but splits at sequences
                   4969:     of whitespace.</p>
                   4970: <p>There are several types of variables that should be handled
                   4971:     differently. Strings and two types of lists.</p>
1.41      asau     4972: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4973: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1       dsieger  4974:       characters. Nevertheless, you should restrict yourself to only
                   4975:       using printable characters. Examples are
                   4976:       <code class="varname">PREFIX</code> and
                   4977:       <code class="varname">COMMENT</code>.</p></li>
1.23      wiz      4978: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1       dsieger  4979:       are never exported to any shell command. Their elements are
                   4980:       separated by whitespace. Therefore, the elements themselves cannot
                   4981:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4982:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4983:       Examples are <code class="varname">DEPENDS</code> and
                   4984:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23      wiz      4985: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1       dsieger  4986:       may be exported to a shell command. Their elements can contain any
                   4987:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4988:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4989:       <code class="varname">DISTFILES</code> and
                   4990:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4991: </ul></div>
1.41      asau     4992: <div class="sect2">
1.1       dsieger  4993: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4994: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41      asau     4995: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4996: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4997:        are reserved for use by the pkgsrc infrastructure. They shall
                   4998:        not be used by package
                   4999:        <code class="filename">Makefile</code>s.</p></li>
1.23      wiz      5000: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  5001:        lowercase variable names for the iteration
                   5002:        variables.</p></li>
1.23      wiz      5003: <li class="listitem"><p>All list variables should have a ``plural''
1.1       dsieger  5004:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   5005:        <code class="varname">DISTFILES</code>.</p></li>
                   5006: </ul></div>
                   5007: </div>
                   5008: </div>
1.41      asau     5009: <div class="sect1">
1.1       dsieger  5010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5011: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  5012: <p>This section presents you with some code snippets you should
                   5013:     use in your own code. If you don't find anything appropriate here,
                   5014:     you should test your code and add it here.</p>
1.41      asau     5015: <div class="sect2">
1.1       dsieger  5016: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5017: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  5018: <pre class="programlisting">
                   5019: STRING=                 foo * bar `date`
                   5020: INT_LIST=               # empty
                   5021: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5022: EXT_LIST=               # empty
                   5023: ANOTHER_EXT_LIST=       a=b c=d
                   5024: 
                   5025: INT_LIST+=              ${STRING}               # 1
                   5026: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5027: EXT_LIST+=              ${STRING:Q}             # 3
                   5028: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   5029: </pre>
                   5030: <p>When you add a string to an external list (example 3), it
                   5031:       must be quoted. In all other cases, you must not add a quoting
                   5032:       level. You must not merge internal and external lists, unless you
                   5033:       are sure that all entries are correctly interpreted in both
                   5034:       lists.</p>
                   5035: </div>
1.41      asau     5036: <div class="sect2">
1.1       dsieger  5037: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5038: <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  5039: <pre class="programlisting">
                   5040: EXT_LIST=       # empty
                   5041: .for i in ${INT_LIST}
                   5042: EXT_LIST+=      ${i:Q}""
                   5043: .endfor
                   5044: </pre>
                   5045: <p>This code converts the internal list
                   5046:       <code class="varname">INT_LIST</code> into the external list
                   5047:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5048:       are unquoted they must be quoted here. The reason for appending
                   5049:       <code class="varname">""</code> is explained below.</p>
                   5050: </div>
1.41      asau     5051: <div class="sect2">
1.1       dsieger  5052: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5053: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  5054: <p>Sometimes you may want to print an arbitrary string. There
                   5055:        are many ways to get it wrong and only few that can handle every
                   5056:        nastiness.</p>
                   5057: <pre class="programlisting">
                   5058: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5059: EXT_LIST=       string=${STRING:Q} x=second\ item
                   5060: 
                   5061: all:
                   5062:         echo ${STRING}                  # 1
                   5063:         echo "${STRING}"                # 2
                   5064:         echo "${STRING:Q}"              # 3
                   5065:         echo ${STRING:Q}                # 4
                   5066:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5067:         printf "%s\\n" ${STRING:Q}""    # 6
                   5068:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   5069: </pre>
                   5070: <p>Example 1 leads to a syntax error in the shell, as the
                   5071:       characters are just copied.</p>
                   5072: <p>Example 2 leads to a syntax error too, and if you leave out
                   5073:       the last " character from <code class="varname">${STRING}</code>,
1.29      dholland 5074:       <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  5075:       variable would be evaluated, too.</p>
                   5076: <p>Example 3 outputs each space character preceded by a
                   5077:       backslash (or not), depending on the implementation of the
1.29      dholland 5078:       <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  5079: <p>Example 4 handles correctly every string that does not start
                   5080:       with a dash. In that case, the result depends on the
1.29      dholland 5081:       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  5082:       guarantee that your input does not start with a dash, this form is
                   5083:       appropriate.</p>
                   5084: <p>Example 5 handles even the case of a leading dash
                   5085:       correctly.</p>
                   5086: <p>Example 6 also works with every string and is the
                   5087:       light-weight solution, since it does not involve a pipe, which has
                   5088:       its own problems.</p>
                   5089: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5090:       because the quoting has already been done when adding elements to
                   5091:       the list.</p>
                   5092: <p>As internal lists shall not be passed to the shell, there is
                   5093:       no example for it.</p>
                   5094: </div>
1.41      asau     5095: <div class="sect2">
1.1       dsieger  5096: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5097: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  5098: <p>There are many possible sources of wrongly quoted variables.
                   5099:       This section lists some of the commonly known ones.</p>
1.41      asau     5100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5101: <li class="listitem">
1.1       dsieger  5102: <p>Whenever you use the value of a list, think
                   5103:        about what happens to leading or trailing whitespace. If the
                   5104:        list is a well-formed shell expression, you can apply the
                   5105:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5106:        whitespace from each word. The <code class="varname">:M</code> operator
                   5107:        first splits its argument according to the rules of the shell,
                   5108:        and then creates a new list consisting of all words that match
                   5109:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5110:        One class of situations where this is needed is when adding a
                   5111:        variable like <code class="varname">CPPFLAGS</code> to
                   5112:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5113:        invokes other configure scripts, it strips the leading and
                   5114:        trailing whitespace from the variable and then passes it to the
                   5115:        other configure scripts. But these configure scripts expect the
                   5116:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5117:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5118:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5119:        here is how we do it:</p>
                   5120: <pre class="programlisting">
                   5121: CPPFLAGS=               # empty
                   5122: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5123: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5124: 
                   5125: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5126: 
                   5127: all:
                   5128:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5129:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   5130: </pre>
                   5131: </li>
1.23      wiz      5132: <li class="listitem"><p>The example above contains one bug: The
1.1       dsieger  5133:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5134:        expression, but there is the C compiler after it, which also
                   5135:        expects a properly quoted string (this time in C syntax). The
                   5136:        version above is therefore only correct if
                   5137:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5138:        or double quotes. If you want to allow these, you have to add
                   5139:        another layer of quoting to each variable that is used as a C
                   5140:        string literal. You cannot use the <code class="varname">:Q</code>
                   5141:        operator for it, as this operator only works for the
                   5142:        shell.</p></li>
1.23      wiz      5143: <li class="listitem">
1.1       dsieger  5144: <p>Whenever a variable can be empty, the
                   5145:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5146:        are two completely different cases which can be solved with the
                   5147:        same trick.</p>
                   5148: <pre class="programlisting">
                   5149: EMPTY=                  # empty
                   5150: empty_test:
                   5151:         for i in a ${EMPTY:Q} c; do \
                   5152:             echo "$$i"; \
                   5153:         done
                   5154: 
                   5155: for_test:
                   5156: .for i in a:\ a:\test.txt
                   5157:         echo ${i:Q}
                   5158:         echo "foo"
                   5159: .endfor
                   5160: </pre>
                   5161: <p>The first example will only print two of the three lines
                   5162:        we might have expected. This is because
                   5163:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5164:        the shell cannot see. The workaround is to write
                   5165:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5166:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5167:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5168: <p>The second example will only print three lines instead of
                   5169:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5170:        This is because the backslash of the value
                   5171:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29      dholland 5172:        <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
                   5173:        <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  5174:        <code class="varname">${i:Q}""</code>.</p>
                   5175: </li>
                   5176: </ul></div>
                   5177: </div>
1.41      asau     5178: <div class="sect2">
1.1       dsieger  5179: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5180: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5181: <p>The pkgsrc bmake program does not handle the following
                   5182:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5183:       contains a ``-'' character, one of the closing braces is included
                   5184:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5185: <pre class="programlisting">
                   5186: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5187: </pre>
                   5188: <p>For a more complex code snippet and a workaround, see the
                   5189:       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
                   5190:       <code class="varname">bug1</code>.</p>
                   5191: </div>
                   5192: </div>
                   5193: </div>
1.41      asau     5194: <div class="chapter">
1.1       dsieger  5195: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5196: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5197: <div class="toc">
                   5198: <p><b>Table of Contents</b></p>
                   5199: <dl>
1.6       rillig   5200: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      5201: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5202: <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   5203: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5204: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      5205: <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   5206: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5207: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5208: </dl>
                   5209: </div>
                   5210: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      5211:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  5212:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5213:   directory it's been installed in) plus some additional statements
1.29      dholland 5214:   - 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  5215:   This chapter addresses some issues that need attention when
                   5216:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5217:   below!).</p>
1.41      asau     5218: <div class="sect1">
1.1       dsieger  5219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5220: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5221: <p>Be sure to add a RCS ID line as the first thing in any
                   5222:     <code class="filename">PLIST</code> file you write:</p>
                   5223: <pre class="programlisting">
                   5224: @comment $NetBSD$
                   5225:     </pre>
                   5226: </div>
1.41      asau     5227: <div class="sect1">
1.1       dsieger  5228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5229: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  5230: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  5231:     to output a PLIST that matches any new files since the package
1.10      hubertf  5232:     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  5233:     more information on this target.</p>
                   5234: </div>
1.41      asau     5235: <div class="sect1">
1.1       dsieger  5236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  5237: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  5238: </h2></div></div></div>
                   5239: <p>If you have used any of the *-dirs packages, as explained in
1.10      hubertf  5240:     <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
                   5241:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1       dsieger  5242:     <code class="varname">@comment</code>s instead of real
                   5243:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5244:     specific directories and files, so that the results of that
                   5245:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5246:     lot</em></span> during the update of packages.</p>
                   5247: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5248:     of AWK patterns and actions that are used to filter the output of
                   5249:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5250:     scripting you like to it, but be careful with quoting.</p>
                   5251: <p>For example, to get all files inside the
                   5252:     <code class="filename">libdata/foo</code> directory removed from the
                   5253:     resulting PLIST:</p>
                   5254: <pre class="programlisting">
                   5255: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5256:     </pre>
                   5257: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5258:     to a specific (shared) directory converted to
                   5259:     <code class="varname">@comment</code>s:</p>
                   5260: <pre class="programlisting">
                   5261: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5262:     </pre>
                   5263: </div>
1.41      asau     5264: <div class="sect1">
1.1       dsieger  5265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5266: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5267: <p>A number of variables are substituted automatically in
                   5268:     PLISTs when a package is installed on a system. This includes the
                   5269:     following variables:</p>
1.41      asau     5270: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  5271: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5272: <dd>
                   5273: <p>Some packages like emacs and perl embed information
                   5274:          about which architecture they were built on into the
                   5275:          pathnames where they install their files. To handle this
                   5276:          case, PLIST will be preprocessed before actually used, and
                   5277:          the symbol
1.23      wiz      5278:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  5279:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  5280:          same is done if the string
                   5281:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5282:          PLIST somewhere - use this on packages that have GNU
                   5283:          autoconf-created configure scripts.</p>
1.41      asau     5284: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  5285: <h3 class="title">Legacy note</h3>
                   5286: <p>There used to be a symbol
1.23      wiz      5287:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  5288:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  5289:            -m</strong></span>, but that's no longer supported and has
                   5290:            been removed.</p>
                   5291: </div>
                   5292: </dd>
                   5293: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5294: <dd>
                   5295: <p>Some packages want to embed the OS name and version
                   5296:          into some paths.  To do this, use these variables in the
                   5297:          <code class="filename">PLIST</code>:
                   5298:          </p>
1.41      asau     5299: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5300: <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>
                   5301: <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>
                   5302: <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  5303: </ul></div>
                   5304: </dd>
                   5305: </dl></div>
                   5306: <p>For a complete list of values which are replaced by
                   5307:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5308:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5309: <p>If you want to change other variables not listed above, you
                   5310:     can add variables and their expansions to this variable in the
1.10      hubertf  5311:     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  5312: <pre class="programlisting">
                   5313: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5314:     </pre>
1.23      wiz      5315: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  5316:     in the <code class="filename">PLIST</code> with
1.23      wiz      5317:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      5318: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   5319:     the common case of conditionally including some
                   5320:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5321:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   5322:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5323:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      5324:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      5325:     in the <code class="filename">PLIST</code> with either
1.23      wiz      5326:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5327:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      5328:     For example, in <code class="filename">Makefile</code>:</p>
                   5329: <pre class="programlisting">
                   5330: PLIST_VARS+=   foo
                   5331: .if <em class="replaceable"><code>condition</code></em>
                   5332: PLIST.foo=     yes
                   5333: .else
                   5334:     </pre>
                   5335: <p>And then in <code class="filename">PLIST</code>:</p>
                   5336: <pre class="programlisting">
                   5337: @comment $NetBSD$
                   5338: bin/bar
                   5339: man/man1/bar.1
                   5340: ${PLIST.foo}bin/foo
                   5341: ${PLIST.foo}man/man1/foo.1
                   5342: ${PLIST.foo}share/bar/foo.data
                   5343: ${PLIST.foo}@dirrm share/bar
                   5344:     </pre>
1.1       dsieger  5345: </div>
1.41      asau     5346: <div class="sect1">
1.1       dsieger  5347: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5348: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5349: <p>Man pages should be installed in compressed form if
                   5350:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5351:     and uncompressed otherwise. To handle this in the
1.23      wiz      5352:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  5353:     appended/removed automatically for man pages according to
                   5354:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5355:     or not, see above for details. This modification of the
                   5356:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5357:     <code class="filename">PLIST</code> itself.</p>
                   5358: </div>
1.41      asau     5359: <div class="sect1">
1.1       dsieger  5360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5361: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5362: </h2></div></div></div>
                   5363: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5364:     in generating the binary package, set the variable
                   5365:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29      dholland 5366:     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  5367:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5368:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5369: </div>
1.41      asau     5370: <div class="sect1">
1.1       dsieger  5371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5372: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5373: <p>Some packages decide to install a different set of files based on
                   5374:     the operating system being used. These differences can be
                   5375:     automatically handled by using the following files:</p>
1.41      asau     5376: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5377: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5378: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5379: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5380: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5381: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  5382: </ul></div>
                   5383: </div>
1.41      asau     5384: <div class="sect1">
1.1       dsieger  5385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5386: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23      wiz      5387: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  5388:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 5389:     directories were problematic because you had to add special
                   5390:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  5391:     centralized package handle them.</p>
1.22      jakllsch 5392: <p>In pkgsrc, it is now easy: Each package should create
                   5393:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5394:     will remove any directories left empty after uninstalling a
                   5395:     package.</p>
                   5396: <p>If a package needs an empty directory to work, create
                   5397:     the directory during installation as usual, and also add an
                   5398:     entry to the PLIST:
                   5399:     </p>
1.1       dsieger  5400: <pre class="programlisting">
1.22      jakllsch 5401: @pkgdir path/to/empty/directory
1.1       dsieger  5402:     </pre>
1.22      jakllsch 5403: <p>
                   5404:     </p>
1.1       dsieger  5405: </div>
                   5406: </div>
1.41      asau     5407: <div class="chapter">
1.1       dsieger  5408: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5409: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5410: <div class="toc">
                   5411: <p><b>Table of Contents</b></p>
                   5412: <dl>
1.6       rillig   5413: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      5414: <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  5415: <dd><dl>
1.6       rillig   5416: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      5417: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5418:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5419:       and
                   5420:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5421:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5422: </dl></dd>
1.23      wiz      5423: <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  5424: <dd><dl>
1.23      wiz      5425: <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   5426: <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  5427: </dl></dd>
                   5428: </dl>
                   5429: </div>
                   5430: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5431:   are seen by a package's configure and build processes.  This is implemented
                   5432:   in a two step process:</p>
1.23      wiz      5433: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5434: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  5435:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5436:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      5437: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  5438:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5439:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5440:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5441:       native compiler on some operating systems look like GCC, so that
                   5442:       packages that expect GCC won't require modifications to build with
                   5443:       those native compilers.</p></li>
                   5444: </ol></div>
                   5445: <p>This normalizes the environment in which a package is built so that the
                   5446:   package may be built consistently despite what other software may be
                   5447:   installed. Please note that the normal system header and library paths,
                   5448:   e.g. <code class="filename">/usr/include</code>,
                   5449:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5450:   designed to insulate the package build from non-system-supplied
                   5451:   software.</p>
1.41      asau     5452: <div class="sect1">
1.1       dsieger  5453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5454: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5455: <p>The process of converting packages to use the buildlink3
1.23      wiz      5456:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  5457:     The things to keep in mind are:</p>
1.23      wiz      5458: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5459: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  5460:        instead of the actual toolchain.  Some packages are tricky,
                   5461:        and the only way to know for sure is the check
                   5462:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5463:        wrappers are being invoked.</p></li>
1.23      wiz      5464: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  5465:        the package Makefile, e.g. Java VMs, standalone shells,
                   5466:        etc., because the code to symlink files into
                   5467:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      5468:        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  5469:        </p></li>
1.23      wiz      5470: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  5471:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5472:        package's Makefile are added as dependencies for that package.
                   5473:        </p></li>
                   5474: </ol></div>
                   5475: <p>If a dependency on a particular package is required for its libraries and
                   5476:     headers, then we replace:</p>
                   5477: <pre class="programlisting">
                   5478: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5479: </pre>
                   5480: <p>with</p>
                   5481: <pre class="programlisting">
                   5482: .include "../../category/foo/buildlink3.mk"
                   5483: </pre>
                   5484: <p>The buildlink3.mk files usually define the required dependencies.
                   5485:     If you need a newer version of the dependency when using buildlink3.mk
                   5486:     files, then you can define it in your Makefile; for example:</p>
                   5487: <pre class="programlisting">
                   5488: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5489: .include "../../category/foo/buildlink3.mk"
                   5490: </pre>
                   5491: <p>There are several <code class="filename">buildlink3.mk</code>
                   5492:     files in <code class="filename">pkgsrc/mk</code>
                   5493:     that handle special package issues:</p>
1.41      asau     5494: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5495: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  5496:        the native or a pkgsrc Berkeley DB implementation based on
                   5497:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5498:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      5499: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  5500:        comes with neither Curses nor NCurses, this will take care
                   5501:        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      5502: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  5503:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5504:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5505:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      5506: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  5507:        system-provided Motif installation or adds a dependency on
1.45      obache   5508:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.23      wiz      5509:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.45      obache   5510:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   5511:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.1       dsieger  5512:        which Motif version will be used.</p></li>
1.23      wiz      5513: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  5514:        variables that may be used by packages that use the
                   5515:        Open Sound System (OSS) API.</p></li>
1.23      wiz      5516: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35      wiz      5517:        any of the Postgres versions in the variable
                   5518:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   5519:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1       dsieger  5520:        the file for more information.</p></li>
1.23      wiz      5521: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  5522:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5523:        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      5524: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  5525:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5526:        library.</p></li>
                   5527: </ul></div>
                   5528: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5529:     files provide a more complete
                   5530:     description of how to use them properly.</p>
                   5531: </div>
1.41      asau     5532: <div class="sect1">
1.1       dsieger  5533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5534: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5535: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5536:     included by Makefiles to indicate the need to compile and link
                   5537:     against header files and libraries provided by the package.  A
                   5538:     <code class="filename">buildlink3.mk</code> file should always provide
                   5539:     enough information to add the correct type of dependency
                   5540:     relationship and include any other
                   5541:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5542:     headers and libraries that it needs in turn.</p>
                   5543: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5544:     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>
                   5545:     package is highly recommended.  For most packages, the following
                   5546:     command will generate a good starting point for
                   5547:     <code class="filename">buildlink3.mk</code> files:</p>
                   5548: <pre class="screen">
                   5549: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5550: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5551:     </pre>
1.41      asau     5552: <div class="sect2">
1.1       dsieger  5553: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5554: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5555: <p>The following real-life example
                   5556:       <code class="filename">buildlink3.mk</code> is taken
                   5557:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5558: <pre class="programlisting">
1.18      snj      5559: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  5560: 
1.18      snj      5561: BUILDLINK_TREE+=       tiff
1.1       dsieger  5562: 
1.18      snj      5563: .if !defined(TIFF_BUILDLINK3_MK)
                   5564: TIFF_BUILDLINK3_MK:=
1.1       dsieger  5565: 
1.18      snj      5566: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5567: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5568: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.1       dsieger  5569: 
                   5570: .include "../../devel/zlib/buildlink3.mk"
                   5571: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      5572: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  5573: 
1.18      snj      5574: BUILDLINK_TREE+=       -tiff
1.1       dsieger  5575: </pre>
                   5576: <p>The header and footer manipulate
1.18      snj      5577:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  5578:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      5579:       the dependency tree.</p>
                   5580: <p>The main section is protected from multiple inclusion
1.1       dsieger  5581:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5582:       added.  Several important variables are set in the section:</p>
1.41      asau     5583: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5584: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5585:          is the actual dependency recorded in the installed
                   5586:          package; this should always be set using
1.10      hubertf  5587:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  5588:          we're appending to any pre-existing list of values.  This
                   5589:          variable should be set to the first version of the
1.26      wiz      5590:          package that had an backwards-incompatible API change.
1.1       dsieger  5591:          </p></li>
1.23      wiz      5592: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5593:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5594:          pkgsrc directory.</p></li>
1.23      wiz      5595: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5596:          (not shown above) controls whether we use
                   5597:          <code class="varname">BUILD_DEPENDS</code> or
                   5598:          <code class="varname">DEPENDS</code> to add the dependency on
                   5599:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5600:          selected by setting
                   5601:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5602:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  5603:          used.</p></li>
1.23      wiz      5604: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5605:            and
                   5606:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5607:            (not shown above) are lists of subdirectories of
                   5608:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5609:            to add to the header and library search paths.  These
1.23      wiz      5610:            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  5611:          respectively.</p></li>
1.23      wiz      5612: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5613:            (not shown above) is the list of preprocessor flags to add
                   5614:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      5615:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  5616:            should be avoided and instead be handled using
                   5617:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5618:          above.</p></li>
                   5619: </ul></div>
                   5620: <p>The following variables are all optionally defined within
                   5621:       this second section (protected against multiple inclusion) and
                   5622:       control which package files are symlinked into
                   5623:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5624:       transformed during the symlinking:</p>
1.41      asau     5625: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5626: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5627:            (not shown above) is a shell glob pattern relative to
                   5628:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5629:            to be symlinked into
                   5630:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5631:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      5632: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5633:            (not shown above) is a shell pipeline that
                   5634:            outputs to stdout a list of files relative to
                   5635:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5636:            The resulting files are to be symlinked
                   5637:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5638:            this takes the <code class="filename">+CONTENTS</code> of a
                   5639:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5640:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      5641: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5642:            (not shown above) is a filter command that filters
                   5643:            <code class="filename">+CONTENTS</code> input into a list of files
                   5644:            relative to
                   5645:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5646:            on stdout.  By default for overwrite packages,
                   5647:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5648:            outputs the contents of the <code class="filename">include</code>
                   5649:            and <code class="filename">lib</code> directories in the package
                   5650:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5651:            it outputs any libtool archives in
                   5652:            <code class="filename">lib</code> directories.</p></li>
1.23      wiz      5653: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5654:            (not shown above) is a list of sed arguments used to
                   5655:            transform the name of the source filename into a
1.10      hubertf  5656:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  5657:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5658: </ul></div>
1.18      snj      5659: <p>This section can additionally include any
1.1       dsieger  5660:       <code class="filename">buildlink3.mk</code> needed for
                   5661:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5662:       Including these <code class="filename">buildlink3.mk</code> files
                   5663:       means that the headers and libraries for these
                   5664:       dependencies are also symlinked into
                   5665:       <code class="filename">${BUILDLINK_DIR}</code>
                   5666:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5667:       <code class="filename">buildlink3.mk</code>
1.18      snj      5668:       file is included. Dependencies are only added for directly
                   5669:       include <code class="filename">buildlink3.mk</code> files.</p>
1.47    ! wiz      5670: <p>When providing a <code class="filename">buildlink3.mk</code> and
        !          5671:       including other <code class="filename">buildlink3.mk</code> files in it,
        !          5672:       please only add necessary ones. I.e. those whose libraries or
        !          5673:       header files are automatically exposed when the package is
        !          5674:       use.</p>
        !          5675: <p>In particular, if only an executable
        !          5676:       (<code class="filename">bin/foo</code>) is linked against a library, that
        !          5677:       library does not need to be propagated in the
        !          5678:       <code class="filename">buildlink3.mk</code> file.</p>
        !          5679: <p>The following steps should help you decide if a
        !          5680:       <code class="filename">buildlink3.mk</code> file needs to be included:
        !          5681:       </p>
        !          5682: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
        !          5683: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
        !          5684:        libraries and look against what other libraries they link. The
        !          5685:        packages providing these must be
        !          5686:        buildlinked.</p></li>
        !          5687: <li class="listitem"><p>Look at the installed header files: What
        !          5688:        headers do they include? The packages providing these files
        !          5689:        must be buildlinked.</p></li>
        !          5690: </ul></div>
        !          5691: <p>
        !          5692:       </p>
1.1       dsieger  5693: </div>
1.41      asau     5694: <div class="sect2">
1.1       dsieger  5695: <div class="titlepage"><div><div><h3 class="title">
1.26      wiz      5696: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1       dsieger  5697:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5698:       and
                   5699:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5700:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5701: <p>These two variables differ in that one describes source
                   5702:       compatibility (API) and the other binary compatibility (ABI).
                   5703:       The difference is that a change in the API breaks compilation of
                   5704:       programs while changes in the ABI stop compiled programs from
                   5705:       running.</p>
                   5706: <p>Changes to the
1.27      wiz      5707:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5708:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5709:       very rarely. One possible reason is that all packages depending
                   5710:       on this already need a newer version. In case it is bumped see
                   5711:       the description below.</p>
                   5712: <p>The most common example of an ABI change is that the major
                   5713:       version of a shared library is increased. In this case,
                   5714:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5715:       should be adjusted to require at least the new package version.
                   5716:       Then the packages that depend on this package need their
                   5717:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5718:       <code class="filename">buildlink3.mk</code> files, their
                   5719:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5720:       adjusted, too. This is needed so pkgsrc will require the correct
                   5721:       package dependency and not settle for an older one when building
                   5722:       the source.</p>
1.10      hubertf  5723: <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      5724:       more information about dependencies on other packages,
                   5725:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  5726:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5727: <p>Please take careful consideration before adjusting
                   5728:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5729:       or
                   5730:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5731:       as we don't want to cause unneeded package deletions and
                   5732:       rebuilds.  In many cases, new versions of packages work just
                   5733:       fine with older dependencies.</p>
                   5734: <p>Also it is not needed to set
1.26      wiz      5735:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5736:       when it is identical to
1.1       dsieger  5737:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5738: </div>
                   5739: </div>
1.41      asau     5740: <div class="sect1">
1.1       dsieger  5741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5742: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5743: <p>Some packages in pkgsrc install headers and libraries that
                   5744:       coincide with headers and libraries present in the base system.
                   5745:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5746:       packages should also include a <code class="filename">builtin.mk</code>
                   5747:       file that includes the necessary checks to decide whether using
                   5748:       the built-in software or the pkgsrc software is
                   5749:     appropriate.</p>
                   5750: <p>The only requirements of a builtin.mk file for
                   5751:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      5752: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5753: <li class="listitem"><p>It should set
1.1       dsieger  5754:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5755:        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  5756:        after it is included.</p></li>
1.23      wiz      5757: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  5758:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5759:        which is already set before the
                   5760:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      5761: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  5762:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5763:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5764: </ol></div>
1.41      asau     5765: <div class="sect2">
1.1       dsieger  5766: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5767: <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  5768: <p>The following is the recommended template for builtin.mk
                   5769:       files:</p>
                   5770: <pre class="programlisting">
                   5771: .if !defined(IS_BUILTIN.foo)
                   5772: #
                   5773: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5774: # genuinely exists in the system or not.
                   5775: #
                   5776: IS_BUILTIN.foo?=        no
                   5777: 
                   5778: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5779: # version can be determined.
                   5780: #
                   5781: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5782: BUILTIN_PKG.foo?=       foo-1.0
                   5783: .  endif
                   5784: .endif  # IS_BUILTIN.foo
                   5785: 
                   5786: .if !defined(USE_BUILTIN.foo)
                   5787: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5788: .  if defined(BUILTIN_PKG.foo)
                   5789: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5790: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5791: USE_BUILTIN.foo!=                                                       \
                   5792:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5793:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5794: .      endif
                   5795: .    endfor
                   5796: .  endif
                   5797: .endif  # USE_BUILTIN.foo
                   5798: 
                   5799: CHECK_BUILTIN.foo?=     no
                   5800: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5801: #
                   5802: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5803: # "yes" or "no".
                   5804: #
                   5805: .endif  # CHECK_BUILTIN.foo
                   5806: </pre>
                   5807: <p>The first section sets
                   5808:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5809:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5810:       in the base system.  This should not be a base system software
                   5811:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      5812:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  5813:       included as part of the base system.  This variable is only
                   5814:       used internally within the <code class="filename">builtin.mk</code>
                   5815:       file.</p>
                   5816: <p>The second section sets
                   5817:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5818:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5819:       system if it exists (if
                   5820:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5821:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  5822:       within the <code class="filename">builtin.mk</code> file.</p>
                   5823: <p>The third section sets
                   5824:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5825:       and is <span class="emphasis"><em>required</em></span> in all
                   5826:       <code class="filename">builtin.mk</code> files.  The code in this
                   5827:       section must make the determination whether the built-in
                   5828:       software is adequate to satisfy the dependencies listed in
                   5829:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5830:       This is typically done by comparing
                   5831:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5832:       against each of the dependencies in
                   5833:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5834:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5835:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5836:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5837:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5838:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5839:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5840:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5841:       that the built-in version of the software is similar enough to
                   5842:       be used as a replacement.</p>
                   5843: <p>The last section is guarded by
                   5844:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5845:       and includes code that uses the value of
                   5846:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5847:       set in the previous section.  This typically includes, e.g.,
                   5848:       adding additional dependency restrictions and listing additional
                   5849:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5850:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5851: </div>
1.41      asau     5852: <div class="sect2">
1.1       dsieger  5853: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5854: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5855: <p>When building packages, it's possible to choose whether to set
                   5856:        a global preference for using either the built-in (native)
                   5857:        version or the pkgsrc version of software to satisfy a
                   5858:        dependency.  This is controlled by setting
                   5859:        <code class="varname">PREFER_PKGSRC</code> and
                   5860:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5861:        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  5862:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5863:        use the pkgsrc versions of software, while
                   5864:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5865:        built-in versions.  Preferences are determined by the most
                   5866:        specific instance of the package in either
                   5867:        <code class="varname">PREFER_PKGSRC</code> or
                   5868:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5869:        in neither or in both variables, then
                   5870:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5871:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5872:        using pkgsrc versions of software for all but the most basic
                   5873:       bits on a NetBSD system, you can set:</p>
                   5874: <pre class="programlisting">
                   5875: PREFER_PKGSRC=  yes
                   5876: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5877: </pre>
                   5878: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5879:       <code class="filename">builtin.mk</code>
                   5880:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5881:       otherwise it is simply ignored in that list.</p>
                   5882: </div>
                   5883: </div>
                   5884: </div>
1.41      asau     5885: <div class="chapter">
1.1       dsieger  5886: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5887: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5888: <div class="toc">
                   5889: <p><b>Table of Contents</b></p>
                   5890: <dl>
1.6       rillig   5891: <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  5892: <dd><dl>
1.6       rillig   5893: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5894: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5895: </dl></dd>
1.6       rillig   5896: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5897: <dd><dl>
1.23      wiz      5898: <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   5899: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5900: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5901: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5902: </dl></dd>
                   5903: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5904: <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>
                   5905: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5906: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5907: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5908: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5909: <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  5910: </dl>
                   5911: </div>
                   5912: <p>This chapter describes the framework known as
                   5913: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41      asau     5914: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5915: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5916:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5917: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5918:     provided that packages are correctly designed.</p></li>
1.23      wiz      5919: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5920: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5921: <li class="listitem"><p>Registration of system shells.</p></li>
                   5922: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5923: </ul></div>
                   5924: <p>The following sections inspect each of the above points in detail.</p>
                   5925: <p>You may be thinking that many of the things described here could be
                   5926: easily done with simple code in the package's post-installation target
                   5927: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5928: as the code in them is only executed when building from source.  Machines
                   5929: using binary packages could not benefit from it at all (as the code itself
                   5930: could be unavailable).  Therefore, the only way to achieve any of the items
                   5931: described above is by means of the installation scripts, which are
                   5932: automatically generated by pkginstall.</p>
1.41      asau     5933: <div class="sect1">
1.1       dsieger  5934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5935: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5936: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5937: of files and directories that belong to a package.  The names used in it
                   5938: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5939: which means that it cannot register files outside this directory (absolute
                   5940: path names are not allowed).  Despite this restriction, some packages need
                   5941: to install files outside this location; e.g., under
                   5942: <code class="filename">${VARBASE}</code> or
                   5943: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5944: is to create such files during installation time by using
                   5945: installation scripts.</p>
                   5946: <p>The generic installation scripts are shell scripts that can
                   5947: contain arbitrary code.  The list of scripts to execute is taken from
                   5948: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5949: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5950: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5951: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5952: commands, so they have the potential to create and manage files
                   5953: anywhere in the file system.</p>
                   5954: <p>Using these general installation files is not recommended, but
                   5955: may be needed in some special cases.  One reason for avoiding them is
                   5956: that the user has to trust the packager that there is no unwanted or
                   5957: simply erroneous code included in the installation script. Also,
                   5958: previously there were many similar scripts for the same functionality,
                   5959: and fixing a common error involved finding and changing all of
                   5960: them.</p>
                   5961: <p>The pkginstall framework offers another, standardized way.  It
                   5962: provides generic scripts to abstract the manipulation of such files
                   5963: and directories based on variables set in the package's
                   5964: <code class="filename">Makefile</code>.  The rest of this section describes
                   5965: these variables.</p>
1.41      asau     5966: <div class="sect2">
1.1       dsieger  5967: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5968: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5969: <p>The following variables can be set to request the creation of
                   5970: directories anywhere in the file system:</p>
1.41      asau     5971: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5972: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5973:     contain a list of directories that should be created and should attempt
                   5974:     to be destroyed by the installation scripts.  The difference between
                   5975:     the two is that the latter prompts the administrator to remove any
                   5976:     directories that may be left after deinstallation (because they were
                   5977:     not empty), while the former does not.</p></li>
1.23      wiz      5978: <li class="listitem">
1.1       dsieger  5979: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5980:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5981:     which directories should be created and should attempt to be destroyed
                   5982:     by the installation scripts.  Each tuple holds the following values,
                   5983:     separated by spaces: the directory name, its owner, its group and its
                   5984:     numerical mode.  For example:</p>
                   5985: <pre class="programlisting">
                   5986: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5987: </pre>
                   5988: <p>The difference between the two is exactly the same as their
                   5989:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5990: </li>
                   5991: </ul></div>
                   5992: </div>
1.41      asau     5993: <div class="sect2">
1.1       dsieger  5994: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5995: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5996: <p>Creating non-empty files outside the installation prefix is tricky
                   5997: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5998: To overcome this problem, the only solution is to extract the file in the
                   5999: known place (i.e., inside the installation prefix) and copy it to the
                   6000: appropriate location during installation (done by the installation scripts
                   6001: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6002: file</em></span> in the following paragraphs, which describe the variables
                   6003: that can be used to automatically and consistently handle files outside the
                   6004: installation prefix:</p>
1.41      asau     6005: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6006: <li class="listitem">
1.1       dsieger  6007: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      6008:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  6009:     During installation time, the master file is copied to the target one
                   6010:     if and only if the latter does not exist.  Upon deinstallation, the
                   6011:     target file is removed provided that it was not modified by the
                   6012:     installation.</p>
                   6013: <p>The difference between the two is that the latter prompts the
                   6014:     administrator to remove any files that may be left after
                   6015:     deinstallation (because they were not empty), while the former does
                   6016:     not.</p>
                   6017: </li>
1.23      wiz      6018: <li class="listitem">
1.1       dsieger  6019: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      6020:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  6021:     files as well as their target locations.  For each of them, it also
                   6022:     specifies their owner, their group and their numeric permissions, in
                   6023:     this order.  For example:</p>
                   6024: <pre class="programlisting">
1.30      wiz      6025: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       dsieger  6026: </pre>
                   6027: <p>The difference between the two is exactly the same as their
                   6028:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6029: </li>
                   6030: </ul></div>
                   6031: </div>
                   6032: </div>
1.41      asau     6033: <div class="sect1">
1.1       dsieger  6034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6035: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  6036: <p>Configuration files are special in the sense that they are installed
                   6037: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6038: need special treatment during installation (most of which is automated by
                   6039: pkginstall).  The main concept you must bear in mind is that files marked
                   6040: as configuration files are automatically copied to the right place (somewhere
                   6041: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6042: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6043: be removed if they have local modifications.  This ensures that
                   6044: administrators never lose any custom changes they may have made.</p>
1.41      asau     6045: <div class="sect2">
1.1       dsieger  6046: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6047: <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  6048: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6049: specifies where configuration files shall be installed.  Its contents are
                   6050: set based upon the following variables:</p>
1.41      asau     6051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6052: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  6053:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   6054:     be overridden by the user to point to his preferred location (e.g.,
                   6055:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   6056:     Packages must not use it directly.</p></li>
1.23      wiz      6057: <li class="listitem">
1.1       dsieger  6058: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6059:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6060:     for the package being built shall be installed.  The definition of this
                   6061:     variable only makes sense in the package's
                   6062:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   6063: <p>As an example, consider the Apache package,
                   6064:     <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
                   6065:     configuration files under the
                   6066:     <code class="filename">httpd/</code> subdirectory of
                   6067:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6068:     Makefile.</p>
                   6069: </li>
1.23      wiz      6070: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  6071:     variable that holds this package's configuration directory (if
                   6072:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6073:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6074:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      6075: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  6076:     directory where the configuration files for the package identified by
                   6077:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6078: </ul></div>
                   6079: <p>Based on the above variables, pkginstall determines the value of
                   6080: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6081: variable that can be used within a package to refer to its configuration
                   6082: directory.  The algorithm used to set its value is basically the
                   6083: following:</p>
1.23      wiz      6084: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6085: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  6086:     its value is used.</p></li>
1.23      wiz      6087: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  6088:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6089:     <code class="filename">Makefile</code>, the resulting value is
                   6090:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      6091: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  6092:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6093: </ol></div>
                   6094: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  6095: 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
                   6096: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6097: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  6098: </div>
1.41      asau     6099: <div class="sect2">
1.1       dsieger  6100: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6101: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  6102: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6103: known place, you need to teach each package where it shall install its
                   6104: files.  In some cases you will have to patch the package Makefiles to
                   6105: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6106: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6107: generated files:</p>
                   6108: <pre class="programlisting">
                   6109: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   6110: </pre>
                   6111: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6112: for</em></span> its configuration files, not where they will be originally
                   6113: installed (although the difference is never explicit,
                   6114: unfortunately).</p>
                   6115: </div>
1.41      asau     6116: <div class="sect2">
1.1       dsieger  6117: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6118: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  6119: <p>As said before, pkginstall automatically handles configuration files.
                   6120: This means that <span class="strong"><strong>the packages themselves must not
                   6121: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   6122: directly</strong></span>.  Bad news is that many software installation scripts
                   6123: will, out of the box, mess with the contents of that directory.  So what is
                   6124: the correct procedure to fix this issue?</p>
                   6125: <p>You must teach the package (usually by manually patching it) to
                   6126: install any configuration files under the examples hierarchy,
                   6127: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6128: <code class="filename">PLIST</code> registers them and the administrator always
                   6129: has the original copies available.</p>
                   6130: <p>Once the required configuration files are in place (i.e., under the
                   6131: examples hierarchy), the pkginstall framework can use them as master copies
                   6132: during the package installation to update what is in
                   6133: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   6134: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  6135: 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  6136: about their syntax and their purpose.  Here is an example, taken from the
                   6137: <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>
                   6138: <pre class="programlisting">
                   6139: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6140: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   6141: </pre>
                   6142: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6143: package and has no meaning outside it.</p>
                   6144: </div>
1.41      asau     6145: <div class="sect2">
1.1       dsieger  6146: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6147: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  6148: <p>The automatic copying of config files can be toggled by setting the
                   6149: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6150: installation.</p>
                   6151: </div>
                   6152: </div>
1.41      asau     6153: <div class="sect1">
1.1       dsieger  6154: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6155: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  6156: <p>System startup scripts are special files because they must be
                   6157: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  6158: 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  6159: can be used.  However, pkginstall provides a special mechanism to handle
                   6160: these files.</p>
                   6161: <p>In order to provide system startup scripts, the package has
                   6162: to:</p>
1.23      wiz      6163: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6164: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  6165:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   6166:     <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
                   6167:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      6168: <li class="listitem">
1.1       dsieger  6169: <p>Tell pkginstall to handle it, appending the name of the script,
                   6170:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6171:     Continuing the previous example:</p>
                   6172: <pre class="programlisting">
                   6173: RCD_SCRIPTS+=   cupsd
                   6174: </pre>
                   6175: </li>
                   6176: </ol></div>
                   6177: <p>Once this is done, pkginstall will do the following steps for each
                   6178: script in an automated fashion:</p>
1.23      wiz      6179: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6180: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  6181:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6182:     variable.</p></li>
1.23      wiz      6183: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  6184:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6185:     that this master file must be explicitly registered in the
                   6186:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      6187: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  6188:     from the examples hierarchy into the system-wide startup scripts
                   6189:     directory.</p></li>
                   6190: </ol></div>
1.41      asau     6191: <div class="sect2">
1.1       dsieger  6192: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6193: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6194: <p>The automatic copying of config files can be toggled by setting the
                   6195: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6196: installation.  Note that the scripts will be always copied inside the
                   6197: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6198: matter what the value of this variable is.</p>
                   6199: </div>
                   6200: </div>
1.41      asau     6201: <div class="sect1">
1.1       dsieger  6202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6203: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6204: <p>If a package needs to create special users and/or groups during
                   6205: installation, it can do so by using the pkginstall framework.</p>
                   6206: <p>Users can be created by adding entries to the
                   6207: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6208: syntax:</p>
                   6209: <pre class="programlisting">
                   6210: user:group
                   6211: </pre>
                   6212: <p>Further specification of user details may be done by setting
                   6213: per-user variables.
                   6214: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6215: numeric UID for the user.
                   6216: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6217: user's description or comment.
                   6218: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6219: user's home directory, and defaults to
                   6220: <code class="filename">/nonexistent</code> if not specified.
                   6221: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6222: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6223: not specified.</p>
                   6224: <p>Similarly, groups can be created by adding entries to the
                   6225: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6226: <pre class="programlisting">
                   6227: group
                   6228: </pre>
                   6229: <p>The numeric GID of the group may be set by defining
                   6230: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6231: <p>If a package needs to create the users and groups at an earlier
                   6232: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6233: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6234: indicate the phase before which the users and groups are created.  In
                   6235: this case, the numeric UIDs and GIDs of the created users and groups
                   6236: are automatically hardcoded into the final installation scripts.</p>
                   6237: </div>
1.41      asau     6238: <div class="sect1">
1.1       dsieger  6239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6240: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6241: <p>Packages that install system shells should register them in the shell
                   6242: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6243: administrator.  This must be done from the installation scripts to keep
                   6244: binary packages working on any system.  pkginstall provides an easy way to
                   6245: accomplish this task.</p>
                   6246: <p>When a package provides a shell interpreter, it has to set the
                   6247: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6248: add some hooks to the installation scripts to handle it.  Consider the
                   6249: 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>
                   6250: <pre class="programlisting">
                   6251: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6252: </pre>
1.41      asau     6253: <div class="sect2">
1.1       dsieger  6254: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6255: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6256: <p>The automatic registration of shell interpreters can be disabled by
                   6257: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6258: environment variable to <code class="literal">NO</code>.</p>
                   6259: </div>
                   6260: </div>
1.41      asau     6261: <div class="sect1">
1.1       dsieger  6262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6263: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6264: <p>Packages that install X11 fonts should update the database files
                   6265: that index the fonts within each fonts directory.  This can easily be
                   6266: accomplished within the pkginstall framework.</p>
                   6267: <p>When a package installs X11 fonts, it must list the directories in
                   6268: which fonts are installed in the
                   6269: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      6270: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   6271: <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  6272: installation scripts to run the appropriate commands to update the fonts
                   6273: database files within each of those directories.  For convenience, if the
                   6274: directory path is relative, it is taken to be relative to the package's
                   6275: 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>
                   6276: <pre class="programlisting">
                   6277: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6278: </pre>
1.41      asau     6279: <div class="sect2">
1.1       dsieger  6280: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6281: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6282: <p>The automatic update of fonts databases can be disabled by
                   6283: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6284: environment variable to <code class="literal">NO</code>.</p>
                   6285: </div>
                   6286: </div>
                   6287: </div>
1.41      asau     6288: <div class="chapter">
1.1       dsieger  6289: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6290: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6291: <div class="toc">
                   6292: <p><b>Table of Contents</b></p>
                   6293: <dl>
1.6       rillig   6294: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      6295: <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   6296: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6297: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6298: </dl>
                   6299: </div>
                   6300: <p>Many packages have the ability to be built to support different
                   6301: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6302: in pkgsrc that provides generic handling of those options that
                   6303: determine different ways in which the packages can be built.  It's
                   6304: possible for the user to specify exactly which sets of options will be
                   6305: built into a package or to allow a set of global default options
                   6306: apply.</p>
1.7       rillig   6307: <p>There are two broad classes of behaviors that one might want to
                   6308: control via options.  One is whether some particular feature is
                   6309: enabled in a program that will be built anyway, often by including or
                   6310: not including a dependency on some other package.  The other is
                   6311: whether or not an additional program will be built as part of the
                   6312: package.  Generally, it is better to make a split package for such
                   6313: additional programs instead of using options, because it enables
                   6314: binary packages to be built which can then be added separately.  For
                   6315: example, the foo package might have minimal dependencies (those
                   6316: packages without which foo doesn't make sense), and then the foo-gfoo
                   6317: package might include the GTK frontend program gfoo.  This is better
                   6318: than including a gtk option to foo that adds gfoo, because either that
                   6319: option is default, in which case binary users can't get foo without
                   6320: gfoo, or not default, in which case they can't get gfoo.  With split
                   6321: packages, they can install foo without having GTK, and later decide to
                   6322: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6323: source users too, avoiding the need for rebuilds.</p>
                   6324: <p>Plugins with widely varying dependencies should usually be split
                   6325: instead of options.</p>
                   6326: <p>It is often more work to maintain split packages, especially if
                   6327: the upstream package does not support this.  The decision of split
                   6328: vs. option should be made based on the likelihood that users will want
                   6329: or object to the various pieces, the size of the dependencies that are
                   6330: included, and the amount of work.</p>
                   6331: <p>A further consideration is licensing.  Non-free parts, or parts
                   6332: that depend on non-free dependencies (especially plugins) should
                   6333: almost always be split if feasible.</p>
1.41      asau     6334: <div class="sect1">
1.1       dsieger  6335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6336: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6337: <p>Global default options are listed in
                   6338: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6339: that should be built into every package if that option is supported.
1.10      hubertf  6340: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6341: </div>
1.41      asau     6342: <div class="sect1">
1.1       dsieger  6343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6344: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6345: </h2></div></div></div>
                   6346: <p>The following example shows how
                   6347: <code class="filename">bsd.options.mk</code> should be used
                   6348: by the hypothetical ``wibble'' package, either in the package
                   6349: <code class="filename">Makefile</code>, or in a file,
                   6350: e.g. <code class="filename">options.mk</code>, that is included by the
                   6351: main package <code class="filename">Makefile</code>.</p>
                   6352: <pre class="programlisting">
                   6353: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6354: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6355: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6356: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6357: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6358: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6359: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6360: 
                   6361: .include "../../mk/bsd.prefs.mk"
                   6362: 
                   6363: # this package was previously named wibble2
                   6364: .if defined(PKG_OPTIONS.wibble2)
                   6365: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6366: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6367:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6368: .endif
                   6369: 
                   6370: .include "../../mk/bsd.options.mk"
                   6371: 
                   6372: # Package-specific option-handling
                   6373: 
                   6374: ###
                   6375: ### FOO support
                   6376: ###
                   6377: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6378: CONFIGURE_ARGS+=    --enable-foo
                   6379: .endif
                   6380: 
                   6381: ###
                   6382: ### LDAP support
                   6383: ###
                   6384: .if !empty(PKG_OPTIONS:Mldap)
                   6385: .  include "../../databases/openldap-client/buildlink3.mk"
                   6386: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6387: .endif
                   6388: 
                   6389: ###
                   6390: ### database support
                   6391: ###
                   6392: .if !empty(PKG_OPTIONS:Mmysql)
                   6393: .  include "../../mk/mysql.buildlink3.mk"
                   6394: .endif
                   6395: .if !empty(PKG_OPTIONS:Mpgsql)
                   6396: .  include "../../mk/pgsql.buildlink3.mk"
                   6397: .endif
                   6398: </pre>
                   6399: <p>The first section contains the information about which build
                   6400: options are supported by the package, and any default options settings
                   6401: if needed.</p>
1.23      wiz      6402: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6403: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29      dholland 6404: <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  6405: options.  It should be set to
                   6406: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6407: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6408: at the point where the options are processed.</p></li>
1.23      wiz      6409: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  6410: build options supported by the package.</p></li>
1.23      wiz      6411: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  6412: list of names of groups of mutually exclusive options.  The options in
                   6413: each group are listed in
                   6414: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6415: The most specific setting of any option from the group takes
                   6416: precedence over all other options in the group.  Options from the
                   6417: groups will be automatically added to
                   6418: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      6419: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  6420: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6421: packages will fail if no option from the group is
                   6422: selected.</p></li>
1.23      wiz      6423: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  6424: of names of sets of options.  At least one option from each set must
                   6425: be selected.  The options in each set are listed in
                   6426: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6427: Options from the sets will be automatically added to
                   6428: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6429: fail if no option from the set is selected.</p></li>
1.23      wiz      6430: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  6431: build options which are enabled by default.</p></li>
1.23      wiz      6432: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  6433: of
1.23      wiz      6434: <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  6435: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6436: their option counterparts.  Pairs should be added with
1.23      wiz      6437: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  6438: warning will be issued if the user uses a legacy
                   6439: variable.</p></li>
1.23      wiz      6440: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  6441: of
1.23      wiz      6442: <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  6443: pairs that map options that have been renamed to their new
1.23      wiz      6444: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  6445: the listing of global legacy options.  A warning will be issued if
                   6446: the user uses a legacy option.</p></li>
1.23      wiz      6447: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  6448: options implied by deprecated variables used.  This can be used for
                   6449: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6450: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6451: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      6452: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  6453: a list of warnings about deprecated variables or options used, and
                   6454: what to use instead.</p></li>
                   6455: </ol></div>
                   6456: <p>A package should never modify
                   6457: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6458: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6459: To suggest a default set of options, use
                   6460: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6461: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6462: including <code class="filename">bsd.options.mk</code>.  If none of
                   6463: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6464: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6465: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6466: happen with platform-specific options if none of them is supported on
                   6467: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6468: empty list and the package is otherwise treated as not using the
                   6469: options framework.</p>
                   6470: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6471: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6472: build options, properly filtered to remove unsupported and duplicate
                   6473: options.</p>
                   6474: <p>The remaining sections contain the logic that is specific to
                   6475: each option.  The correct way to check for an option is to check
                   6476: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6477: <pre class="programlisting">
                   6478: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6479: </pre>
                   6480: </div>
1.41      asau     6481: <div class="sect1">
1.1       dsieger  6482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6483: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6484: <p>Options that enable similar features in different packages (like
                   6485: optional support for a library) should use a common name in all
                   6486: packages that support it (like the name of the library).  If another
                   6487: package already has an option with the same meaning, use the same
                   6488: name.</p>
                   6489: <p>Options that enable features specific to one package, where it's
                   6490: unlikely that another (unrelated) package has the same (or a similar)
                   6491: optional feature, should use a name prefixed with
                   6492: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6493: <p>If a group of related packages share an optional feature
                   6494: specific to that group, prefix it with the name of the
1.23      wiz      6495: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  6496: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6497: <p>For new options, add a line to
                   6498: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6499: fields, separated by tab.  The first field is the option name, the
                   6500: second its description.  The description should be a whole sentence
                   6501: (starting with an uppercase letter and ending with a period) that
1.23      wiz      6502: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6503: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  6504: </div>
1.41      asau     6505: <div class="sect1">
1.7       rillig   6506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6507: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  6508: <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   6509: different dependencies based on the options with which the package was
                   6510: built. For querying these options, the file
                   6511: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6512: typical example looks like this:</p>
                   6513: <pre class="programlisting">
                   6514: pkgbase := libpurple
                   6515: .include "../../mk/pkg-build-options.mk"
                   6516: 
                   6517: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6518: ...
                   6519: .endif
                   6520: </pre>
                   6521: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6522: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6523: options of the libpurple package, which can then be queried like
                   6524: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6525: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6526: details.</p>
                   6527: </div>
1.1       dsieger  6528: </div>
1.41      asau     6529: <div class="chapter">
1.1       dsieger  6530: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6531: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6532: <div class="toc">
                   6533: <p><b>Table of Contents</b></p>
                   6534: <dl>
1.6       rillig   6535: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6536: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6537: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6538: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      6539: <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   6540: <dd><dl>
                   6541: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6542: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6543: </dl></dd>
1.23      wiz      6544: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6545: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6546: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6547: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6548: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6549: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6550: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6551: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6552: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6553: <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   6554: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6555: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6556: </dl>
                   6557: </div>
1.41      asau     6558: <div class="sect1">
1.1       dsieger  6559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6560: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6561: <p>This chapter gives a detailed description on how a package is
                   6562:     built. Building a package is separated into different
                   6563:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6564:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      6565:     described in the following sections. Each phase is split into
1.1       dsieger  6566:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6567:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6568:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6569:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6570:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6571: <p>Never override the regular targets (like
                   6572:     <code class="varname">fetch</code>), if you have to, override the
                   6573:     <code class="varname">do-*</code> ones instead.</p>
                   6574: <p>The basic steps for building a program are always the same.  First
                   6575:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6576:     the local system and then extracted. After any pkgsrc-specific patches
                   6577:     to compile properly are applied, the software can be configured, then
                   6578:     built (usually by compiling), and finally the generated binaries, etc.
                   6579:     can be put into place on the system.</p>
                   6580: <p>To get more details about what is happening at each step,
                   6581:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6582:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6583:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6584: </div>
1.41      asau     6585: <div class="sect1">
1.1       dsieger  6586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6587: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6588: <p>Before outlining the process performed by the NetBSD package system in
                   6589:     the next section, here's a brief discussion on where programs are
                   6590:     installed, and which variables influence this.</p>
                   6591: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6592:     where all files of the final program shall be installed. It is
                   6593:     usually set to <code class="varname">LOCALBASE</code>
                   6594:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6595:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6596:     <code class="varname">PREFIX</code> needs to be put
                   6597:     into the various places in the program's source where paths to
1.10      hubertf  6598:     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  6599: <p>When choosing which of these variables to use,
                   6600:     follow the following rules:</p>
1.41      asau     6601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6602: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  6603:        where the current pkg will be installed.  When referring to a
                   6604:        pkg's own installation path, use
1.23      wiz      6605:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6606: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  6607:        are installed.  If you need to construct a -I or -L argument
                   6608:        to the compiler to find includes and libraries installed by
1.23      wiz      6609:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  6610:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6611:        installed all packages in <code class="filename">/usr/local</code>. As
                   6612:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6613:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      6614: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  6615:        distribution (from xsrc, etc.) is installed. When looking for
                   6616:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      6617:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   6618: <li class="listitem">
1.1       dsieger  6619: <p>X11-based packages are special in that they may be
                   6620:        installed in either <code class="varname">X11BASE</code> or
                   6621:        <code class="varname">LOCALBASE</code>.</p>
                   6622: <p>Usually, X11 packages should be installed under
                   6623:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6624:        will need to include
                   6625:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6626:        request the presence of X11 and to get the right compilation
                   6627:        flags.</p>
                   6628: <p>Even though, there are some packages that cannot be installed
                   6629:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6630:        files. These packages are special and they must be placed under
                   6631:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6632:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6633:        your package.</p>
                   6634: <p>Some notes: If you need
                   6635:        to find includes or libraries installed by a pkg that has
                   6636:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6637:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6638:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6639:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6640:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6641:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6642:        is enabled by default.</p>
                   6643: </li>
1.23      wiz      6644: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1       dsieger  6645:        the installed location of an X11
                   6646:        package. <code class="varname">X11PREFIX</code> will be set to
                   6647:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6648:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6649:        installed.</p></li>
1.23      wiz      6650: <li class="listitem">
1.1       dsieger  6651: <p>If xpkgwedge is installed, it is possible to have some
                   6652:        packages installed in <code class="varname">X11BASE</code> and some in
                   6653:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6654:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6655:        definition can be used. It takes pairs in the format
1.29      dholland 6656:        <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  6657:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6658:        of the installed package &lt;package&gt;, or
1.23      wiz      6659:        <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
1.1       dsieger  6660:        installed.</p>
                   6661: <p>This is best illustrated by example.</p>
                   6662: <p>The following lines are taken from
                   6663:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6664: <pre class="programlisting">
                   6665: EVAL_PREFIX+=           GTKDIR=gtk+
                   6666: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6667: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6668: CONFIGURE_ARGS+=        --enable-multibyte
                   6669: </pre>
                   6670: <p>Specific defaults can be defined for the packages
                   6671:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6672:        definition of the form:</p>
                   6673: <pre class="programlisting">
                   6674: GTKDIR_DEFAULT= ${LOCALBASE}
                   6675: </pre>
                   6676: <p>where <code class="varname">GTKDIR</code> corresponds
                   6677:        to the first definition in
                   6678:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6679: </li>
1.23      wiz      6680: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29      dholland 6681:        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  6682:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6683:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6684: </ul></div>
                   6685: </div>
1.41      asau     6686: <div class="sect1">
1.1       dsieger  6687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6688: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 6689: <p>When building a package, various directories are used to store
1.1       dsieger  6690:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6691:     directories are explained here.</p>
                   6692: <p>Some of the directory variables contain relative pathnames. There
                   6693:     are two common base directories for these relative directories:
                   6694:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6695:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6696:     inside the package itself.</p>
1.41      asau     6697: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6698: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6699: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6700:       root directory. Generally, you don't need
                   6701:       it.</p></dd>
                   6702: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6703: <dd><p>This is an absolute pathname that points to the
                   6704:       current package.</p></dd>
                   6705: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6706: <dd><p>This is a pathname relative to
                   6707:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6708:       package.</p></dd>
                   6709: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6710: <dd><p>This is an absolute pathname pointing to the directory
                   6711:       where all work takes place. The distfiles are extracted to this
                   6712:       directory. It also contains temporary directories and log files used by
                   6713:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6714:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6715: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6716: <dd><p>This is an absolute pathname pointing to the directory
                   6717:       where the distfiles are extracted. It is usually a direct subdirectory
                   6718:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6719:       that isn't hidden. This variable may be changed by a package
                   6720:       <code class="filename">Makefile</code>.</p></dd>
                   6721: </dl></div>
1.14      jmcneill 6722: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6723:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   6724:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 6725:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6726:     If users would like to have their pkgsrc trees behave in a
                   6727:     read-only manner, then the value of
                   6728:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6729:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  6730: </div>
1.41      asau     6731: <div class="sect1">
1.1       dsieger  6732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6733: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  6734: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  6735:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6736:     phase. This will automatically run all phases that are required for this
                   6737:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  6738:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  6739:     the package will be built, but not installed.</p>
                   6740: </div>
1.41      asau     6741: <div class="sect1">
1.1       dsieger  6742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6743: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6744: <p>The first step in building a package is to fetch the
                   6745:     distribution files (distfiles) from the sites that are providing
                   6746:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6747:     phase.</p>
1.41      asau     6748: <div class="sect2">
1.1       dsieger  6749: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6750: <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  6751: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6752:       defines all URLs from where the distfile, whose name is
                   6753:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6754:       fetched. The more complicated cases are described
                   6755:       below.</p>
                   6756: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6757:       the list of distfiles that have to be fetched. Its value
                   6758:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6759:       so that most packages don't need to define it at all.
                   6760:       <code class="varname">EXTRACT_SUFX</code> is
                   6761:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6762:       freely. Note that if your package requires additional
                   6763:       distfiles to the default one, you cannot just append the
                   6764:       additional filenames using the <code class="literal">+=</code>
                   6765:       operator, but you have write for example:</p>
                   6766: <pre class="programlisting">
                   6767: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6768: </pre>
                   6769: <p>Each distfile is fetched from a list of sites, usually
                   6770:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6771:       <code class="varname">DISTFILES</code> or multiple
                   6772:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6773:       set
                   6774:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6775:       to the list of URLs where the file
                   6776:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6777:       (including the suffix) can be found.</p>
                   6778: <pre class="programlisting">
                   6779: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6780: DISTFILES+=     foo-file.tar.gz
                   6781: SITES.foo-file.tar.gz= \
                   6782: http://www.somewhere.com/somehow/ \
                   6783: http://www.somewhereelse.com/mirror/somehow/
                   6784: </pre>
                   6785: <p>When actually fetching the distfiles, each item from
                   6786:       <code class="varname">MASTER_SITES</code> or
                   6787:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6788:       appended to it, without an intermediate slash. Therefore,
                   6789:       all site values have to end with a slash or other separator
                   6790:       character. This allows for example to set
                   6791:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6792:       that gets the name of the distfile as a parameter. In this
                   6793:       case, the definition would look like:</p>
                   6794: <pre class="programlisting">
                   6795: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6796: </pre>
1.22      jakllsch 6797: <p> The exception to this rule are URLs starting with a dash.
                   6798:       In that case the URL is taken as is, fetched and the result stored
                   6799:       under the name of the distfile.</p>
1.1       dsieger  6800: <p>There are some predefined values for
                   6801:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6802:       packages.  The names of the variables should speak for
                   6803:       themselves.</p>
                   6804: <pre class="programlisting">
                   6805: ${MASTER_SITE_APACHE}
                   6806: ${MASTER_SITE_BACKUP}
                   6807: ${MASTER_SITE_CYGWIN}
                   6808: ${MASTER_SITE_DEBIAN}
                   6809: ${MASTER_SITE_FREEBSD}
                   6810: ${MASTER_SITE_FREEBSD_LOCAL}
                   6811: ${MASTER_SITE_GENTOO}
                   6812: ${MASTER_SITE_GNOME}
                   6813: ${MASTER_SITE_GNU}
                   6814: ${MASTER_SITE_GNUSTEP}
                   6815: ${MASTER_SITE_IFARCHIVE}
                   6816: ${MASTER_SITE_KDE}
                   6817: ${MASTER_SITE_MOZILLA}
                   6818: ${MASTER_SITE_MYSQL}
                   6819: ${MASTER_SITE_OPENOFFICE}
                   6820: ${MASTER_SITE_PERL_CPAN}
                   6821: ${MASTER_SITE_PGSQL}
                   6822: ${MASTER_SITE_R_CRAN}
                   6823: ${MASTER_SITE_SOURCEFORGE}
                   6824: ${MASTER_SITE_SOURCEFORGE_JP}
                   6825: ${MASTER_SITE_SUNSITE}
                   6826: ${MASTER_SITE_SUSE}
                   6827: ${MASTER_SITE_TEX_CTAN}
                   6828: ${MASTER_SITE_XCONTRIB}
                   6829: ${MASTER_SITE_XEMACS}
                   6830: </pre>
                   6831: <p>Some explanations for the less self-explaining ones:
                   6832:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6833:       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      6834:       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  6835: <p>If you choose one of these predefined sites, you may
                   6836:       want to specify a subdirectory of that site. Since these
                   6837:       macros may expand to more than one actual site, you
                   6838:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6839:       specify a subdirectory:</p>
                   6840: <pre class="programlisting">
                   6841: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6842: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6843: </pre>
                   6844: <p>Note the trailing slash after the subdirectory
                   6845:       name.</p>
                   6846: </div>
1.41      asau     6847: <div class="sect2">
1.1       dsieger  6848: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6849: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6850: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6851:       all the distfiles exist in a local directory
                   6852:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6853:       user). If the files do not exist, they are fetched using
                   6854:       commands of the form</p>
                   6855: <pre class="programlisting">
                   6856: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6857: </pre>
                   6858: <p>where <code class="literal">${site}</code> varies through
                   6859:       several possibilities in turn: first,
                   6860:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6861:       sites specified in either <code class="varname">SITES.file</code> if
                   6862:       defined, else <code class="varname">MASTER_SITES</code> or
                   6863:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6864:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6865:       all except the first and the last can be optionally sorted
                   6866:       by the user, via setting either
                   6867:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6868:       <code class="varname">MASTER_SORT_AWK</code> or
                   6869:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6870: <p> The specific command and arguments used depend on the
                   6871:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6872:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6873: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6874:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6875:       distfiles, if they are freely distributable.  Packages setting
                   6876:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6877:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6878:       mirrored.</p>
                   6879: </div>
                   6880: </div>
1.41      asau     6881: <div class="sect1">
1.1       dsieger  6882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6883: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6884: <p>After the distfile(s) are fetched, their checksum is
                   6885:     generated and compared with the checksums stored in the
                   6886:     distinfo file. If the checksums don't match, the build is
                   6887:     aborted. This is to ensure the same distfile is used for
                   6888:     building, and that the distfile wasn't changed, e.g. by some
                   6889:     malign force, deliberately changed distfiles on the master
                   6890:     distribution site or network lossage.</p>
                   6891: </div>
1.41      asau     6892: <div class="sect1">
1.1       dsieger  6893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6894: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6895: <p>When the distfiles are present on the local system, they
                   6896:     need to be extracted, as they usually come in the form of some
                   6897:     compressed archive format.</p>
                   6898: <p>By default, all <code class="varname">DISTFILES</code> are
                   6899:     extracted. If you only need some of them, you can set the
                   6900:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6901:     files.</p>
                   6902: <p>Extracting the files is usually done by a little
                   6903:     program, <code class="filename">mk/extract/extract</code>, which
                   6904:     already knows how to extract various archive formats, so most
                   6905:     likely you will not need to change anything here. But if you
                   6906:     need, the following variables may help you:</p>
1.41      asau     6907: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6908: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6909: <dd><p>Use these variables to override the default
                   6910:       options for an extract command, which are defined in
                   6911:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6912: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6913: <dd><p>This variable can be set to
1.14      jmcneill 6914:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6915:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6916:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6917:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6918:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6919: </dl></div>
                   6920: <p>If the <code class="filename">extract</code> program doesn't
                   6921:     serve your needs, you can also override the
                   6922:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6923:     command used for extracting the files. This command is
                   6924:     executed in the <code class="filename">${WRKSRC}</code>
                   6925:     directory. During execution of this command, the shell
                   6926:     variable <code class="varname">extract_file</code> holds the absolute
                   6927:     pathname of the file that is going to be extracted.</p>
                   6928: <p>And if that still does not suffice, you can override the
                   6929:     <code class="varname">do-extract</code> target in the package
                   6930:     Makefile.</p>
                   6931: </div>
1.41      asau     6932: <div class="sect1">
1.1       dsieger  6933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6934: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6935: <p>After extraction, all the patches named by the
                   6936:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6937:     subdirectory of the package as well as in
                   6938:     $LOCALPATCHES/$PKGPATH (e.g.
                   6939:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6940:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6941:     <code class="filename">.gz</code> are uncompressed before they are
                   6942:     applied, files ending in <code class="filename">.orig</code> or
                   6943:     <code class="filename">.rej</code> are ignored. Any special options to
1.29      dholland 6944:     <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  6945:     <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 6946: <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  6947:     it fail if the patches apply with some lines of fuzz. Please
                   6948:     fix (regen) the patches so that they apply cleanly. The
                   6949:     rationale behind this is that patches that don't apply cleanly
                   6950:     may end up being applied in the wrong place, and cause severe
                   6951:     harm there.</p>
                   6952: </div>
1.41      asau     6953: <div class="sect1">
1.1       dsieger  6954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6955: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6956: <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  6957:     </p>
                   6958: </div>
1.41      asau     6959: <div class="sect1">
1.1       dsieger  6960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6961: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6962: <p>This phase creates wrapper programs for the compilers and
                   6963:     linkers. The following variables can be used to tweak the
                   6964:     wrappers.</p>
1.41      asau     6965: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6966: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6967: <dd><p>The command used to print progress
                   6968:       messages. Does nothing by default. Set to
                   6969:       <code class="literal">${ECHO}</code> to see the progress
                   6970:       messages.</p></dd>
                   6971: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6972: <dd><p>This variable can be set to
                   6973:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6974:       depending on whether you want additional information in the
                   6975:       wrapper log file.</p></dd>
                   6976: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6977: <dd><p>This variable can be set to
                   6978:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6979:       on whether the wrapper should use its cache, which will
                   6980:       improve the speed. The default value is
                   6981:       <code class="literal">yes</code>, but is forced to
                   6982:       <code class="literal">no</code> if the platform does not support
                   6983:       it.</p></dd>
                   6984: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6985: <dd><p>A list of reordering commands. A reordering
                   6986:       command has the form
                   6987:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6988:       It ensures that that
                   6989:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6990:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6991:       </p></dd>
                   6992: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6993: <dd><p>A list of transformation commands. [TODO:
                   6994:       investigate further]</p></dd>
                   6995: </dl></div>
                   6996: </div>
1.41      asau     6997: <div class="sect1">
1.1       dsieger  6998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6999: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  7000: <p>Most pieces of software need information on the header
                   7001:     files, system calls, and library routines which are available
                   7002:     on the platform they run on. The process of determining this
                   7003:     information is known as configuration, and is usually
                   7004:     automated. In most cases, a script is supplied with the
                   7005:     distfiles, and its invocation results in generation of header
                   7006:     files, Makefiles, etc.</p>
                   7007: <p>If the package contains a configure script, this can be
                   7008:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      7009:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  7010:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      7011:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  7012:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   7013: <pre class="programlisting">
                   7014: .for d in ${CONFIGURE_DIRS}
                   7015:         cd ${WRKSRC} \
                   7016:         &amp;&amp; cd ${d} \
                   7017:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   7018: .endfor
                   7019: </pre>
                   7020: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      7021:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  7022:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   7023:     configure script is run with the environment
                   7024:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7025:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7026:     <code class="varname">CONFIGURE_ENV</code>,
                   7027:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      7028:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  7029:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7030:     package.</p>
1.37      wiz      7031: <p>If the program uses the Perl way of configuration (mainly Perl
                   7032:     modules, but not only), i.e. a file called
                   7033:     <code class="filename">Makefile.PL</code>, it should include
                   7034:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   7035:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   7036:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1       dsieger  7037: <p>If the program uses an <code class="filename">Imakefile</code>
                   7038:     for configuration, the appropriate steps can be invoked by
                   7039:     setting <code class="varname">USE_IMAKE</code> to
1.23      wiz      7040:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
1.1       dsieger  7041:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   7042:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7043:     xmkmf's environment by adding them to the
                   7044:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   7045: <p>If the program uses <code class="filename">cmake</code>
                   7046:     for configuration, the appropriate steps can be invoked by
1.23      wiz      7047:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   7048:     You can add variables to cmake's environment by adding them to the
                   7049:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7050:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7051:     The top directory argument is given by the
                   7052:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      7053:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  7054: <p>If there is no configure step at all, set
1.23      wiz      7055:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  7056: </div>
1.41      asau     7057: <div class="sect1">
1.1       dsieger  7058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7059: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  7060: <p>For building a package, a rough equivalent of the
                   7061:     following code is executed.</p>
                   7062: <pre class="programlisting">
                   7063: .for d in ${BUILD_DIRS}
                   7064:         cd ${WRKSRC} \
                   7065:         &amp;&amp; cd ${d} \
                   7066:         &amp;&amp; env ${MAKE_ENV} \
                   7067:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7068:                 -f ${MAKE_FILE} \
                   7069:                 ${BUILD_TARGET}
                   7070: .endfor
                   7071: </pre>
                   7072: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      7073:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  7074:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7075:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7076:     <code class="varname">MAKE_ENV</code> and arguments
                   7077:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7078:     <code class="varname">MAKE_ENV</code>,
                   7079:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7080:     <code class="varname">MAKE_FILE</code> and
                   7081:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7082:     package.</p>
                   7083: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      7084:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   7085:     <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  7086:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      7087:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   7088:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  7089: <p>If there is no build step at all, set
1.23      wiz      7090:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  7091: </div>
1.41      asau     7092: <div class="sect1">
1.1       dsieger  7093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7094: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  7095: <p>[TODO]</p>
                   7096: </div>
1.41      asau     7097: <div class="sect1">
1.1       dsieger  7098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7099: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  7100: <p>Once the build stage has completed, the final step is to
                   7101:     install the software in public directories, so users can
                   7102:     access the programs and files.</p>
                   7103: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   7104:     equivalent of the following code is executed. Additionally,
                   7105:     before and after this code, much magic is performed to do
                   7106:     consistency checks, registering the package, and so on.</p>
                   7107: <pre class="programlisting">
                   7108: .for d in ${INSTALL_DIRS}
                   7109:         cd ${WRKSRC} \
                   7110:         &amp;&amp; cd ${d} \
                   7111:         &amp;&amp; env ${MAKE_ENV} \
                   7112:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7113:                 -f ${MAKE_FILE} \
                   7114:                 ${INSTALL_TARGET}
                   7115: .endfor
                   7116: </pre>
                   7117: <p>The variable's meanings are analogous to the ones in the
                   7118:     <span class="emphasis"><em>build</em></span> phase.
                   7119:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7120:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      7121:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   7122:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  7123:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7124:     defined.</p>
                   7125: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   7126:     variables are useful. They are all variations of the
1.29      dholland 7127:     <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  7128:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7129:     install command. The specialized variants, together with their
                   7130:     intended use, are:</p>
1.41      asau     7131: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7132: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   7133: <dd><p>directories that contain
                   7134:       binaries</p></dd>
                   7135: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   7136: <dd><p>directories that contain
                   7137:       scripts</p></dd>
                   7138: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   7139: <dd><p>directories that contain shared and static
                   7140:       libraries</p></dd>
                   7141: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   7142: <dd><p>directories that contain data
                   7143:       files</p></dd>
                   7144: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   7145: <dd><p>directories that contain man
                   7146:       pages</p></dd>
                   7147: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   7148: <dd><p>binaries that can be stripped from debugging
                   7149:       symbols</p></dd>
                   7150: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   7151: <dd><p>binaries that cannot be
                   7152:       stripped</p></dd>
                   7153: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   7154: <dd><p>game
                   7155:       binaries</p></dd>
                   7156: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   7157: <dd><p>shared and static
                   7158:       libraries</p></dd>
                   7159: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7160: <dd><p>data files</p></dd>
                   7161: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   7162: <dd><p>data files for
                   7163:       games</p></dd>
                   7164: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7165: <dd><p>man pages</p></dd>
                   7166: </dl></div>
                   7167: <p>Some other variables are:</p>
1.41      asau     7168: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7169: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7170: <dd><p>A list of directories relative to
                   7171:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   7172:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7173:       The package is supposed to create all needed directories itself
                   7174:       before installing files to it and list all other directories here.
                   7175:       </p></dd>
                   7176: </dl></div>
                   7177: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      7178:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  7179:     mostly relevant for packages in the <code class="filename">regress</code>
                   7180:     category.</p>
                   7181: </div>
1.41      asau     7182: <div class="sect1">
1.1       dsieger  7183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7184: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  7185: <p>Once the install stage has completed, a binary package of
                   7186:     the installed files can be built.  These binary packages can be
                   7187:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  7188:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7189:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  7190: <p>By default, the binary packages are created in
                   7191:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7192:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7193:     one for each category in the <code class="varname">CATEGORIES</code>
                   7194:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7195:     <code class="filename">pkgsrc/packages</code>.</p>
                   7196: </div>
1.41      asau     7197: <div class="sect1">
1.1       dsieger  7198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7199: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  7200: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  7201:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  7202:     to clean the work directories of all dependencies too, use
1.10      hubertf  7203:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  7204: </div>
1.41      asau     7205: <div class="sect1">
1.1       dsieger  7206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7207: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41      asau     7208: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7209: <dt><span class="term">pre/post-*</span></dt>
                   7210: <dd><p>For any of the main targets described in the
                   7211:          previous section, two auxiliary targets exist with
1.23      wiz      7212:          <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  7213:          prefix for the main target's name.  These targets are
                   7214:          invoked before and after the main target is called,
                   7215:          allowing extra configuration or installation steps be
                   7216:          performed from a package's Makefile, for example, which
                   7217:          a program's configure script or install target
                   7218:          omitted.</p></dd>
                   7219: <dt><span class="term">do-*</span></dt>
                   7220: <dd><p>Should one of the main targets do the wrong thing,
                   7221:          and should there be no variable to fix this, you can
                   7222:          redefine it with the do-* target.  (Note that redefining
                   7223:          the target itself instead of the do-* target is a bad
                   7224:          idea, as the pre-* and post-* targets won't be called
                   7225:          anymore, etc.) You will not usually need to do
                   7226:          this.</p></dd>
                   7227: <dt><span class="term">reinstall</span></dt>
                   7228: <dd>
1.10      hubertf  7229: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  7230:          you noticed some file was not installed properly, you
                   7231:          can repeat the installation with this target, which will
1.23      wiz      7232:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  7233: <p>This is the default value of
                   7234:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  7235:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  7236:          package</strong></span>, where the defaults are
1.23      wiz      7237:          <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  7238:          respectively.</p>
                   7239: </dd>
                   7240: <dt><span class="term">deinstall</span></dt>
                   7241: <dd>
1.29      dholland 7242: <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  7243:          current directory, effectively de-installing the
                   7244:          package. The following variables can be used to tune the
                   7245:          behaviour:</p>
1.41      asau     7246: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7247: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29      dholland 7248: <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  7249: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7250: <dd><p>Remove all packages that require (depend on)
                   7251:                the given package.  This can be used to remove any
                   7252:                packages that may have been pulled in by a given
1.10      hubertf  7253:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  7254:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7255:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7256:                likely to remove whole KDE. Works by adding
1.29      dholland 7257:                <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  7258:                command line.</p></dd>
                   7259: </dl></div>
                   7260: </dd>
                   7261: <dt><span class="term">bin-install</span></dt>
                   7262: <dd><p>Install a binary package from local disk and via FTP
                   7263:          from a list of sites (see the
                   7264:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  7265:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  7266:          available anywhere.  The arguments given to
1.10      hubertf  7267:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  7268:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7269:          operation, etc.</p></dd>
                   7270: <dt><span class="term">update</span></dt>
                   7271: <dd>
                   7272: <p>This target causes the current package to be
                   7273:          updated to the latest version.  The package and all
                   7274:          depending packages first get de-installed, then current
                   7275:          versions of the corresponding packages get compiled and
                   7276:          installed.  This is similar to manually noting which
                   7277:          packages are currently installed, then performing a
1.10      hubertf  7278:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7279:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  7280:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7281:          packages.</p>
1.23      wiz      7282: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  7283:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  7284:          update</strong></span> was interrupted for some reason.
                   7285:          However, in this case, make sure you don't call
1.10      hubertf  7286:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  7287:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7288:          Otherwise, you lose the ability to automatically update
                   7289:          the current package along with the dependent packages
                   7290:          you have installed.</p>
1.10      hubertf  7291: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  7292:          update</strong></span> will only work as long as the package
                   7293:          tree remains unchanged.  If the source code for one of
                   7294:          the packages to be updated has been changed, resuming
1.10      hubertf  7295:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  7296:          fail!</p>
                   7297: <p>The following variables can be used either on the
1.10      hubertf  7298:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7299:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  7300:          update</strong></span>:</p>
1.41      asau     7301: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7302: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7303: <dd><p>Install target to recursively use for the
                   7304:                updated package and the dependent packages.
                   7305:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      7306:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  7307:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      7308:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7309:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7310:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  7311:                endless loop!</p></dd>
                   7312: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7313: <dd><p>Don't clean up after updating.  Useful if
                   7314:                you want to leave the work sources of the updated
                   7315:                packages around for inspection or other purposes.
                   7316:                Be sure you eventually clean up the source tree
1.23      wiz      7317:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  7318:                or you may run into troubles with old source code
                   7319:                still lying around on your next
1.10      hubertf  7320:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  7321:                update</strong></span>.</p></dd>
                   7322: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7323: <dd><p>Deinstall each package before installing
                   7324:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7325:                may be necessary if the
1.23      wiz      7326:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  7327:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  7328:                update</strong></span>.</p></dd>
                   7329: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7330: <dd><p>Allows you to disable recursion and hardcode
                   7331:                the target for packages.  The default is
1.23      wiz      7332:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  7333:                facilitating a recursive update of prerequisite
                   7334:                packages.  Only set
                   7335:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7336:                disable recursive updates. Use
                   7337:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7338:                set a specific target for each package to be
1.10      hubertf  7339:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  7340:                (see above).</p></dd>
                   7341: </dl></div>
                   7342: </dd>
                   7343: <dt><span class="term">clean-update</span></dt>
                   7344: <dd>
                   7345: <p>Clean the source tree for all packages that would
1.10      hubertf  7346:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  7347:          from the current directory.  This target should not be
                   7348:          used if the current package (or any of its depending
                   7349:          packages) have already been de-installed (e.g., after
1.10      hubertf  7350:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  7351:          some packages you intended to update. As a rule of
                   7352:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  7353:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  7354:          and only if you have a dirty package tree (e.g., if you
                   7355:          used <code class="varname">NOCLEAN</code>).</p>
                   7356: <p>If you are unsure about whether your tree is
1.10      hubertf  7357:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  7358:          clean</strong></span> at the top of the tree, or use the
                   7359:          following sequence of commands from the directory of the
                   7360:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  7361:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  7362:          time, otherwise you lose all the packages you wanted to
                   7363:          update!):</p>
                   7364: <pre class="screen">
                   7365: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7366: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7367: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7368:          </pre>
                   7369: <p>The following variables can be used either on the
1.10      hubertf  7370:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7371:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.41      asau     7372: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  7373: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  7374: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  7375:                reconstruct the list of directories to update for
1.10      hubertf  7376:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  7377:                update</strong></span> successfully installed all
                   7378:                packages you wanted to update.  Normally, this is
1.10      hubertf  7379:                done automatically on <span class="command"><strong>make
1.1       dsieger  7380:                update</strong></span>, but may have been suppressed by
                   7381:                the <code class="varname">NOCLEAN</code> variable (see
                   7382:                above).</p></dd>
                   7383: </dl></div>
                   7384: </dd>
                   7385: <dt><span class="term">replace</span></dt>
                   7386: <dd>
                   7387: <p>Update the installation of the current package.  This
                   7388:          differs from update in that it does not replace dependent
                   7389:          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
                   7390:          target to work.</p>
                   7391: <p><span class="emphasis"><em>Be careful when using this
                   7392:          target!</em></span> There are no guarantees that dependent
                   7393:          packages will still work, in particular they will most
1.10      hubertf  7394:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  7395:          library package whose shared library major version changed
                   7396:          between your installed version and the new one.  For this
                   7397:          reason, this target is not officially supported and only
                   7398:          recommended for advanced users.</p>
                   7399: </dd>
                   7400: <dt><span class="term">info</span></dt>
1.29      dholland 7401: <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  7402:          package. You can use this to check which version of a
                   7403:          package is installed.</p></dd>
                   7404: <dt><span class="term">index</span></dt>
                   7405: <dd>
                   7406: <p>This is a top-level command, i.e. it should be used in
                   7407:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7408:          database of all packages in the local pkgsrc tree, including
                   7409:          dependencies, comment, maintainer, and some other useful
                   7410:          information.  Individual entries are created by running
1.10      hubertf  7411:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  7412:          directories.  This index file is saved as
                   7413:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  7414:          verbose format by running <span class="command"><strong>make
1.1       dsieger  7415:          print-index</strong></span>.  You can search in it with
1.10      hubertf  7416:          <span class="command"><strong>make search
1.1       dsieger  7417:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7418:          extract a list of all packages that depend on a particular
1.10      hubertf  7419:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  7420:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7421: <p>Running this command takes a very long time, some
                   7422:          hours even on fast machines!</p>
                   7423: </dd>
                   7424: <dt><span class="term">readme</span></dt>
                   7425: <dd>
                   7426: <p>This target generates a
                   7427:          <code class="filename">README.html</code> file, which can be
                   7428:          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
                   7429:          contain references to any packages which are in the
                   7430:          <code class="varname">PACKAGES</code> directory on the local
                   7431:          host. The generated files can be made to refer to URLs
                   7432:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7433:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7434:          wanted to generate <code class="filename">README.html</code>
                   7435:          files which pointed to binary packages on the local
                   7436:          machine, in the directory
                   7437:          <code class="filename">/usr/packages</code>, set
                   7438:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7439:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7440:          <code class="varname">${PACKAGES}</code> directory and its
                   7441:          subdirectories will be searched for all the binary
                   7442:          packages.</p>
                   7443: <p>The target can be run at the toplevel or in category
                   7444:          directories, in which case it descends recursively.</p>
                   7445: </dd>
                   7446: <dt><span class="term">readme-all</span></dt>
                   7447: <dd><p>This is a top-level command, run it in
                   7448:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7449:          file <code class="filename">README-all.html</code> which contains a
                   7450:          list of all packages currently available in the NetBSD
                   7451:          Packages Collection, together with the category they belong
                   7452:          to and a short description. This file is compiled from the
                   7453:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  7454:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  7455:          readme</strong></span>.</p></dd>
                   7456: <dt><span class="term">cdrom-readme</span></dt>
                   7457: <dd><p>This is very much the same as the
1.23      wiz      7458:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  7459:          used when generating a pkgsrc tree to be written to a
                   7460:          CD-ROM.  This target also produces
                   7461:          <code class="filename">README.html</code> files, and can be made
                   7462:          to refer to URLs based on
                   7463:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7464:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7465: <dt><span class="term">show-distfiles</span></dt>
                   7466: <dd><p>This target shows which distfiles and patchfiles
                   7467:          are needed to build the package
                   7468:          (<code class="varname">ALLFILES</code>, which contains all
                   7469:          <code class="varname">DISTFILES</code> and
                   7470:          <code class="varname">PATCHFILES</code>, but not
                   7471:          <code class="filename">patches/*</code>).</p></dd>
                   7472: <dt><span class="term">show-downlevel</span></dt>
                   7473: <dd><p>This target shows nothing if the package is not
                   7474:          installed. If a version of this package is installed,
                   7475:          but is not the version provided in this version of
                   7476:          pkgsrc, then a warning message is displayed. This target
                   7477:          can be used to show which of your installed packages are
                   7478:          downlevel, and so the old versions can be deleted, and
                   7479:          the current ones added.</p></dd>
                   7480: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7481: <dd><p>This target shows the directory in the pkgsrc
                   7482:          hierarchy from which the package can be built and
                   7483:          installed. This may not be the same directory as the one
                   7484:          from which the package was installed. This target is
                   7485:          intended to be used by people who may wish to upgrade
                   7486:          many packages on a single host, and can be invoked from
                   7487:          the top-level pkgsrc Makefile by using the
1.23      wiz      7488:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  7489: <dt><span class="term">show-installed-depends</span></dt>
                   7490: <dd><p>This target shows which installed packages match
                   7491:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7492:          if out of date dependencies are causing build
                   7493:          problems.</p></dd>
                   7494: <dt><span class="term">check-shlibs</span></dt>
                   7495: <dd><p>After a package is installed, check all its
                   7496:          binaries and (on ELF platforms) shared libraries to see
                   7497:          if they find the shared libs they need.  Run by default
1.10      hubertf  7498:          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  7499: <dt><span class="term">print-PLIST</span></dt>
                   7500: <dd>
1.23      wiz      7501: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  7502:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  7503:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  7504:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7505:          to care for shared libs etc., but it is
                   7506:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7507:          result before putting it into
                   7508:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7509:          diff the output of this command against an already
                   7510:          existing <code class="filename">PLIST</code> file.</p>
1.29      dholland 7511: <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  7512:          other methods that don't update file access times, be
                   7513:          sure to add these files manually to your
1.23      wiz      7514:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7515:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  7516:          them!</p>
1.23      wiz      7517: <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  7518:          information on this target.</p>
                   7519: </dd>
                   7520: <dt><span class="term">bulk-package</span></dt>
                   7521: <dd>
                   7522: <p>Used to do bulk builds. If an appropriate binary
                   7523:          package already exists, no action is taken. If not, this
                   7524:          target will compile, install and package it (and its
                   7525:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10      hubertf  7526:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7527:          After creating the binary package, the sources, the
                   7528:          just-installed package and its required packages are
                   7529:          removed, preserving free disk space.</p>
                   7530: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7531:          all packages installed on a system!</em></span></p>
                   7532: </dd>
                   7533: <dt><span class="term">bulk-install</span></dt>
                   7534: <dd>
                   7535: <p>Used during bulk-installs to install required
                   7536:          packages. If an up-to-date binary package is available,
1.29      dholland 7537:          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  7538:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  7539:          but the installed binary won't be removed.</p>
                   7540: <p>A binary package is considered
1.23      wiz      7541:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.29      dholland 7542:          <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.41      asau     7543: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7544: <li class="listitem"><p>None of the package's files
1.1       dsieger  7545:              (<code class="filename">Makefile</code>, ...) were modified
                   7546:              since it was built.</p></li>
1.23      wiz      7547: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  7548:              packages were modified since it was built.</p></li>
                   7549: </ul></div>
                   7550: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7551:          all packages installed on a system!</em></span></p>
                   7552: </dd>
                   7553: </dl></div>
                   7554: </div>
                   7555: </div>
1.41      asau     7556: <div class="chapter">
1.1       dsieger  7557: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7558: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7559: <div class="toc">
                   7560: <p><b>Table of Contents</b></p>
                   7561: <dl>
1.6       rillig   7562: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7563: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7564: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7565: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7566: </dl>
                   7567: </div>
                   7568: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7569: by pkgsrc and also for individual packages to define what commands
                   7570: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7571: or for later run-time of an installed packaged (such as
                   7572: <code class="varname">DEPENDS</code>).
                   7573: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7574: package will not be used.</p>
                   7575: <p>When building a package, the replacement tools are
                   7576: made available in a directory (as symlinks or wrapper scripts)
                   7577: that is early in the executable search path. Just like the buildlink
                   7578: system, this helps with consistent builds.</p>
                   7579: <p>A tool may be needed to help build a specific package. For example,
                   7580: perl, GNU make (gmake) or yacc may be needed.</p>
                   7581: <p>Also a tool may be needed, for example, because the native system's supplied
                   7582: tool may be inefficient for building a package with pkgsrc.
                   7583: For example, a package may need GNU awk, bison (instead of
                   7584: yacc) or a better sed.</p>
                   7585: <p>The tools used by a package can be listed by running
1.10      hubertf  7586: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     7587: <div class="sect1">
1.1       dsieger  7588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7589: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7590: <p>The default set of tools used by pkgsrc is defined in
                   7591: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  7592: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7593: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  7594: These can be seen by running:
1.10      hubertf  7595: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  7596: <p>If a package needs a specific program to build
                   7597: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7598: to define the tools needed.</p>
                   7599: </div>
1.41      asau     7600: <div class="sect1">
1.1       dsieger  7601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7602: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      7603: <p>In the following examples, the :run means that it is needed at
                   7604: run-time (and becomes a DEPENDS).
1.1       dsieger  7605: The default is a build dependency which can be set with
                   7606: :build. (So in this example, it is the same as gmake:build
                   7607: and pkg-config:build.)</p>
                   7608: <pre class="programlisting">
                   7609: USE_TOOLS+=     gmake perl:run pkg-config
                   7610: </pre>
                   7611: <p>When using the tools framework, a
                   7612: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7613: which contains the full path to the appropriate tool. For example,
1.23      wiz      7614: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  7615: on Linux systems.</p>
                   7616: <p>If you always need a pkgsrc version of the
                   7617: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7618: </p>
                   7619: </div>
1.41      asau     7620: <div class="sect1">
1.1       dsieger  7621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7622: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7623: <p>When improving or porting pkgsrc to a new platform, have a look
                   7624: at (or create) the corresponding platform specific make file fragment under
                   7625: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7626: the name of the common tools. For example:</p>
                   7627: <pre class="programlisting">
                   7628: .if exists(/usr/bin/bzcat)
                   7629: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7630: .elif exists(/usr/bin/bzip2)
                   7631: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7632: .endif
                   7633: 
                   7634: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7635: </pre>
                   7636: </div>
1.41      asau     7637: <div class="sect1">
1.1       dsieger  7638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7639: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41      asau     7640: <div class="qandaset">
1.47    ! wiz      7641: <a name="idm80445136"></a><dl>
1.6       rillig   7642: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7643: </dt>
1.6       rillig   7644: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7645:        tools?</a>
                   7646: </dt>
1.6       rillig   7647: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7648:        package is using while being built? I want to know whether it
                   7649:        uses sed or not.</a>
                   7650: </dt>
                   7651: </dl>
1.41      asau     7652: <table border="0" style="width: 100%;">
                   7653: <colgroup>
1.1       dsieger  7654: <col align="left" width="1%">
1.23      wiz      7655: <col>
1.41      asau     7656: </colgroup>
1.1       dsieger  7657: <tbody>
1.41      asau     7658: <tr class="question">
1.1       dsieger  7659: <td align="left" valign="top">
1.47    ! wiz      7660: <a name="tools.new"></a><a name="idm80444752"></a><p><b>18.4.1.</b></p>
1.1       dsieger  7661: </td>
                   7662: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7663: </tr>
                   7664: <tr class="answer">
                   7665: <td align="left" valign="top"></td>
                   7666: <td align="left" valign="top"><p>TODO</p></td>
                   7667: </tr>
1.41      asau     7668: <tr class="question">
1.1       dsieger  7669: <td align="left" valign="top">
1.47    ! wiz      7670: <a name="tools.listall"></a><a name="idm80443600"></a><p><b>18.4.2.</b></p>
1.1       dsieger  7671: </td>
                   7672: <td align="left" valign="top"><p>How do I get a list of all available
                   7673:        tools?</p></td>
                   7674: </tr>
                   7675: <tr class="answer">
                   7676: <td align="left" valign="top"></td>
                   7677: <td align="left" valign="top"><p>TODO</p></td>
                   7678: </tr>
1.41      asau     7679: <tr class="question">
1.1       dsieger  7680: <td align="left" valign="top">
1.47    ! wiz      7681: <a name="tools.used"></a><a name="idm80442576"></a><p><b>18.4.3.</b></p>
1.1       dsieger  7682: </td>
                   7683: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7684:        package is using while being built? I want to know whether it
                   7685:        uses sed or not.</p></td>
                   7686: </tr>
                   7687: <tr class="answer">
                   7688: <td align="left" valign="top"></td>
                   7689: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7690:        to do it.)</p></td>
                   7691: </tr>
                   7692: </tbody>
                   7693: </table>
                   7694: </div>
                   7695: </div>
                   7696: </div>
1.41      asau     7697: <div class="chapter">
1.1       dsieger  7698: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7699: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7700: <div class="toc">
                   7701: <p><b>Table of Contents</b></p>
                   7702: <dl>
1.6       rillig   7703: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7704: <dd><dl>
1.6       rillig   7705: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      7706: <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   7707: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7708: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7709: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7710: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7711: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7712: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7713: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7714: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7715: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7716: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7717: </dl></dd>
1.23      wiz      7718: <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   7719: <dd><dl>
                   7720: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7721: <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>
                   7722: </dl></dd>
1.23      wiz      7723: <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   7724: <dd><dl>
                   7725: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7726: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7727: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7728: </dl></dd>
                   7729: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7730: <dd><dl>
                   7731: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7732: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7733: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz      7734: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   7735: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   7736: </dl></dd>
1.23      wiz      7737: <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   7738: <dd><dl>
                   7739: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7740: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      7741: <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   7742: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7743: </dl></dd>
1.23      wiz      7744: <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   7745: <dd><dl>
                   7746: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7747: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7748: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7749: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7750: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7751: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7752: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7753: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7754: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      7755: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   7756: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7757: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7758: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7759: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7760: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7761: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7762: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7763: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7764:     emulation</a></span></dt>
1.6       rillig   7765: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7766: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7767: </dl></dd>
1.6       rillig   7768: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7769: </dl>
                   7770: </div>
1.41      asau     7771: <div class="sect1">
1.1       dsieger  7772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7773: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41      asau     7774: <div class="sect2">
1.1       dsieger  7775: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7776: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7777: <p>One appealing feature of pkgsrc is that it runs on many
                   7778:     different platforms. As a result, it is important to ensure,
                   7779:     where possible, that packages in pkgsrc are portable. This
                   7780:     chapter mentions some particular details you should pay
                   7781:     attention to while working on pkgsrc.</p>
                   7782: </div>
1.41      asau     7783: <div class="sect2">
1.1       dsieger  7784: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  7785: <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  7786: </h3></div></div></div>
                   7787: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7788:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7789:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7790:     want to use those variables in the preprocessor directives of
1.29      dholland 7791:     <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  7792:     <code class="literal">.for</code>), you need to include the file
                   7793:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7794:     loads the user preferences.</p>
                   7795: <p>But note that some variables may not be completely defined
                   7796:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7797:     included, as they may contain references to variables that are
                   7798:     not yet defined. In shell commands this is no problem, since
                   7799:     variables are actually macros, which are only expanded when they
                   7800:     are used. But in the preprocessor directives mentioned above and
                   7801:     in dependency lines (of the form <code class="literal">target:
                   7802:     dependencies</code>) the variables are expanded at load
                   7803:     time.</p>
1.41      asau     7804: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7805: <h3 class="title">Note</h3>
                   7806: <p>Currently there is no exhaustive list of all
                   7807:     variables that tells you whether they can be used at load time
                   7808:     or only at run time, but it is in preparation.</p>
                   7809: </div>
                   7810: </div>
1.41      asau     7811: <div class="sect2">
1.1       dsieger  7812: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7813: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7814: <p>Occasionally, packages require interaction from the user,
                   7815:     and this can be in a number of ways:</p>
1.41      asau     7816: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7817: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7818:        interaction such as entering username/password or accepting a
                   7819:        license on a web page.</p></li>
1.23      wiz      7820: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7821:        passwords.</p></li>
1.23      wiz      7822: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7823: <li class="listitem"><p>help during the build process</p></li>
                   7824: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7825: </ul></div>
                   7826: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7827:     provided to notify the pkgsrc mechanism of an interactive stage
                   7828:     which will be needed, and this should be set in the package's
                   7829:     <code class="filename">Makefile</code>, e.g.:</p>
                   7830: <pre class="programlisting">
                   7831: INTERACTIVE_STAGE=      build
                   7832:     </pre>
                   7833: <p>Multiple interactive stages can be specified:</p>
                   7834: <pre class="programlisting">
                   7835: INTERACTIVE_STAGE=      configure install
                   7836:     </pre>
                   7837: <p>The user can then decide to skip this package by setting the
                   7838:     <code class="varname">BATCH</code> variable.</p>
                   7839: </div>
1.41      asau     7840: <div class="sect2">
1.1       dsieger  7841: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7842: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7843: <p>Authors of software can choose the licence under which
                   7844:     software can be copied.  This is due to copyright law, and reasons
                   7845:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7846:     system recognizes that there are a number of licenses which some
                   7847:     users may find objectionable or difficult or impossible to comply
                   7848:     with.  The Free Software Foundation has declared some licenses
                   7849:     "Free", and the Open Source Initiative has a definition of "Open
                   7850:     Source".  The pkgsrc system, as a policy choice, does not label
                   7851:     packages which have licenses that are Free or Open Source.
                   7852:     However, packages without a license meeting either of those tests
                   7853:     are labeled with a license tag denoting the license.  Note that a
                   7854:     package with no license to copy trivially does not meet either the
                   7855:     Free or Open Source test.</p>
                   7856: <p>For packages which are not Free or Open Source, pkgsrc will
                   7857:     not build the package unless the user has indicated to pkgsrc that
                   7858:     packages with that particular license may be built.  Note that
                   7859:     this documentation avoids the term "accepted the license".  The
                   7860:     pkgsrc system is merely providing a mechanism to avoid
                   7861:     accidentally building a package with a non-free license;
                   7862:     judgement and responsibility remain with the user.  (Installation
                   7863:     of binary packages are not currently subject to this mechanism;
                   7864:     this is a bug.)</p>
                   7865: <p>One might want to only install packages with a BSD license,
1.19      jnemeth  7866:     or the GPL, and not the other.  The free licenses are added to the 
                   7867:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7868:     user can override the default by setting the
                   7869:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7870:     of "+=".  The licenses accepted by default are:
                   7871:     </p>
                   7872: <pre class="programlisting">
1.32      wiz      7873:         public-domain unlicense
                   7874:         gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7875:         gnu-gpl-v1
                   7876:         gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7877:         gnu-gpl-v3 gnu-lgpl-v3
                   7878:         original-bsd modified-bsd 2-clause-bsd
                   7879:         x11 mit miros
                   7880:         apache-1.1 apache-2.0
                   7881:         artistic artistic-2.0
                   7882:         cddl-1.0
                   7883:         cpl-1.0
                   7884:         open-font-license
                   7885:         mpl-1.0 mpl-1.1 mpl-2.0
                   7886:         php png-license
                   7887:         postgresql-license
                   7888:         zlib
                   7889:         zpl
                   7890:         python-software-foundation
                   7891:         ipafont
                   7892:         ibm-public-license-1.0
                   7893:         isc
                   7894:         boost-license
                   7895:         mplusfont
                   7896:         cc-by-sa-v3.0
                   7897:         lppl-1.3c
                   7898:         lucent
                   7899:         epl-v1.0
                   7900:        info-zip
1.19      jnemeth  7901:     </pre>
                   7902: <p>
                   7903:     </p>
1.1       dsieger  7904: <p>The license tag mechanism is intended to address
                   7905:     copyright-related issues surrounding building, installing and
                   7906:     using a package, and not to address redistribution issues (see
                   7907:     <code class="varname">RESTRICTED</code> and
1.19      jnemeth  7908:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7909:     Packages with redistribution restrictions should set these
                   7910:     tags.</p>
1.1       dsieger  7911: <p>Denoting that a package may be copied according to a
                   7912:     particular license is done by placing the license in
                   7913:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7914:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7915:     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>
                   7916: <pre class="programlisting">
                   7917: LICENSE=        xv-license
                   7918:     </pre>
                   7919: <p>When trying to build, the user will get a notice that the
                   7920:     package is covered by a license which has not been placed in the
                   7921:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7922: <pre class="programlisting">
                   7923: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7924: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7925: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7926: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7927: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7928: *** Error code 1
                   7929:     </pre>
1.10      hubertf  7930: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7931:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7932:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7933:     convey to pkgsrc that it should not in the future fail because of
                   7934:     that license:</p>
                   7935: <pre class="programlisting">
                   7936: ACCEPTABLE_LICENSES+=xv-license
                   7937:     </pre>
                   7938: <p>When adding a package with a new license, the license text
                   7939:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7940:     displaying.  A list of known licenses can be seen in this
                   7941:     directory.</p>
                   7942: <p>When the license changes (in a way other than formatting),
                   7943:     please make sure that the new license has a different name (e.g.,
                   7944:     append the version number if it exists, or the date).  Just
                   7945:     because a user told pkgsrc to build programs under a previous
                   7946:     version of a license does not mean that pkgsrc should build
                   7947:     programs under the new licenses.  The higher-level point is that
                   7948:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7949:     test is a mechanistic test of whether a particular text has been
                   7950:     approved by either of two bodies.</p>
                   7951: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7952:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7953:     is deprecated because it does not crisply refer to a particular
                   7954:     license text.  Another problem with such usage is that it does not
                   7955:     enable a user to tell pkgsrc to proceed for a single package
                   7956:     without also telling pkgsrc to proceed for all packages with that
                   7957:     tag.</p>
                   7958: </div>
1.41      asau     7959: <div class="sect2">
1.1       dsieger  7960: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7961: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7962: <p>Some licenses restrict how software may be re-distributed.
                   7963:     Because a license tag is required unless the package is Free or
                   7964:     Open Source, all packages with restrictions should have license
                   7965:     tags.  By declaring the restrictions, package tools can
                   7966:     automatically refrain from e.g. placing binary packages on FTP
                   7967:     sites.</p>
                   7968: <p>There are four restrictions that may be encoded, which are
                   7969:     the cross product of sources (distfiles) and binaries not being
                   7970:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7971:     language in any license, and because non-Free licenses tend to be
                   7972:     different from each other, pkgsrc adopts a definition of FTP and
                   7973:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7974:     should not be made available over the Internet at no charge.
                   7975:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7976:     made available on some kind of media, together with other source
                   7977:     and binary packages, and which is sold for a distribution charge.
                   7978:     </p>
                   7979: <p>In order to encode these restrictions, the package system
                   7980:     defines five make variables that can be set to note these
                   7981:     restrictions:</p>
1.41      asau     7982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7983: <li class="listitem">
1.1       dsieger  7984: <p><code class="varname">RESTRICTED</code></p>
                   7985: <p>This variable should be set whenever a restriction
                   7986:        exists (regardless of its kind).  Set this variable to a
                   7987:        string containing the reason for the restriction.  It should
                   7988:        be understood that those wanting to understand the restriction
                   7989:        will have to read the license, and perhaps seek advice of
                   7990:        counsel.</p>
                   7991: </li>
1.23      wiz      7992: <li class="listitem">
1.1       dsieger  7993: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7994: <p>Binaries may not be placed on CD-ROM containing other
                   7995:        binary packages, for which a distribution charge may be made.
                   7996:        In this case, set this variable to
                   7997:        <code class="varname">${RESTRICTED}</code>.</p>
                   7998: </li>
1.23      wiz      7999: <li class="listitem">
1.1       dsieger  8000: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   8001: <p>Binaries may not made available on the Internet without
                   8002:        charge.  In this case, set this variable to
                   8003:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   8004:        binary packages will not be included on ftp.NetBSD.org.</p>
                   8005: </li>
1.23      wiz      8006: <li class="listitem">
1.1       dsieger  8007: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   8008: <p>Distfiles may not be placed on CD-ROM, together with
                   8009:        other distfiles, for which a fee may be charged.  In this
                   8010:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   8011:        </p>
                   8012: </li>
1.23      wiz      8013: <li class="listitem">
1.1       dsieger  8014: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   8015: <p>Distfiles may not made available via FTP at no charge.
                   8016:        In this case, set this variable to
                   8017:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   8018:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   8019: </li>
                   8020: </ul></div>
1.32      wiz      8021: <p>Please note that packages will to be removed from pkgsrc
                   8022:     when the distfiles are not distributable and cannot be obtained
                   8023:     for a period of one full quarter branch. Packages with manual /
                   8024:     interactive fetch must have a maintainer and it is his/her
                   8025:     responsibility to ensure this.</p>
1.1       dsieger  8026: </div>
1.41      asau     8027: <div class="sect2">
1.1       dsieger  8028: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8029: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  8030: <p>Your package may depend on some other package being present
                   8031:     - and there are various ways of expressing this dependency.
                   8032:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   8033:     <code class="varname">DEPENDS</code> definitions, the
                   8034:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   8035:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   8036:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  8037:     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  8038: <p>The basic difference between the two variables is as
                   8039:     follows: The <code class="varname">DEPENDS</code> definition registers
                   8040:     that pre-requisite in the binary package so it will be pulled in
                   8041:     when the binary package is later installed, whilst the
                   8042:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   8043:     dependency that is only needed for building the package.</p>
                   8044: <p>This means that if you only need a package present whilst
                   8045:     you are building, it should be noted as a
                   8046:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   8047: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   8048:     <code class="varname">DEPENDS</code> definition is:</p>
                   8049: <pre class="programlisting">
                   8050: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   8051:     </pre>
1.23      wiz      8052: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  8053:     may include any of the wildcard version numbers recognized by
1.29      dholland 8054:     <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      8055: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8056: <li class="listitem">
1.1       dsieger  8057: <p>If your package needs another package's binaries or
                   8058:        libraries to build or run, and if that package has a
                   8059:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   8060: <pre class="programlisting">
                   8061: .include "../../graphics/jpeg/buildlink3.mk"
                   8062:        </pre>
                   8063: </li>
1.23      wiz      8064: <li class="listitem">
1.25      spz      8065: <p>If your package needs binaries from another package to build,
                   8066:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1       dsieger  8067: <pre class="programlisting">
1.25      spz      8068: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1       dsieger  8069:        </pre>
                   8070: </li>
1.25      spz      8071: <li class="listitem"><p>If your package needs a library with which to link and
                   8072:        there is no <code class="filename">buildlink3.mk</code> file
                   8073:        available, create one. Using
                   8074:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   8075:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      8076: <li class="listitem">
1.25      spz      8077: <p>If your package needs some executable to be able to run
                   8078:        correctly and if there's no
                   8079:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8080:        using the <code class="varname">DEPENDS</code> variable. The
                   8081:        <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
                   8082:        be able to execute the latex binary from the teTeX package
                   8083:        when it runs, and that is specified:</p>
1.1       dsieger  8084: <pre class="programlisting">
1.25      spz      8085: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.1       dsieger  8086:        </pre>
1.25      spz      8087: </li>
                   8088: <li class="listitem">
                   8089: <p>You can use wildcards in package dependencies. Note that
                   8090:        such wildcard dependencies are retained when creating binary
                   8091:        packages. The dependency is checked when installing the binary
                   8092:        package and any package which matches the pattern will be
                   8093:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      8094: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   8095:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   8096:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   8097:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  8098: <p>Wildcards can also be used to specify that a package
                   8099:        will only build against a certain minimum version of a
                   8100:        pre-requisite:</p>
                   8101: <pre class="programlisting">
1.25      spz      8102: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.1       dsieger  8103:        </pre>
1.25      spz      8104: <p>This means that the package will build using version 6.0
                   8105:        of ImageMagick or newer. Such a dependency may be warranted
                   8106:        if, for example, the command line options of an executable
                   8107:        have changed.</p>
                   8108: <p>If you need to depend on minimum versions of libraries,
                   8109:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  8110: <p>For security fixes, please update the package
1.10      hubertf  8111:        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  8112:        information.</p>
                   8113: </li>
                   8114: </ol></div>
                   8115: <p>If your package needs files from another package to build,
                   8116:     add the relevant distribution files to
                   8117:     <code class="varname">DISTFILES</code>, so they will be extracted
                   8118:     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.
                   8119:     (It relies on the jpeg sources being present in source form
                   8120:     during the build.)</p>
                   8121: </div>
1.41      asau     8122: <div class="sect2">
1.1       dsieger  8123: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8124: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  8125: <p>Your package may conflict with other packages a user might
                   8126:     already have installed on his system, e.g. if your package
                   8127:     installs the same set of files as another package in the pkgsrc
                   8128:     tree.</p>
                   8129: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   8130:     space-separated list of packages (including version string) your
                   8131:     package conflicts with.</p>
                   8132: <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>
                   8133:     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>
                   8134:     install the same shared library, thus you set in
                   8135:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8136: <pre class="programlisting">
                   8137: CONFLICTS=      Xaw-Xpm-[0-9]*
                   8138:     </pre>
                   8139: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   8140: <pre class="programlisting">
                   8141: CONFLICTS=      Xaw3d-[0-9]*
                   8142:     </pre>
                   8143: <p>Packages will automatically conflict with other packages
                   8144:     with the name prefix and a different version
1.23      wiz      8145:     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
                   8146:     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
1.1       dsieger  8147: </div>
1.41      asau     8148: <div class="sect2">
1.1       dsieger  8149: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8150: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  8151: <p>There are several reasons why a package might be
                   8152:     instructed to not build under certain circumstances.  If the
                   8153:     package builds and runs on most platforms, the exceptions
                   8154:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8155:     the package builds and runs on a small handful of platforms,
                   8156:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8157:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8158:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8159:     (OS-version-platform) that can use glob-style
                   8160:     wildcards.</p>
                   8161: <p>Some packages are tightly bound to a specific version of an
                   8162:     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
                   8163:     backwards compatible with other versions of the OS, and should be
                   8164:     uploaded to a version specific directory on the FTP server.  Mark
                   8165:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      8166:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  8167:     the package system internals, but may be used in the
                   8168:     future.</p>
                   8169: <p>If the package should be skipped (for example, because it
                   8170:     provides functionality already provided by the system), set
                   8171:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8172:     the package should fail because some preconditions are not met,
                   8173:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   8174:     message.</p>
                   8175: </div>
1.41      asau     8176: <div class="sect2">
1.1       dsieger  8177: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8178: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  8179: <p>To ensure that a package may not be deleted, once it has been
                   8180:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8181:     be set in the package Makefile. This will be carried into any
                   8182:     binary package that is made from this pkgsrc entry. A
1.23      wiz      8183:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.29      dholland 8184:     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      8185:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  8186: </div>
1.41      asau     8187: <div class="sect2">
1.1       dsieger  8188: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8189: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  8190: <p>When a vulnerability is found, this should be noted in
                   8191:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      8192:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   8193:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  8194: <p>After fixing the vulnerability by a patch, its
1.31      wiz      8195:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8196:     course not necessary if the problem is fixed by using a newer
                   8197:     release of the software), and the pattern in the
                   8198:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  8199: <p>Also, if the fix should be applied to the stable pkgsrc
                   8200:     branch, be sure to submit a pullup request!</p>
                   8201: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8202:     semi-automatically by a weekly cron job.</p>
                   8203: </div>
1.41      asau     8204: <div class="sect2">
1.1       dsieger  8205: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8206: <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  8207: <p>When making fixes to an existing package it can be useful
                   8208:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8209:     avoid conflicting with future versions by the original author, a
1.23      wiz      8210:     <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  8211:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      8212:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8213:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  8214: <pre class="programlisting">
                   8215: DISTNAME=       foo-17.42
                   8216: PKGREVISION=    9
                   8217:     </pre>
                   8218: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      8219:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8220:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  8221:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8222:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8223: <p>When a new release of the package is released, the
                   8224:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8225:     minor release of the above package, things should be like:</p>
                   8226: <pre class="programlisting">
                   8227: DISTNAME=       foo-17.43
                   8228:     </pre>
                   8229: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8230:     non-trivial change in the resulting binary package.  Without a
                   8231:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8232:     version installed has no way of knowing that their package is out
                   8233:     of date.  Thus, changes without increasing
                   8234:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8235:     trivial that no reasonable person would want to upgrade", and this
                   8236:     is the rough test for when increasing
                   8237:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8238:     changes that do not merit increasing
                   8239:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     8240: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8241: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 8242:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  8243:       or comments in Makefile.</p></li>
1.23      wiz      8244: <li class="listitem"><p>
1.1       dsieger  8245:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      8246: <li class="listitem"><p>
1.1       dsieger  8247:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      8248: <li class="listitem"><p>
1.1       dsieger  8249:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8250: </ul></div>
                   8251: <p>Examples of changes that do merit an increase to
                   8252:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     8253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8254: <li class="listitem"><p>
1.1       dsieger  8255:       Security fixes</p></li>
1.23      wiz      8256: <li class="listitem"><p>
1.1       dsieger  8257:       Changes or additions to a patch file</p></li>
1.23      wiz      8258: <li class="listitem"><p>
1.1       dsieger  8259:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      8260: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  8261: </ul></div>
                   8262: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8263:     changes.</p>
                   8264: </div>
1.41      asau     8265: <div class="sect2">
1.1       dsieger  8266: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8267: <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  8268: <p>When you want to replace the same text in multiple files
                   8269:     or when the replacement text varies, patches alone cannot help.
                   8270:     This is where the SUBST framework comes in. It provides an
                   8271:     easy-to-use interface for replacing text in files.
                   8272:     Example:</p>
                   8273: <pre class="programlisting">
                   8274: SUBST_CLASSES+=                 fix-paths
                   8275: SUBST_STAGE.fix-paths=          pre-configure
                   8276: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8277: SUBST_FILES.fix-paths=          src/*.c
                   8278: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8279: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8280: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8281:     </pre>
                   8282: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8283:     that are used to identify the different SUBST blocks that are
                   8284:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8285:     important to always use the <code class="literal">+=</code> operator with
                   8286:     this variable. Otherwise some substitutions may be
                   8287:     skipped.</p>
                   8288: <p>The remaining variables of each SUBST block are
                   8289:     parameterized with the identifier from the first line
                   8290:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8291:     parameters to a function call.</p>
                   8292: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8293:     which the replacement will take place. All combinations of
                   8294:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8295:     <code class="literal">post-</code> together with a phase name are
                   8296:     possible, though only few are actually used. Most commonly used
                   8297:     are <code class="literal">post-patch</code> and
                   8298:     <code class="literal">pre-configure</code>. Of these two,
                   8299:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  8300:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  8301:     have the state after applying the patches but before making any
                   8302:     other changes. This is especially useful when you are debugging
                   8303:     a package in order to create new patches for it. Similarly,
                   8304:     <code class="literal">post-build</code> is preferred over
                   8305:     <code class="literal">pre-install</code>, because the install phase should
                   8306:     generally be kept as simple as possible. When you use
                   8307:     <code class="literal">post-build</code>, you have the same files in the
                   8308:     working directory that will be installed later, so you can check
                   8309:     if the substitution has succeeded.</p>
                   8310: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8311:     that is printed just before the substitution is done.</p>
                   8312: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8313:     globbing patterns that specifies the files in which the
                   8314:     substitution will take place. The patterns are interpreted
                   8315:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8316: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29      dholland 8317:     <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  8318:     command should be prefixed with <code class="literal">-e</code>, so that
                   8319:     all SUBST blocks look uniform.</p>
                   8320: <p>There are some more variables, but they are so seldomly
                   8321:     used that they are only documented in the
                   8322:     <code class="filename">mk/subst.mk</code> file.</p>
                   8323: </div>
                   8324: </div>
1.41      asau     8325: <div class="sect1">
1.1       dsieger  8326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8327: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     8328: <div class="sect2">
1.1       dsieger  8329: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8330: <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  8331: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8332:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8333:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8334:     with the name of each file to download as an argument, expecting
                   8335:     it to output the URL of the directory from which to download
                   8336:     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
                   8337:     example of this usage.</p>
                   8338: <p>If the download can't be automated, because the user must
                   8339:     submit personal information to apply for a password, or must pay
                   8340:     for the source, or whatever, you can set
                   8341:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8342:     displayed to the user before aborting the build. Example:</p>
                   8343: <pre class="programlisting">
                   8344: FETCH_MESSAGE=  "Please download the files"
                   8345: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8346: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8347:     </pre>
                   8348: </div>
1.41      asau     8349: <div class="sect2">
1.1       dsieger  8350: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8351: <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  8352: <p>Sometimes authors of a software package make some
                   8353:     modifications after the software was released, and they put up a
                   8354:     new distfile without changing the package's version number. If a
                   8355:     package is already in pkgsrc at that time, the checksum will
                   8356:     no longer match. The contents of the new distfile should be
                   8357:     compared against the old one before changing anything, to make
                   8358:     sure the distfile was really updated on purpose, and that
                   8359:     no trojan horse or so crept in.
                   8360:     Please mention that the distfiles were compared and what was found
                   8361:     in your commit message.
                   8362:     Then, the correct way to work around this is to
                   8363:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8364:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8365:     <code class="varname">DISTFILES</code> and
                   8366:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8367:     subdirectory of the local distfiles directory.
1.10      hubertf  8368:     (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  8369:     In case this
                   8370:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8371:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8372:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8373:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8374:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8375:     path in the filenames.
                   8376:     Also increase the PKGREVISION if the installed package is different.
                   8377:     Furthermore, a mail to the package's authors seems appropriate
                   8378:     telling them that changing distfiles after releases without
                   8379:     changing the file names is not good practice.</p>
                   8380: </div>
                   8381: </div>
1.41      asau     8382: <div class="sect1">
1.1       dsieger  8383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8384: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     8385: <div class="sect2">
1.1       dsieger  8386: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8387: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8388: <p>pkgsrc supports many different machines, with different
                   8389:     object formats like a.out and ELF, and varying abilities to do
                   8390:     shared library and dynamic loading at all. To accompany this,
                   8391:     varying commands and options have to be passed to the
                   8392:     compiler, linker, etc. to get the Right Thing, which can be
                   8393:     pretty annoying especially if you don't have all the machines
                   8394:     at your hand to test things.  The
                   8395:     <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      8396:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8397:     both static and dynamic libraries from a set of source files,
                   8398:     thus being platform-independent.</p>
                   8399: <p>Here's how to use libtool in a package in seven simple
                   8400:     steps:</p>
1.23      wiz      8401: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8402: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8403:        Makefile.</p></li>
1.23      wiz      8404: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8405:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8406:        add it to the definition of <code class="varname">CC</code>, if only
                   8407:        libraries are being built in a given Makefile. This one command
                   8408:        will build both PIC and non-PIC library objects, so you need not
                   8409:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8410: <li class="listitem">
1.1       dsieger  8411: <p>For the linking of the library, remove any
1.23      wiz      8412:        <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
                   8413:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8414: <pre class="programlisting">
                   8415: ${LIBTOOL} --mode=link \
                   8416:     ${CC} -o ${.TARGET:.a=.la} \
                   8417:         ${OBJS:.o=.lo} \
                   8418:         -rpath ${PREFIX}/lib \
                   8419:         -version-info major:minor
                   8420:        </pre>
                   8421: <p>Note that the library is changed to have a
                   8422:        <code class="filename">.la</code> extension, and the objects are
                   8423:        changed to have a <code class="filename">.lo</code>
                   8424:        extension. Change <code class="varname">OBJS</code> as
                   8425:        necessary. This automatically creates all of the
                   8426:        <code class="filename">.a</code>,
                   8427:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8428:        necessary) in the build directory. Be sure to include
1.23      wiz      8429:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8430:        minor are zero, as libtool will otherwise strip off the
                   8431:        shared library version.</p>
                   8432: <p>From the libtool manual:</p>
                   8433: <pre class="programlisting">
                   8434: So, libtool library versions are described by three integers:
                   8435: 
                   8436: CURRENT
                   8437: The most recent interface number that this library implements.
                   8438: 
                   8439: REVISION
                   8440: The implementation number of the CURRENT interface.
                   8441: 
                   8442: AGE
                   8443: The difference between the newest and oldest interfaces that
                   8444: this library implements.  In other words, the library implements
                   8445: all the interface numbers in the range from number `CURRENT -
                   8446: AGE' to `CURRENT'.
                   8447: 
                   8448: If two libraries have identical CURRENT and AGE numbers, then the
                   8449: dynamic linker chooses the library with the greater REVISION number.
                   8450:        </pre>
1.23      wiz      8451: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8452:        different results for a.out and ELF (excluding symlinks)
                   8453:        in only one case. An ELF library of the form
1.23      wiz      8454:        <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  8455:        will have a symlink of
1.23      wiz      8456:        <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  8457:        on an a.out platform. This is handled
                   8458:        automatically.</p>
1.23      wiz      8459: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8460:        directory of the library being built.</p>
                   8461: <p>In the <code class="filename">PLIST</code>, include only the
                   8462:        <code class="filename">.la</code> file, the other files will be
                   8463:        added automatically.</p>
                   8464: </li>
1.23      wiz      8465: <li class="listitem">
1.1       dsieger  8466: <p>When linking shared object (<code class="filename">.so</code>)
1.29      dholland 8467:        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      8468:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8469:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8470:        tacked on.</p>
                   8471: <p>The <code class="filename">PLIST</code> file gets the
                   8472:        <code class="filename">foo.so</code> entry.</p>
                   8473: </li>
1.23      wiz      8474: <li class="listitem">
1.1       dsieger  8475: <p>When linking programs that depend on these libraries
                   8476:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.29      dholland 8477:        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      8478:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8479:        libraries (static or shared), but please be aware that
                   8480:        libtool will not allow you to specify a relative path in
1.23      wiz      8481:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8482:        expects you to change that argument to be the
                   8483:        <code class="filename">.la</code> file. e.g.</p>
                   8484: <pre class="programlisting">
                   8485: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8486:        </pre>
                   8487: <p>should be changed to:</p>
                   8488: <pre class="programlisting">
                   8489: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8490:        </pre>
                   8491: <p>and it will do the right thing with the libraries.</p>
                   8492: </li>
1.23      wiz      8493: <li class="listitem">
1.29      dholland 8494: <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>
                   8495:        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      8496:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8497:        <code class="filename">.la</code>. e.g.</p>
                   8498: <pre class="programlisting">
1.22      jakllsch 8499: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1       dsieger  8500:        </pre>
                   8501: <p>This will install the static <code class="filename">.a</code>,
                   8502:        shared library, any needed symlinks, and run
1.29      dholland 8503:        <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  8504: </li>
1.23      wiz      8505: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8506:        the <code class="filename">.la</code>
                   8507:        file (this is a change from previous behaviour).</p></li>
                   8508: </ol></div>
                   8509: </div>
1.41      asau     8510: <div class="sect2">
1.1       dsieger  8511: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8512: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8513: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8514:     package Makefile. This will override the package's own libtool
                   8515:     in most cases.  For older libtool using packages,  libtool is
                   8516:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8517:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8518:     configure; find work*/ -name libtool</strong></span>.</p>
                   8519: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8520:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8521:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8522:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8523:     package's libtool script(s), set it as appropriate.</p>
                   8524: <p>If you do not need <code class="filename">*.a</code> static
                   8525:     libraries built and installed, then use
                   8526:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8527: <p>If your package makes use of the platform-independent library
                   8528:     for loading dynamic shared objects, that comes with libtool
                   8529:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8530: <p>Some packages use libtool incorrectly so that the package
                   8531:     may not work or build in some circumstances. Some of the more
                   8532:     common errors are:</p>
1.41      asau     8533: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8534: <li class="listitem">
1.1       dsieger  8535: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8536:        executable or library. This in itself isn't a problem if one of two things
                   8537:        has been done:</p>
1.23      wiz      8538: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8539: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8540:            <code class="filename">libfoo.la</code>, not
                   8541:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8542: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8543: </ol></div>
                   8544: </li>
1.23      wiz      8545: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8546:        The function lt_dlinit() should be called and the macro
                   8547:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8548:        executables.</p></li>
                   8549: </ul></div>
                   8550: </div>
1.41      asau     8551: <div class="sect2">
1.1       dsieger  8552: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8553: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8554: <p>If a package needs GNU autoconf or automake to be executed
                   8555:     to regenerate the configure script and Makefile.in makefile
                   8556:     templates, then they should be executed in a pre-configure
                   8557:     target.</p>
                   8558: <p>For packages that need only autoconf:</p>
                   8559: <pre class="programlisting">
                   8560: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8561: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8562: ...
                   8563: 
                   8564: pre-configure:
                   8565:         cd ${WRKSRC} &amp;&amp; autoconf
                   8566: 
                   8567: ...
                   8568:     </pre>
                   8569: <p>and for packages that need automake and autoconf:</p>
                   8570: <pre class="programlisting">
                   8571: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8572: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8573: ...
                   8574: 
                   8575: pre-configure:
                   8576:         set -e; cd ${WRKSRC}; \
                   8577:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8578: 
                   8579: ...
                   8580:     </pre>
                   8581: <p>Packages which use GNU Automake will almost certainly
                   8582:     require GNU Make.</p>
                   8583: <p>There are times when the configure process makes
                   8584:     additional changes to the generated files, which then causes
                   8585:     the build process to try to re-execute the automake sequence.
                   8586:     This is prevented by touching various files in the configure
                   8587:     stage. If this causes problems with your package you can set
                   8588:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8589:     Makefile.</p>
                   8590: </div>
                   8591: </div>
1.41      asau     8592: <div class="sect1">
1.1       dsieger  8593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8594: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41      asau     8595: <div class="sect2">
1.1       dsieger  8596: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8597: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8598: <p>Compilers for the C, C++, and Fortran languages comes with
                   8599:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8600:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  8601:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8602: <p>To declare which language's compiler a package needs, set
                   8603:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      8604:     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
                   8605:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8606:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8607:     written in C++, usually need a C compiler for the configure
                   8608:     phase.</p>
                   8609: </div>
1.41      asau     8610: <div class="sect2">
1.1       dsieger  8611: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8612: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8613: <p>If a program is written in Java, use the Java framework in
                   8614:     pkgsrc.  The package must include
                   8615:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8616:     provides the following variables:</p>
1.41      asau     8617: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8618: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8619:       dependency on the JDK is added.  If
1.23      wiz      8620:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8621:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8622:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8623:       JDK.</p></li>
1.23      wiz      8624: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8625:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8626:       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
                   8627:       <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
                   8628:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8629:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8630:       above. This variable is not set by default.</p></li>
1.24      wiz      8631: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8632:       automatically set to the runtime location of the used Java
                   8633:       implementation dependency. It may be used to set
                   8634:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8635:       needs this variable to be defined.
                   8636:       </p></li>
1.1       dsieger  8637: </ul></div>
                   8638: </div>
1.41      asau     8639: <div class="sect2">
1.1       dsieger  8640: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8641: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8642: <p>If your package contains interpreted perl scripts, add
1.23      wiz      8643:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8644:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8645:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8646:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8647:     that you want adjusted.  Every occurrence of
                   8648:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8649:     path to the perl executable.</p>
                   8650: <p>If a particular version of perl is needed, set the
                   8651:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8652:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.10      hubertf  8653: <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  8654:     about handling perl modules.</p>
                   8655: </div>
1.41      asau     8656: <div class="sect2">
1.1       dsieger  8657: <div class="titlepage"><div><div><h3 class="title">
1.40      wiz      8658: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   8659: <p><code class="varname">REPLACE_SH</code>,
                   8660:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8661:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   8662:     hash bangs in files. Please use the appropriate one, prefering
                   8663:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
                   8664:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8665:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8666: </div>
1.41      asau     8667: <div class="sect2">
1.40      wiz      8668: <div class="titlepage"><div><div><h3 class="title">
                   8669: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  8670: <p>Currently, there is no special handling for other languages
                   8671:     in pkgsrc.  If a compiler package provides a
                   8672:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8673:     just add a (build) dependency on the appropriate compiler
                   8674:     package.</p>
                   8675: </div>
                   8676: </div>
1.41      asau     8677: <div class="sect1">
1.1       dsieger  8678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8679: <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  8680: <p>The most common failures when building a package are that
                   8681:        some platforms do not provide certain header files, functions or
                   8682:        libraries, or they provide the functions in a library that the
                   8683:        original package author didn't know. To work around this, you
                   8684:        can rewrite the source code in most cases so that it does not
                   8685:        use the missing functions or provides a replacement function.</p>
1.41      asau     8686: <div class="sect2">
1.1       dsieger  8687: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8688: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8689: <p>If a package already comes with a GNU configure script, the
                   8690:        preferred way to fix the build failure is to change the
                   8691:        configure script, not the code. In the other cases, you can
                   8692:        utilize the C preprocessor, which defines certain macros
                   8693:        depending on the operating system and hardware architecture it
                   8694:        compiles for. These macros can be queried using for example
                   8695:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8696:        system, hardware architecture and compiler has its own macro.
                   8697:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8698:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8699:        are all defined, you know that you are using NetBSD on an i386
                   8700:        compatible CPU, and your compiler is GCC.</p>
                   8701: <p>The list of the following macros for hardware and
                   8702:        operating system depends on the compiler that is used. For
                   8703:        example, if you want to conditionally compile code on Solaris,
                   8704:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8705:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     8706: <div class="sect3">
1.1       dsieger  8707: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8708: <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  8709: <p>To distinguish between 4.4 BSD-derived systems and the
                   8710:         rest of the world, you should use the following code.</p>
                   8711: <pre class="programlisting">
                   8712: #include &lt;sys/param.h&gt;
                   8713: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8714: /* BSD-specific code goes here */
                   8715: #else
                   8716: /* non-BSD-specific code goes here */
                   8717: #endif
                   8718: </pre>
                   8719: <p>If this distinction is not fine enough, you can also test
                   8720:        for the following macros.</p>
                   8721: <pre class="programlisting">
1.45      obache   8722: Cygwin      __CYGWIN__
                   8723: DragonFly   __DragonFly__
1.1       dsieger  8724: FreeBSD     __FreeBSD__
1.45      obache   8725: Haiku       __HAIKU__
1.1       dsieger  8726: Interix     __INTERIX
                   8727: IRIX        __sgi (TODO: get a definite source for this)
                   8728: Linux       linux, __linux, __linux__
1.45      obache   8729: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8730: Minix3      __minix
1.1       dsieger  8731: NetBSD      __NetBSD__
                   8732: OpenBSD     __OpenBSD__
                   8733: Solaris     sun, __sun
                   8734: </pre>
                   8735: </div>
1.41      asau     8736: <div class="sect3">
1.1       dsieger  8737: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8738: <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  8739: <pre class="programlisting">
                   8740: i386        i386, __i386, __i386__
                   8741: MIPS        __mips
                   8742: SPARC       sparc, __sparc
                   8743: </pre>
                   8744: </div>
1.41      asau     8745: <div class="sect3">
1.1       dsieger  8746: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8747: <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  8748: <pre class="programlisting">
                   8749: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8750: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8751: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8752: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8753: </pre>
                   8754: </div>
                   8755: </div>
1.41      asau     8756: <div class="sect2">
1.1       dsieger  8757: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8758: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8759: <p>Some source files trigger bugs in the compiler, based on
                   8760:         combinations of compiler version and architecture and almost
                   8761:         always relation to optimisation being enabled.  Common symptoms
                   8762:         are gcc internal errors or never finishing compiling a
                   8763:        file.</p>
                   8764: <p>Typically, a workaround involves testing the
                   8765:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8766:         optimisation for that combination of file,
                   8767:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8768:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8769:        number of examples.</p>
                   8770: </div>
1.41      asau     8771: <div class="sect2">
1.1       dsieger  8772: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz      8773: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8774: </h3></div></div></div>
1.1       dsieger  8775: <p>This error message often means that a package did not
                   8776:        link to a shared library it needs. The following functions are
                   8777:        known to cause this error message over and over.</p>
                   8778: <div class="informaltable">
                   8779: <a name="undefined-reference-functions"></a><table border="1">
                   8780: <colgroup>
                   8781: <col>
                   8782: <col>
                   8783: <col>
                   8784: </colgroup>
                   8785: <thead><tr>
                   8786: <th>Function</th>
                   8787: <th>Library</th>
                   8788: <th>Affected platforms</th>
                   8789: </tr></thead>
                   8790: <tbody>
                   8791: <tr>
                   8792: <td>accept, bind, connect</td>
                   8793: <td>-lsocket</td>
                   8794: <td>Solaris</td>
                   8795: </tr>
                   8796: <tr>
                   8797: <td>crypt</td>
                   8798: <td>-lcrypt</td>
                   8799: <td>DragonFly, NetBSD</td>
                   8800: </tr>
                   8801: <tr>
                   8802: <td>dlopen, dlsym</td>
                   8803: <td>-ldl</td>
                   8804: <td>Linux</td>
                   8805: </tr>
                   8806: <tr>
                   8807: <td>gethost*</td>
                   8808: <td>-lnsl</td>
                   8809: <td>Solaris</td>
                   8810: </tr>
                   8811: <tr>
                   8812: <td>inet_aton</td>
                   8813: <td>-lresolv</td>
                   8814: <td>Solaris</td>
                   8815: </tr>
                   8816: <tr>
                   8817: <td>nanosleep, sem_*, timer_*</td>
                   8818: <td>-lrt</td>
                   8819: <td>Solaris</td>
                   8820: </tr>
                   8821: <tr>
                   8822: <td>openpty</td>
                   8823: <td>-lutil</td>
                   8824: <td>Linux</td>
                   8825: </tr>
                   8826: </tbody>
                   8827: </table>
                   8828: </div>
                   8829: <p>To fix these linker errors, it is often sufficient to say
                   8830:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8831:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8832:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8833:     bmake</strong></span>.</p>
1.41      asau     8834: <div class="sect3">
1.1       dsieger  8835: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8836: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8837: <p>When you are using the SunPro compiler, there is another
                   8838: possibility. That compiler cannot handle the following code:</p>
                   8839: <pre class="programlisting">
                   8840: extern int extern_func(int);
                   8841: 
                   8842: static inline int
                   8843: inline_func(int x)
                   8844: {
                   8845:         return extern_func(x);
                   8846: }
                   8847: 
                   8848: int main(void)
                   8849: {
                   8850:         return 0;
                   8851: }
                   8852: </pre>
                   8853: <p>It generates the code for <code class="function">inline_func</code> even if
                   8854: that function is never used. This code then refers to
                   8855: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8856: solve this problem you can try to tell the package to disable inlining
                   8857: of functions.</p>
                   8858: </div>
                   8859: </div>
1.41      asau     8860: <div class="sect2">
1.1       dsieger  8861: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8862: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8863: <p>Sometimes packages fail to build because the compiler runs
                   8864:     into an operating system specific soft limit.  With the
                   8865:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8866:     to unlimit the resources.  Currently, the allowed values are
1.23      wiz      8867:     <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  8868:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8869:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8870:     segment size or maximum stack size of a process, respectively, to
                   8871:     their hard limits.</p>
                   8872: </div>
                   8873: </div>
1.41      asau     8874: <div class="sect1">
1.1       dsieger  8875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8876: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     8877: <div class="sect2">
1.1       dsieger  8878: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8879: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8880: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8881:     with some operating systems cannot create more than one
                   8882:     directory at a time. As such, you should call
                   8883:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8884: <pre class="programlisting">
                   8885: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8886: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8887:     </pre>
1.23      wiz      8888: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8889:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8890:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8891:     automatically do the right thing.</p>
                   8892: </div>
1.41      asau     8893: <div class="sect2">
1.1       dsieger  8894: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8895: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8896: <p>In general, documentation should be installed into
                   8897:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8898:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8899:     includes the version number of the package).</p>
                   8900: <p>Many modern packages using GNU autoconf allow to set the
                   8901:     directory where HTML documentation is installed with the
1.23      wiz      8902:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8903:     is needed because otherwise the documentation ends up in
                   8904:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8905:     places.</p>
                   8906: <p>An exception to the above is that library API documentation
                   8907:     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
                   8908:     browsers (devhelp) should be left at their default location, which
                   8909:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8910:     documentation can be recognized from files ending in
                   8911:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8912:     (It is also acceptable to install such files in
                   8913:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8914:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8915:     <code class="filename">.devhelp*</code> file must be directly in that
                   8916:     directory then, no additional subdirectory level is allowed in
                   8917:     this case. This is usually achieved by using
1.23      wiz      8918:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8919:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8920:     though.)</p>
                   8921: </div>
1.41      asau     8922: <div class="sect2">
1.1       dsieger  8923: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8924: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8925: <p>Certain packages, most of them in the games category, install
                   8926:     a score file that allows all users on the system to record their
                   8927:     highscores.  In order for this to work, the binaries need to be
                   8928:     installed setgid and the score files owned by the appropriate
1.35      wiz      8929:     group and/or owner (traditionally the "games" user/group).  Set
                   8930:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8931:     following variables, documented in more detail in
                   8932:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8933:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8934:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
                   8935:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14      jmcneill 8936: <p>A package should therefore never hard code file ownership or
1.1       dsieger  8937:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8938:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8939:     correctly.</p>
                   8940: </div>
1.41      asau     8941: <div class="sect2">
1.1       dsieger  8942: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8943: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8944: <p><code class="varname">DESTDIR</code> support means that a package
                   8945:     installs into a staging directory, not the final location of the
                   8946:     files. Then a binary package is created which can be used for
                   8947:     installation as usual. There are two ways: Either the package must
1.23      wiz      8948:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8949:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     8950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8951: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38      wiz      8952:       set to <span class="quote">&#8220;<span class="quote">none</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>, or
                   8953:       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
                   8954:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8955:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8956:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8957:       the inclusion.</p></li>
1.23      wiz      8958: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8959:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8960: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8961:       automatically. Many manual rules and pre/post-install often are
                   8962:       incorrect; fix them.</p></li>
1.23      wiz      8963: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8964:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8965: <li class="listitem"><p>In general, packages should support
1.4       rillig   8966:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8967:       DESTDIR.</p></li>
                   8968: </ul></div>
                   8969: </div>
1.41      asau     8970: <div class="sect2">
1.4       rillig   8971: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8972: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8973: <p>Your package may also contain scripts with hardcoded paths to
                   8974:       other interpreters besides (or as well as) perl.  To correct the
                   8975:       full pathname to the script interpreter, you need to set the
                   8976:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8977:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8978: <pre class="programlisting">
                   8979: REPLACE_INTERPRETER+=   tcl
                   8980: REPLACE.tcl.old=        .*/bin/tclsh
                   8981: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8982: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8983: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8984:     </pre>
1.41      asau     8985: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8986: <h3 class="title">Note</h3>
                   8987: <p>Before March 2006, these variables were called
                   8988:     <code class="varname">_REPLACE.*</code> and
                   8989:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8990: </div>
                   8991: </div>
1.41      asau     8992: <div class="sect2">
1.1       dsieger  8993: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8994: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8995: <p>Makefiles of packages providing perl5 modules should include
                   8996:     the Makefile fragment
                   8997:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8998:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8999:     configuration for such modules as well as various hooks to tune
                   9000:     this configuration.  See comments in this file for
                   9001:     details.</p>
                   9002: <p>Perl5 modules will install into different places depending
                   9003:     on the version of perl used during the build process.  To
                   9004:     address this, pkgsrc will append lines to the
                   9005:     <code class="filename">PLIST</code> corresponding to the files listed in
                   9006:     the installed <code class="filename">.packlist</code> file generated by
                   9007:     most perl5 modules.  This is invoked by defining
                   9008:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47    ! wiz      9009:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
        !          9010:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
        !          9011:     e.g.:</p>
1.1       dsieger  9012: <pre class="programlisting">
1.47    ! wiz      9013: PERL5_PACKLIST= auto/Pg/.packlist
1.1       dsieger  9014:     </pre>
1.47    ! wiz      9015: <p>The perl5 config variables
        !          9016:     <code class="varname">installarchlib</code>,
        !          9017:     <code class="varname">installscript</code>,
        !          9018:     <code class="varname">installvendorbin</code>,
        !          9019:     <code class="varname">installvendorscript</code>,
        !          9020:     <code class="varname">installvendorarch</code>,
        !          9021:     <code class="varname">installvendorlib</code>,
        !          9022:     <code class="varname">installvendorman1dir</code>, and
        !          9023:     <code class="varname">installvendorman3dir</code> represent those
        !          9024:     locations in which components of perl5 modules may be installed,
        !          9025:     provided as variable with uppercase and prefixed with
        !          9026:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
        !          9027:     and may be used by perl5 packages that don't have a packlist.
        !          9028:     These variables are also substituted for in the
        !          9029:     <code class="filename">PLIST</code> as uppercase prefixed with
        !          9030:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  9031: </div>
1.41      asau     9032: <div class="sect2">
1.1       dsieger  9033: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9034: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  9035: <p>Some packages install info files or use the
1.23      wiz      9036:     <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  9037:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9038:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9039:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9040:     handle registration of the info files in the Info directory
1.23      wiz      9041:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  9042:     files registration is either provided by the system, or by a
                   9043:     special purpose package automatically added as dependency if
                   9044:     needed.</p>
                   9045: <p><code class="varname">PKGINFODIR</code> is the directory under
                   9046:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9047:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      9048:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  9049: <p>The info files for the package should be listed in the
                   9050:     package <code class="filename">PLIST</code>; however any split info files
                   9051:     need not be listed.</p>
1.23      wiz      9052: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9053:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  9054:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      9055:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  9056:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9057:     variable in the package <code class="filename">Makefile</code>. By
                   9058:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  9059:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  9060:     does not match the required minimum, a build dependency on the
                   9061:     <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
                   9062:     be added automatically.</p>
                   9063: <p>The build and installation process of the software provided
                   9064:     by the package should not use the
1.10      hubertf  9065:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  9066:     info files is the task of the package
                   9067:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  9068:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  9069: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  9070:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9071:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  9072:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  9073: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  9074:     no effect except the logging of a message. The script overriding
1.10      hubertf  9075:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  9076:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  9077:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  9078: </div>
1.41      asau     9079: <div class="sect2">
1.1       dsieger  9080: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9081: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  9082: <p>All packages that install manual pages should install them
                   9083:     into the same directory, so that there is one common place to look
                   9084:     for them. In pkgsrc, this place is
                   9085:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9086:     should be used in packages. The default for
                   9087:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      9088:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9089:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     9090: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9091: <h3 class="title">Note</h3>
                   9092: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9093:     is far from complete.</p>
                   9094: </div>
                   9095: <p>The <code class="filename">PLIST</code> files can just use
                   9096:     <code class="filename">man/</code> as the top level directory for the man
                   9097:     page file entries, and the pkgsrc framework will convert as
                   9098:     needed. In all other places, the correct
                   9099:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9100: <p>Packages that are
                   9101:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      9102:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  9103:     <code class="filename">./configure</code>
                   9104:     --mandir switch to set where the man pages should be installed.
                   9105:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9106:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9107: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9108:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      9109:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  9110:     Or if the <code class="filename">./configure</code> script uses
                   9111:     a non-standard use of --mandir, you can set
                   9112:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  9113: <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  9114:     information on installation of compressed manual pages.</p>
                   9115: </div>
1.41      asau     9116: <div class="sect2">
1.1       dsieger  9117: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   9118: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  9119: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   9120:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  9121:     you need to take some extra steps to make sure they get registered
                   9122:     in the database:</p>
1.23      wiz      9123: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9124: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  9125:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   9126:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  9127:        deinstallation time, and tells the package where to install
1.7       rillig   9128:        GConf data files using some standard configure arguments.  It
1.1       dsieger  9129:        also disallows any access to the database directly from the
                   9130:        package.</p></li>
1.23      wiz      9131: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  9132:        <code class="filename">.schemas</code> files under
                   9133:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9134:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9135:        need to manually patch the package.</p></li>
1.23      wiz      9136: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  9137:        directory, as they will be handled automatically.  See
1.10      hubertf  9138:        <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      9139: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  9140:        your <code class="filename">Makefile</code> with a list of all
                   9141:        <code class="filename">.schemas</code> files installed by the package, if
                   9142:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      9143: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  9144:        your <code class="filename">Makefile</code> with a
                   9145:        list of all <code class="filename">.entries</code> files installed by the
                   9146:        package, if any. Names must not contain any directories in
                   9147:        them.</p></li>
                   9148: </ol></div>
                   9149: </div>
1.41      asau     9150: <div class="sect2">
1.1       dsieger  9151: <div class="titlepage"><div><div><h3 class="title">
1.18      snj      9152: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  9153: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      9154:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  9155:     get registered in the database:</p>
1.23      wiz      9156: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9157: <li class="listitem"><p>Include
1.18      snj      9158:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9159:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  9160:        takes care of rebuilding the scrollkeeper database at
                   9161:        installation and deinstallation time, and disallows any access
                   9162:        to it directly from the package.</p></li>
1.23      wiz      9163: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9164:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9165:        will be handled automatically.</p></li>
1.23      wiz      9166: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      9167:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9168:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  9169: </ol></div>
                   9170: </div>
1.41      asau     9171: <div class="sect2">
1.1       dsieger  9172: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9173: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9174: <p>If a package installs font files, you will need to rebuild
                   9175:     the fonts database in the directory where they get installed at
                   9176:     installation and deinstallation time.  This can be automatically
                   9177:     done by using the pkginstall framework.</p>
                   9178: <p>You can list the directories where fonts are installed in the
                   9179:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9180:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9181:     <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  9182:     Also make sure that the database file
                   9183:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9184: <p>Note that you should not create new directories for fonts;
                   9185:     instead use the standard ones to avoid that the user needs to
                   9186:     manually configure his X server to find them.</p>
                   9187: </div>
1.41      asau     9188: <div class="sect2">
1.1       dsieger  9189: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9190: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  9191: <p>If a package installs GTK2 immodules or loaders, you need to
                   9192:     take some extra steps to get them registered in the GTK2 database
                   9193:     properly:</p>
1.23      wiz      9194: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9195: <li class="listitem"><p>Include
1.1       dsieger  9196:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9197:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9198:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      9199: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  9200:       your package installs GTK2 immodules.</p></li>
1.23      wiz      9201: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  9202:       GTK2 loaders.</p></li>
1.23      wiz      9203: <li class="listitem">
1.1       dsieger  9204: <p>Patch the package to not touch any of the GTK2
                   9205:       databases directly.  These are:</p>
1.41      asau     9206: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9207: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9208: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  9209: </ul></div>
                   9210: </li>
1.23      wiz      9211: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  9212:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9213:       directory, as they will be handled automatically.</p></li>
                   9214: </ol></div>
                   9215: </div>
1.41      asau     9216: <div class="sect2">
1.1       dsieger  9217: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9218: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9219: <p>If a package installs SGML or XML data files that need to be
                   9220:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9221:     etc.), you need to take some extra steps:</p>
1.23      wiz      9222: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9223: <li class="listitem"><p>Include
1.1       dsieger  9224:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9225:        your <code class="filename">Makefile</code>, which takes care of
                   9226:        registering those files in system-wide catalogs at
                   9227:        installation and deinstallation time.</p></li>
1.23      wiz      9228: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9229:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9230: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9231:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9232: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9233:        to be added to the SGML catalog.  These come in groups of
                   9234:        three strings; see xmlcatmgr(1) for more information
                   9235:        (specifically, arguments recognized by the 'add' action).
                   9236:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9237: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9238:        to be added to the XML catalog.  These come in groups of three
                   9239:        strings; see xmlcatmgr(1) for more information (specifically,
                   9240:        arguments recognized by the 'add' action).  Note that you will
                   9241:        normally not use this variable.</p></li>
                   9242: </ol></div>
                   9243: </div>
1.41      asau     9244: <div class="sect2">
1.1       dsieger  9245: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9246: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9247: <p>If a package provides extensions to the MIME database by
                   9248:     installing <code class="filename">.xml</code> files inside
                   9249:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9250:     need to take some extra steps to ensure that the database is kept
                   9251:     consistent with respect to these new files:</p>
1.23      wiz      9252: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9253: <li class="listitem"><p>Include
1.1       dsieger  9254:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9255:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9256:        this same directory, which is reserved for inclusion from
                   9257:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9258:        care of rebuilding the MIME database at installation and
                   9259:        deinstallation time, and disallows any access to it directly
                   9260:        from the package.</p></li>
1.23      wiz      9261: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9262:        <code class="filename">share/mime</code> directory,
                   9263:        <span class="emphasis"><em>except</em></span> for files saved under
                   9264:        <code class="filename">share/mime/packages</code>.  The former are
                   9265:        handled automatically by
                   9266:        the update-mime-database program, but the latter are
                   9267:        package-dependent and must be removed by the package that
                   9268:        installed them in the first place.</p></li>
1.23      wiz      9269: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9270:        from the PLIST.  They will be handled by the shared-mime-info
                   9271:        package.</p></li>
                   9272: </ol></div>
                   9273: </div>
1.41      asau     9274: <div class="sect2">
1.1       dsieger  9275: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9276: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9277: <p>If a package uses intltool during its build, add
                   9278:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9279:     which forces it to use the intltool package provided by pkgsrc,
                   9280:     instead of the one bundled with the distribution file.</p>
                   9281: <p>This tracks intltool's build-time dependencies and uses the
                   9282:     latest available version; this way, the package benefits of any
                   9283:     bug fixes that may have appeared since it was released.</p>
                   9284: </div>
1.41      asau     9285: <div class="sect2">
1.1       dsieger  9286: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9287: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9288: <p>If a package contains a rc.d script, it won't be copied into
                   9289:     the startup directory by default, but you can enable it, by adding
                   9290:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9291:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9292:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9293:     it will automatically remove the scripts when the package is
                   9294:     deinstalled.</p>
                   9295: </div>
1.41      asau     9296: <div class="sect2">
1.1       dsieger  9297: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9298: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9299: <p>If a package installs TeX packages into the texmf tree,
                   9300:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9301:     updated.</p>
1.41      asau     9302: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9303: <h3 class="title">Note</h3>
1.22      jakllsch 9304: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9305:     packages should install files
1.22      jakllsch 9306:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9307:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9308: </div>
1.23      wiz      9309: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9310: <li class="listitem"><p>Include
1.22      jakllsch 9311:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9312:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9313:       database at installation and deinstallation time.</p></li>
1.23      wiz      9314: <li class="listitem">
1.1       dsieger  9315: <p>If your package installs files into a texmf
                   9316:       tree other than the one
1.22      jakllsch 9317:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9318:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9319:       trees that need database update.</p>
                   9320: <p>If your package also installs font map files that need
1.10      hubertf  9321:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9322:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9323:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9324:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9325:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9326:       be run automatically at installation/deinstallation to
                   9327:       enable/disable font map files for TeX output
                   9328:       drivers.</p>
                   9329: </li>
1.23      wiz      9330: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9331:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9332:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9333: </ol></div>
                   9334: </div>
1.41      asau     9335: <div class="sect2">
1.1       dsieger  9336: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9337: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  9338:     emulation</h3></div></div></div>
                   9339: <p>There are some packages that provide libraries and
                   9340:     executables for running binaries from a one operating system
                   9341:     on a different one (if the latter supports it).  One example
                   9342:     is running Linux binaries on NetBSD.</p>
                   9343: <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>
                   9344:     helps in extracting and packaging Linux rpm packages.</p>
                   9345: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9346:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9347:     if all libraries for each installed executable can be found by
                   9348:     the dynamic linker.  Since the standard dynamic linker is run,
                   9349:     this fails for emulation packages, because the libraries used
                   9350:     by the emulation are not in the standard directories.</p>
                   9351: </div>
1.41      asau     9352: <div class="sect2">
1.1       dsieger  9353: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9354: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9355: <p>If a package installs images under the
                   9356:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9357:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9358:     database, you need to take some extra steps to make sure that the
                   9359:     shared theme directory is handled appropriately and that the cache
                   9360:     database is rebuilt:</p>
1.23      wiz      9361: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9362: <li class="listitem"><p>Include
1.1       dsieger  9363:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      9364: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  9365:        entry that refers to the theme cache.</p></li>
1.23      wiz      9366: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  9367:          directories from the <code class="filename">share/icons/hicolor</code>
                   9368:          hierarchy because they will be handled automatically.</p></li>
                   9369: </ol></div>
                   9370: <p>The best way to verify that the PLIST is correct with
                   9371:       respect to the last two points is to regenerate it using
1.10      hubertf  9372:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  9373: </div>
1.41      asau     9374: <div class="sect2">
1.1       dsieger  9375: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9376: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  9377: <p>If a package installs <code class="filename">.desktop</code> files
                   9378:       under <code class="filename">share/applications</code> and these include
                   9379:       MIME information, you need to take extra steps to ensure that they
                   9380:       are registered into the MIME database:</p>
1.23      wiz      9381: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9382: <li class="listitem"><p>Include
1.1       dsieger  9383:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      9384: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  9385:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9386:          It will be handled automatically.</p></li>
                   9387: </ol></div>
                   9388: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  9389:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  9390:       print-PLIST</strong></span>.</p>
                   9391: </div>
                   9392: </div>
1.41      asau     9393: <div class="sect1">
1.1       dsieger  9394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9395: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9396: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 9397:   immediately. In this case, one can plainly mark a package as broken.  For
                   9398:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9399:   reason why the package is broken (similar to the
                   9400:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9401:   the package will immediately be shown this message, and the build
                   9402:   will not be even tried.</p>
                   9403: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  9404:   intervals.</p>
                   9405: </div>
                   9406: </div>
1.41      asau     9407: <div class="chapter">
1.1       dsieger  9408: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9409: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9410: <p>To check out all the gotchas when building a package, here are
                   9411:   the steps that I do in order to get a package working.  Please note
                   9412:   this is basically the same as what was explained in the previous
                   9413:   sections, only with some debugging aids.</p>
1.41      asau     9414: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9415: <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>
                   9416: <li class="listitem">
1.1       dsieger  9417: <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>,
                   9418:       create a directory for a new package, change into it, then run
1.10      hubertf  9419:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  9420: <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>
                   9421: <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>
                   9422: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9423: </li>
1.23      wiz      9424: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9425: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9426: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9427: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  9428:       configure step to the package's
                   9429:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      9430: <li class="listitem">
1.1       dsieger  9431: <p>Make the package compile, doing multiple rounds of</p>
                   9432: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9433: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9434: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9435: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9436: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9437: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9438: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9439: <p>Doing this step as non-root user will ensure that no files
                   9440:       are modified that shouldn't be, especially during the build
1.10      hubertf  9441:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9442:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1       dsieger  9443:       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>
                   9444:       package.</p>
                   9445: </li>
1.23      wiz      9446: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9447:       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>
                   9448: <li class="listitem">
1.1       dsieger  9449: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9450: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9451: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9452: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9453: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9454: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9455: <p>You usually need to be <code class="username">root</code> to do
                   9456:       this.  Look if there are any files left:</p>
                   9457: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9458: <p>If this reveals any files that are missing in
                   9459:       <code class="filename">PLIST</code>, add them.</p>
                   9460: </li>
1.23      wiz      9461: <li class="listitem">
1.1       dsieger  9462: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9463:       package again and make a binary package:</p>
                   9464: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9465: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9466: </li>
1.23      wiz      9467: <li class="listitem">
1.1       dsieger  9468: <p>Delete the installed package:</p>
                   9469: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9470: </li>
1.23      wiz      9471: <li class="listitem">
1.10      hubertf  9472: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  9473:       command, which shouldn't find anything now:</p>
                   9474: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9475: </li>
1.23      wiz      9476: <li class="listitem">
1.1       dsieger  9477: <p>Reinstall the binary package:</p>
                   9478: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9479: </li>
1.23      wiz      9480: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9481: <li class="listitem">
1.10      hubertf  9482: <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  9483:       reports:</p>
                   9484: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9485: </li>
1.23      wiz      9486: <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  9487: </ul></div>
                   9488: </div>
1.41      asau     9489: <div class="chapter">
1.1       dsieger  9490: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9491: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9492: <div class="toc">
                   9493: <p><b>Table of Contents</b></p>
                   9494: <dl>
1.6       rillig   9495: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9496: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9497: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz      9498: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   9499: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      9500: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9501: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9502: </dl>
                   9503: </div>
1.41      asau     9504: <div class="sect1">
1.1       dsieger  9505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9506: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9507: <p>Our policy is that we accept binaries only from pkgsrc
                   9508:        developers to guarantee that the packages don't contain any
                   9509:        trojan horses etc. This is not to annoy anyone but rather to
                   9510:        protect our users! You're still free to put up your home-made
                   9511:        binary packages and tell the world where to get them. NetBSD
                   9512:        developers doing bulk builds and wanting to upload them please
1.10      hubertf  9513:        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  9514: </div>
1.41      asau     9515: <div class="sect1">
1.1       dsieger  9516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9517: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9518: <p>First, check that your package is complete, compiles and
1.10      hubertf  9519:        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 9520:        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  9521:        archive that contains all files that make up the package.
                   9522:        Finally, send this package to the pkgsrc bug tracking system,
1.29      dholland 9523:        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  9524:        that, go to the web page
1.10      hubertf  9525:        <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      9526:        which contains some instructions and a link to a form where you
                   9527:        can submit packages.  The
                   9528:        <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
                   9529:        also available as a substitute for either of the above two tools.
                   9530:        </p>
1.1       dsieger  9531: <p>In the form of the problem report, the category should be
1.23      wiz      9532:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9533:        and version number, and the description field should contain a
                   9534:        short description of your package (contents of the COMMENT
                   9535:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      9536:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  9537: <p>If you want to submit several packages, please send a
                   9538:        separate PR for each one, it's easier for us to track things
                   9539:        that way.</p>
                   9540: <p>Alternatively, you can also import new packages into
1.23      wiz      9541:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.10      hubertf  9542:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger  9543:        for details.</p>
                   9544: </div>
1.41      asau     9545: <div class="sect1">
1.1       dsieger  9546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9547: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9548: <p>Please note all package additions, updates, moves, and
                   9549:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9550:        important to keep this file up to date and conforming to the
                   9551:        existing format, because it will be used by scripts to
1.10      hubertf  9552:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9553:        sites. Additionally, check the
                   9554:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9555:        for the package you updated or removed, in case it was mentioned
                   9556:        there.</p>
                   9557: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9558:        bumped, the change should appear in
                   9559:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9560:        related or otherwise relevant. Mass bumps that result from a
                   9561:        dependency being updated should not be mentioned. In all other
                   9562:        cases it's the developer's decision.</p>
                   9563: <p>There is a make target that helps in creating proper
1.10      hubertf  9564:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9565:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9566:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9567:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9568:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9569:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9570:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9571:   For new packages, or package moves or removals, set the
                   9572:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9573:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9574:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9575:   not the same as your NetBSD login name. The target also automatically
                   9576:   removes possibly existing entries for the package in the
                   9577:   <code class="filename">TODO</code> file. Don't forget to commit
                   9578:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
                   9579:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9580:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9581:   makes the cvs commands use the main repository.
                   9582:   </p>
1.1       dsieger  9583: </div>
1.41      asau     9584: <div class="sect1">
1.1       dsieger  9585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33      wiz      9586: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  9587: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      9588:   access to the pkgsrc repository.</p>
                   9589: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9590: Start by adding the directory and then files in the directory. Don't
                   9591: forget to add the new package to the category's
                   9592: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9593: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9594: <pre class="programlisting">
                   9595: <code class="prompt">$</code> cd .../pkgsrc/category
                   9596: <code class="prompt">$</code> cvs add pkgname
                   9597: <code class="prompt">$</code> cd pkgname
                   9598: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9599: <code class="prompt">$</code> cvs add patches/p*
                   9600: <code class="prompt">$</code> cvs status | less
1.34      wiz      9601: <code class="prompt">$</code> cvs commit
1.33      wiz      9602: <code class="prompt">$</code> cd ..
                   9603: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      9604: <code class="prompt">$</code> cvs commit Makefile
1.33      wiz      9605: </pre>
1.1       dsieger  9606: <p>The commit message of the initial import should include part of the
                   9607:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9608:   what the package is/does.</p>
1.33      wiz      9609: <p>Also mention the new package in
                   9610: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9611: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9612: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  9613: </div>
1.41      asau     9614: <div class="sect1">
1.1       dsieger  9615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9616: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9617: <p>Please always put a concise, appropriate and relevant summary of the
                   9618:   changes between old and new versions into the commit log when updating
                   9619:   a package. There are various reasons for this:</p>
1.41      asau     9620: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9621: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9622:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9623: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9624:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9625: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9626:   repository is very useful for people who read the pkgsrc-changes mailing
                   9627:   list, so that they can make tactical decisions about when to upgrade
                   9628:   the package.</p></li>
                   9629: </ul></div>
                   9630: <p>Please also recognize that, just because a new version of a package
                   9631:   has been released, it should not automatically be upgraded in the CVS
                   9632:   repository.  We prefer to be conservative in the packages that are
                   9633:   included in pkgsrc - development or beta packages are not really the
                   9634:   best thing for most places in which pkgsrc is used. Please use your
                   9635:   judgement about what should go into pkgsrc, and bear in mind that
                   9636:   stability is to be preferred above new and possibly untested features.</p>
                   9637: </div>
1.41      asau     9638: <div class="sect1">
1.1       dsieger  9639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20      snj      9640: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9641: <p>Renaming packages is not recommended.</p>
                   9642: <p>When renaming packages, be sure to fix any references to old name
                   9643:   in other Makefiles, options, buildlink files, etc.</p>
                   9644: <p>Also When renaming a package, please define
                   9645:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9646:   pattern(s) of the previous package name.
                   9647:   This may be repeated for multiple renames.
                   9648:   The new package would be an exact replacement.
                   9649: </p>
1.23      wiz      9650: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9651:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9652:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9653:   not be an exact replacement but is a suggestion for the replaced
                   9654:   functionality.</p>
                   9655: </div>
1.41      asau     9656: <div class="sect1">
1.20      snj      9657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9658: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9659: <p>It is preferred that packages are not renamed or moved, but if needed
                   9660:   please follow these steps.
                   9661: </p>
1.23      wiz      9662: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9663: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9664: <li class="listitem">
1.1       dsieger  9665: <p>Remove all CVS dirs.</p>
                   9666: <p>Alternatively to the first two steps you can also do:</p>
                   9667: <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>
                   9668: <p>and use that for further work.</p>
                   9669: </li>
1.23      wiz      9670: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9671: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9672: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9673: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      9674: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9675: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9676: for doing an update using pkgsrc building; for example, it can
1.29      dholland 9677: 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      9678: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9679: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9680: it may have multiple matches, so the tool should also check on the
                   9681: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9682: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9683: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9684: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9685: place.</p></li>
1.23      wiz      9686: <li class="listitem">
1.1       dsieger  9687: <p>Check if any package depends on it:
                   9688: </p>
                   9689: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9690: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9691: </li>
1.23      wiz      9692: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9693: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9694: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9695: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9696: <li class="listitem">
1.1       dsieger  9697: <p>Commit the changed and removed files:</p>
                   9698: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9699: <p>(and any packages from step 5, of course).</p>
                   9700: </li>
                   9701: </ol></div>
                   9702: </div>
                   9703: </div>
1.41      asau     9704: <div class="chapter">
1.1       dsieger  9705: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9706: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9707: <p>This section contains the answers to questions that may
                   9708:        arise when you are writing a package. If you don't find your
                   9709:        question answered here, first have a look in the other chapters,
                   9710:        and if you still don't have the answer, ask on the
                   9711:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     9712: <div class="qandaset">
1.47    ! wiz      9713: <a name="idm81992016"></a><dl>
1.6       rillig   9714: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9715:        MAKEFLAGS, .MAKEFLAGS and
                   9716:        MAKE_FLAGS?</a>
                   9717: </dt>
1.6       rillig   9718: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9719:        MAKE, GMAKE and
                   9720:        MAKE_PROGRAM?</a>
                   9721: </dt>
1.6       rillig   9722: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9723:        CC, PKG_CC and
                   9724:        PKGSRC_COMPILER?</a>
                   9725: </dt>
1.6       rillig   9726: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9727:        BUILDLINK_LDFLAGS,
                   9728:        BUILDLINK_LDADD and
                   9729:        BUILDLINK_LIBS?</a>
                   9730: </dt>
1.6       rillig   9731: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9732:        VARNAME=BUILDLINK_PREFIX.foo
                   9733:        say it's empty?</a>
                   9734: </dt>
1.6       rillig   9735: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9736:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9737:        don't understand the := inside
                   9738:        it.</a>
                   9739: </dt>
1.6       rillig   9740: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9741:        developers?</a>
                   9742: </dt>
1.6       rillig   9743: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9744:        documentation?</a>
                   9745: </dt>
1.6       rillig   9746: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9747: do?</a>
                   9748: </dt>
                   9749: </dl>
1.41      asau     9750: <table border="0" style="width: 100%;">
                   9751: <colgroup>
1.1       dsieger  9752: <col align="left" width="1%">
1.23      wiz      9753: <col>
1.41      asau     9754: </colgroup>
1.1       dsieger  9755: <tbody>
1.41      asau     9756: <tr class="question">
1.1       dsieger  9757: <td align="left" valign="top">
1.47    ! wiz      9758: <a name="devfaq.makeflags"></a><a name="idm81991632"></a><p><b>22.1.</b></p>
1.1       dsieger  9759: </td>
                   9760: <td align="left" valign="top"><p>What is the difference between
                   9761:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9762:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9763: </tr>
                   9764: <tr class="answer">
                   9765: <td align="left" valign="top"></td>
                   9766: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29      dholland 9767:        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  9768:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9769:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9770:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9771: </tr>
1.41      asau     9772: <tr class="question">
1.1       dsieger  9773: <td align="left" valign="top">
1.47    ! wiz      9774: <a name="devfaq.make"></a><a name="idm81987536"></a><p><b>22.2.</b></p>
1.1       dsieger  9775: </td>
                   9776: <td align="left" valign="top"><p>What is the difference between
                   9777:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9778:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9779: </tr>
                   9780: <tr class="answer">
                   9781: <td align="left" valign="top"></td>
                   9782: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29      dholland 9783:        <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  9784:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9785:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9786:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9787:        Make program that is used for building the
                   9788:        package.</p></td>
                   9789: </tr>
1.41      asau     9790: <tr class="question">
1.1       dsieger  9791: <td align="left" valign="top">
1.47    ! wiz      9792: <a name="devfaq.cc"></a><a name="idm81983184"></a><p><b>22.3.</b></p>
1.1       dsieger  9793: </td>
                   9794: <td align="left" valign="top"><p>What is the difference between
                   9795:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9796:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9797: </tr>
                   9798: <tr class="answer">
                   9799: <td align="left" valign="top"></td>
                   9800: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9801:        compiler, which can be configured by the pkgsrc user.
                   9802:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9803:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9804:        path to a compiler, but the type of compiler that should be
                   9805:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9806:        information about the latter variable.</p></td>
                   9807: </tr>
1.41      asau     9808: <tr class="question">
1.1       dsieger  9809: <td align="left" valign="top">
1.47    ! wiz      9810: <a name="devfaq.bl3flags"></a><a name="idm81978960"></a><p><b>22.4.</b></p>
1.1       dsieger  9811: </td>
                   9812: <td align="left" valign="top"><p>What is the difference between
                   9813:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9814:        <code class="varname">BUILDLINK_LDADD</code> and
                   9815:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9816: </tr>
                   9817: <tr class="answer">
                   9818: <td align="left" valign="top"></td>
                   9819: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9820: </tr>
1.41      asau     9821: <tr class="question">
1.1       dsieger  9822: <td align="left" valign="top">
1.47    ! wiz      9823: <a name="devfaq.bl3prefix"></a><a name="idm81976784"></a><p><b>22.5.</b></p>
1.1       dsieger  9824: </td>
1.10      hubertf  9825: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9826:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9827:        say it's empty?</p></td>
                   9828: </tr>
                   9829: <tr class="answer">
                   9830: <td align="left" valign="top"></td>
                   9831: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9832:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9833:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9834:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9835:        command.</p></td>
                   9836: </tr>
1.41      asau     9837: <tr class="question">
1.1       dsieger  9838: <td align="left" valign="top">
1.47    ! wiz      9839: <a name="devfaq.master_sites"></a><a name="idm81973712"></a><p><b>22.6.</b></p>
1.1       dsieger  9840: </td>
                   9841: <td align="left" valign="top"><p>What does
                   9842:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9843:        don't understand the <code class="literal">:=</code> inside
                   9844:        it.</p></td>
                   9845: </tr>
                   9846: <tr class="answer">
                   9847: <td align="left" valign="top"></td>
                   9848: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9849:        assignment operator, like you might expect at first sight.
                   9850:        Instead, it is a degenerate form of
                   9851:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29      dholland 9852:        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  9853:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9854:        case of <code class="varname">MASTER_SITE_*</code>,
                   9855:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9856:        <em class="replaceable"><code>new_string</code></em> is
                   9857:        <code class="literal">package/</code>. That's where the
                   9858:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9859:        together.</p></td>
                   9860: </tr>
1.41      asau     9861: <tr class="question">
1.1       dsieger  9862: <td align="left" valign="top">
1.47    ! wiz      9863: <a name="devfaq.mailinglists"></a><a name="idm81965648"></a><p><b>22.7.</b></p>
1.1       dsieger  9864: </td>
                   9865: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9866:        developers?</p></td>
                   9867: </tr>
                   9868: <tr class="answer">
                   9869: <td align="left" valign="top"></td>
1.41      asau     9870: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10      hubertf  9871: <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  9872: <dd><p>This is a list for technical discussions related
                   9873:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9874:        pkgsrc infrastructure, proposed new features, questions related
                   9875:        to porting pkgsrc to a new platform, advice for maintaining a
                   9876:        package, patches that affect many packages, help requests moved
                   9877:        from pkgsrc-users when an infrastructure bug is found,
                   9878:        etc.</p></dd>
1.10      hubertf  9879: <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  9880: <dd><p>All bug reports in category "pkg" sent with
1.29      dholland 9881:        <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  9882:        directly; use one of the other mailing
                   9883:        lists.</p></dd>
                   9884: </dl></div></td>
                   9885: </tr>
1.41      asau     9886: <tr class="question">
1.1       dsieger  9887: <td align="left" valign="top">
1.47    ! wiz      9888: <a name="devfaq.documentation"></a><a name="idm81961808"></a><p><b>22.8.</b></p>
1.1       dsieger  9889: </td>
                   9890: <td align="left" valign="top"><p>Where is the pkgsrc
                   9891:        documentation?</p></td>
                   9892: </tr>
                   9893: <tr class="answer">
                   9894: <td align="left" valign="top"></td>
                   9895: <td align="left" valign="top">
                   9896: <p>There are many places where you can find
                   9897:        documentation about pkgsrc:</p>
1.41      asau     9898: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9899: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9900:        of chapters that explain large parts of pkgsrc, but some
                   9901:        chapters tend to be outdated. Which ones they are is hard to
                   9902:        say.</p></li>
1.23      wiz      9903: <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  9904:        about certain features, announcements of new parts of the pkgsrc
                   9905:        infrastructure and sometimes even announcements that a certain
                   9906:        feature has been marked as obsolete. The benefit here is that
                   9907:        each message has a date appended to it.</p></li>
1.23      wiz      9908: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9909:        <code class="filename">mk/</code> directory start with a comment that
                   9910:        describes the purpose of the file and how it can be used by the
                   9911:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9912:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9913:        help</strong></span>.</p></li>
1.23      wiz      9914: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9915:        information, but they tend to be highly abbreviated, especially
                   9916:        for actions that occur often. Some contain a detailed
                   9917:        description of what has changed, but they are geared towards the
                   9918:        other pkgsrc developers, not towards an average pkgsrc user.
                   9919:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9920:        don't know what has been before, these messages may not be worth
                   9921:        too much to you.</p></li>
1.23      wiz      9922: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9923:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9924:        mind of the developer who wrote the code. To get this
1.10      hubertf  9925:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9926:        to see who has written it and ask on the
                   9927:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9928:        find your questions later (see above). To be sure that the
                   9929:        developer in charge reads the mail, you may CC him or
                   9930:        her.</p></li>
                   9931: </ul></div>
                   9932: </td>
                   9933: </tr>
1.41      asau     9934: <tr class="question">
1.1       dsieger  9935: <td align="left" valign="top">
1.47    ! wiz      9936: <a name="devfaq.too-much-time"></a><a name="idm81955280"></a><p><b>22.9.</b></p>
1.1       dsieger  9937: </td>
                   9938: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9939: do?</p></td>
                   9940: </tr>
                   9941: <tr class="answer">
                   9942: <td align="left" valign="top"></td>
                   9943: <td align="left" valign="top">
                   9944: <p>This is not really an FAQ yet, but here's the answer
                   9945: anyway.</p>
1.41      asau     9946: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9947: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1       dsieger  9948:     <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
                   9949:     will tell you about newer versions of installed packages that are
                   9950:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9951: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9952:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9953:     cleanups and enhancements for pkgsrc that would be nice to
                   9954:     have.</p></li>
1.23      wiz      9955: <li class="listitem"><p>Review packages for which review was requested on
1.10      hubertf  9956:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1       dsieger  9957:     mailing list.</p></li>
                   9958: </ul></div>
                   9959: </td>
                   9960: </tr>
                   9961: </tbody>
                   9962: </table>
                   9963: </div>
                   9964: </div>
1.41      asau     9965: <div class="chapter">
1.1       dsieger  9966: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9967: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9968: <div class="toc">
                   9969: <p><b>Table of Contents</b></p>
                   9970: <dl>
1.6       rillig   9971: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9972: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9973: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9974: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9975: </dl>
                   9976: </div>
1.10      hubertf  9977: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9978: site</a>:</p>
                   9979: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9980:   environment, an intuitive and attractive desktop for users, and the
                   9981:   GNOME development platform, an extensive framework for building
                   9982:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9983: <p>pkgsrc provides a seamless way to automatically build and install
                   9984: a complete GNOME environment <span class="emphasis"><em>under many different
                   9985: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9986: the most advanced build and packaging systems for GNOME due to its
                   9987: included technologies buildlink3, the wrappers and tools framework and
                   9988: automatic configuration file management.  Lots of efforts are put into
                   9989: achieving a completely clean deinstallation of installed software
                   9990: components.</p>
1.10      hubertf  9991: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9992: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9993: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9994: pkgsrc as its preferred packaging system, contributing lots of
                   9995: portability fixes to make GNOME build and install under it.</p>
                   9996: <p>This chapter is aimed at pkgsrc developers and other people
                   9997: interested in helping our GNOME porting and packaging efforts.  It
                   9998: provides instructions on how to manage the existing packages and some
                   9999: important information regarding their internals.</p>
1.41      asau     10000: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10001: <h3 class="title">We need your help!</h3>
                   10002: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   10003:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  10004:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  10005:   work</a> list!  There is still a long way to go to get a
                   10006:   fully-functional GNOME desktop under NetBSD and we need your help to
                   10007:   achieve it!</p>
                   10008: </div>
1.41      asau     10009: <div class="sect1">
1.1       dsieger  10010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10011: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  10012: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41      asau     10013: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10014: <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  10015:     the core GNOME desktop environment.  It only includes the necessary
                   10016:     bits to get it to boot correctly, although it may lack important
                   10017:     functionality for daily operation.  The idea behind this package is
                   10018:     to let end users build their own configurations on top of this one,
                   10019:     first installing this meta package to achieve a functional setup and
                   10020:     then adding individual applications.</p></li>
1.23      wiz      10021: <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  10022:     complete installation of the GNOME platform and desktop as defined
                   10023:     by the GNOME project; this is based on the components distributed in
                   10024:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   10025:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   10026:     official FTP server.  Developer-only tools found in those
                   10027:     directories are not installed unless required by some other
                   10028:     component to work properly.  Similarly, packages from the bindings
                   10029:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   10030:     in unless required as a dependency for an end-user component.  This
                   10031:     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      10032: <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  10033:     Installs all the tools required to build a GNOME component when
                   10034:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  10035:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  10036: </ul></div>
                   10037: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   10038: sorted in a way that eases updates: a package may depend on other
                   10039: packages listed before it but not on any listed after it.  It is very
                   10040: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   10041: change it to alphabetical sorting!</em></span></p>
                   10042: </div>
1.41      asau     10043: <div class="sect1">
1.1       dsieger  10044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10045: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  10046: <p>Almost all GNOME applications are written in C and use a common
                   10047: set of tools as their build system.  Things get different with the new
                   10048: bindings to other languages (such as Python), but the following will
                   10049: give you a general idea on the minimum required tools:</p>
1.41      asau     10050: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10051: <li class="listitem">
1.1       dsieger  10052: <p>Almost all GNOME applications use the GNU Autotools as their
                   10053:     build system.  As a general rule you will need to tell this to your
                   10054:     package:</p>
                   10055: <pre class="programlisting">
                   10056: GNU_CONFIGURE=yes
                   10057: USE_LIBTOOL=yes
                   10058: USE_TOOLS+=gmake
                   10059: </pre>
                   10060: </li>
1.23      wiz      10061: <li class="listitem">
1.1       dsieger  10062: <p>If the package uses pkg-config to detect dependencies, add this
                   10063:     tool to the list of required utilities:</p>
                   10064: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   10065: <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
                   10066:     the end of the build process to ensure that you did not miss to
                   10067:     specify any dependency in your package and that the version
                   10068:     requirements are all correct.</p>
                   10069: </li>
1.23      wiz      10070: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  10071:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   10072:     to handle dependencies and to force the package to use the latest
                   10073:     available version.</p></li>
1.23      wiz      10074: <li class="listitem">
1.1       dsieger  10075: <p>If the package uses gtk-doc (a documentation generation
                   10076:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   10077:     tool is rather big and the distfile should come with pregenerated
                   10078:     documentation anyway; if it does not, it is a bug that you ought to
                   10079:     report.  For such packages you should disable gtk-doc (unless it is
                   10080:     the default):</p>
                   10081: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   10082: <p>The default location of installed HTML files
                   10083:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   10084:     and should not be changed unless the package insists on installing
                   10085:     them somewhere else.  Otherwise programs as
1.10      hubertf  10086:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  10087:     do that with an entry similar to:</p>
                   10088: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   10089: </li>
                   10090: </ul></div>
                   10091: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10092: files under the installation prefix to maintain databases.  In this
                   10093: context, shared means that those exact same directories and files are
                   10094: used among several different packages, leading to conflicts in the
                   10095: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10096: handle the most common cases, so you have to forget about using
                   10097: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10098: omitting shared files from them.  If you find yourself doing those,
                   10099: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10100: <p>The following table lists the common situations that result in
                   10101: using shared directories or files.  For each of them, the appropriate
                   10102: solution is given.  After applying the solution be sure to
                   10103: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  10104: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  10105: <div class="table">
1.6       rillig   10106: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  10107: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   10108: <colgroup>
                   10109: <col>
                   10110: <col>
                   10111: </colgroup>
                   10112: <thead><tr>
                   10113: <th>If the package...</th>
                   10114: <th>Then...</th>
                   10115: </tr></thead>
                   10116: <tbody>
                   10117: <tr>
                   10118: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18      snj      10119: <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  10120: </tr>
                   10121: <tr>
                   10122: <td>Installs icons under the
                   10123:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10124:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  10125: <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  10126: </tr>
                   10127: <tr>
                   10128: <td>Installs files under
                   10129:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  10130: <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  10131: </tr>
                   10132: <tr>
                   10133: <td>Installs <code class="filename">.desktop</code> files under
                   10134:         <code class="filename">share/applications</code> and these include MIME
                   10135:         information.</td>
1.10      hubertf  10136: <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  10137: </tr>
                   10138: </tbody>
                   10139: </table></div>
                   10140: </div>
                   10141: <br class="table-break">
                   10142: </div>
1.41      asau     10143: <div class="sect1">
1.1       dsieger  10144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10145: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  10146: <p>When seeing GNOME as a whole, there are two kinds of
                   10147: updates:</p>
1.41      asau     10148: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10149: <dt><span class="term">Major update</span></dt>
                   10150: <dd>
                   10151: <p>Given that there is still a very long way for GNOME 3 (if it
                   10152:       ever appears), we consider a major update one that goes from a
                   10153:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10154:       where <code class="literal">Y</code> is even and greater than
                   10155:       <code class="literal">X</code>.  These are hard to achieve because they
                   10156:       introduce lots of changes in the components' code and almost all
                   10157:       GNOME distfiles are updated to newer versions.  Some of them can
                   10158:       even break API and ABI compatibility with the previous major
                   10159:       version series.  As a result, the update needs to be done all at
                   10160:       once to minimize breakage.</p>
                   10161: <p>A major update typically consists of around 80 package
                   10162:       updates and the addition of some new ones.</p>
                   10163: </dd>
                   10164: <dt><span class="term">Minor update</span></dt>
                   10165: <dd>
                   10166: <p>We consider a minor update one that goes from a
                   10167:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10168:       one where <code class="literal">Y</code> is greater than
                   10169:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10170:       not update all GNOME components, can be done in an incremental way
                   10171:       and do not break API nor ABI compatibility.</p>
                   10172: <p>A minor update typically consists of around 50 package
                   10173:       updates, although the numbers here may vary a lot.</p>
                   10174: </dd>
                   10175: </dl></div>
                   10176: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10177: release (either major or minor), the following steps should be
                   10178: followed:</p>
1.23      wiz      10179: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10180: <li class="listitem">
1.1       dsieger  10181: <p>Get a list of all the tarballs that form the new release by
                   10182:     using the following commands.  These will leave the full list of the
1.18      snj      10183:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  10184:     file:</p>
                   10185: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10186:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10187:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10188: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10189:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10190:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10191: </li>
1.23      wiz      10192: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  10193:     bump their version to the release you are updating them to.  The
                   10194:     three meta packages should be always consistent with versioning.
                   10195:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10196:     in them.</p></li>
1.23      wiz      10197: <li class="listitem">
1.1       dsieger  10198: <p>For each meta package, update all its
                   10199:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10200:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10201:     newer version (even if found in the FTP) because the meta packages
                   10202:     are supposed to list the exact versions that form a specific GNOME
                   10203:     release.  Exceptions are permitted here if a newer version solves a
                   10204:     serious issue in the overall desktop experience; these typically
                   10205:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10206:     from the developers.</p>
                   10207: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10208:     should be updated to the latest version available (if found in
                   10209:     pkgsrc).  This is the case, for example, of the dependencies on the
                   10210:     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>
                   10211: </li>
1.23      wiz      10212: <li class="listitem">
1.1       dsieger  10213: <p>Generate a patch from the modified meta packages and extract the
                   10214:     list of "new" lines.  This will provide you an outline on what
                   10215:     packages need to be updated in pkgsrc and in what order:</p>
                   10216: <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>
                   10217: </li>
1.23      wiz      10218: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  10219:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      10220: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  10221:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10222:     it in order.  For major desktop updates none of these should be
                   10223:     committed until the entire set is completed because there are chances
                   10224:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      10225: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  10226:     the tree one by one with appropriate log messages.  At the end,
                   10227:     commit the three meta package updates and all the corresponding
                   10228:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10229:     <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>
                   10230: </ol></div>
                   10231: </div>
1.41      asau     10232: <div class="sect1">
1.1       dsieger  10233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10234: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  10235: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10236: packages.  Please, it is very important that you always, always,
                   10237: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  10238: 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  10239: their attention on portability issues and to ensure that future versions
                   10240: can be built out-of-the box on NetBSD.  The less custom patches in
                   10241: pkgsrc, the easier further updates are.  Those developers in charge of
                   10242: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  10243: <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  10244: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10245: of them do.  Do not be short on your reports: always provide detailed
                   10246: explanations of the current failure, how it can be improved to achieve
                   10247: maximum portability and, if at all possible, provide a patch against CVS
                   10248: head.  The more verbose you are, the higher chances of your patch being
                   10249: accepted.</p>
                   10250: <p>Also, please avoid using preprocessor magic to fix portability
                   10251: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10252: GNOME to their operating system, the official GNOME sources are now
                   10253: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10254: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  10255: 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  10256: details.</p>
                   10257: </div>
                   10258: </div>
                   10259: </div>
1.41      asau     10260: <div class="part">
1.1       dsieger  10261: <div class="titlepage"><div><div><h1 class="title">
                   10262: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     10263: <div class="partintro">
1.1       dsieger  10264: <div></div>
                   10265: <p>This part of the guide deals with everything
                   10266:        from the infrastructure that is behind the interfaces described
                   10267:        in the developer's guide. A casual package maintainer should not
                   10268:        need anything from this part.</p>
                   10269: <div class="toc">
                   10270: <p><b>Table of Contents</b></p>
                   10271: <dl>
1.6       rillig   10272: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10273: <dd><dl>
1.6       rillig   10274: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10275: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10276: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10277: <dd><dl>
1.6       rillig   10278: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10279: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10280: </dl></dd>
1.6       rillig   10281: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10282: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10283: <dd><dl>
1.6       rillig   10284: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10285: <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  10286: </dl></dd>
1.6       rillig   10287: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10288: <dd><dl>
1.23      wiz      10289: <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>
                   10290: <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  10291: </dl></dd>
                   10292: </dl></dd>
1.6       rillig   10293: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10294: <dd><dl>
1.6       rillig   10295: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10296: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10297: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10298: <dd><dl>
1.6       rillig   10299: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10300: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10301: </dl></dd>
                   10302: </dl></dd>
1.6       rillig   10303: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10304: <dd><dl>
1.6       rillig   10305: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10306: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10307: </dl></dd>
                   10308: </dl>
                   10309: </div>
                   10310: </div>
1.41      asau     10311: <div class="chapter">
1.1       dsieger  10312: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10313: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10314: <div class="toc">
                   10315: <p><b>Table of Contents</b></p>
                   10316: <dl>
1.6       rillig   10317: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10318: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10319: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10320: <dd><dl>
1.6       rillig   10321: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10322: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10323: </dl></dd>
1.6       rillig   10324: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10325: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10326: <dd><dl>
1.6       rillig   10327: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10328: <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  10329: </dl></dd>
1.6       rillig   10330: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10331: <dd><dl>
1.23      wiz      10332: <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>
                   10333: <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  10334: </dl></dd>
                   10335: </dl>
                   10336: </div>
                   10337: <p>The pkgsrc infrastructure consists of many small Makefile
                   10338:        fragments. Each such fragment needs a properly specified
                   10339:        interface. This chapter explains how such an interface looks
                   10340:        like.</p>
1.41      asau     10341: <div class="sect1">
1.1       dsieger  10342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10343: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10344: <p>Whenever a variable is defined in the pkgsrc
                   10345:        infrastructure, the location and the way of definition provide
                   10346:        much information about the intended use of that variable.
                   10347:        Additionally, more documentation may be found in a header
                   10348:        comment or in this pkgsrc guide.</p>
                   10349: <p>A special file is
                   10350:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10351:        variables that are intended to be user-defined. They are either
                   10352:        defined using the <code class="literal">?=</code> operator or they are
                   10353:        left undefined because defining them to anything would
1.23      wiz      10354:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10355:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10356:        file.</p>
                   10357: <p>Outside this file, the following conventions apply:
                   10358:        Variables that are defined using the <code class="literal">?=</code>
                   10359:        operator may be overridden by a package.</p>
                   10360: <p>Variables that are defined using the <code class="literal">=</code>
                   10361:        operator may be used read-only at run-time.</p>
                   10362: <p>Variables whose name starts with an underscore must not be
                   10363:        accessed outside the pkgsrc infrastructure at all. They may
                   10364:        change without further notice.</p>
1.41      asau     10365: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10366: <h3 class="title">Note</h3>
                   10367: <p>These conventions are currently not applied
                   10368:        consistently to the complete pkgsrc
                   10369:        infrastructure.</p>
                   10370: </div>
                   10371: </div>
1.41      asau     10372: <div class="sect1">
1.1       dsieger  10373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10374: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10375: <p>All variables that contain lists of things should default
                   10376:        to being empty. Two examples that do not follow this rule are
                   10377:        <code class="varname">USE_LANGUAGES</code> and
                   10378:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10379:        modified using the <code class="literal">+=</code> operator in package
                   10380:        <code class="filename">Makefile</code>s (or other files included by
                   10381:        them), since there is no guarantee whether the variable is
                   10382:        already set or not, and what its value is. In the case of
1.23      wiz      10383:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10384:        the default value and just define it as in the following
                   10385:        example.</p>
                   10386: <pre class="programlisting">
                   10387: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10388: </pre>
                   10389: <p>Because of the selection of this default value, the same
                   10390:        value appears in many package Makefiles. Similarly for
                   10391:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10392:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10393:        doesn't stand out. Nevertheless it is mentioned in many
                   10394:        files.</p>
                   10395: </div>
1.41      asau     10396: <div class="sect1">
1.1       dsieger  10397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10398: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41      asau     10399: <div class="sect2">
1.1       dsieger  10400: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10401: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10402: <p>Variable evaluation takes place either at load time or at
                   10403:        runtime, depending on the context in which they occur. The
                   10404:        contexts where variables are evaluated at load time are:</p>
1.41      asau     10405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10406: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10407:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10408: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10409:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10410: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10411: </ul></div>
                   10412: <p>A special exception are references to the iteration
                   10413:        variables of <code class="literal">.for</code> loops, which are expanded
                   10414:        inline, no matter in which context they appear.</p>
                   10415: <p>As the values of variables may change during load time,
                   10416:        care must be taken not to evaluate them by accident. Typical
                   10417:        examples for variables that should not be evaluated at load time
                   10418:        are <code class="varname">DEPENDS</code> and
                   10419:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10420:        clear, here is an example:</p>
                   10421: <pre class="programlisting">
                   10422: CONFIGURE_ARGS=         # none
                   10423: CFLAGS=                 -O
                   10424: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10425: 
                   10426: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10427: 
                   10428: CFLAGS+=                -Wall
                   10429:        </pre>
                   10430: <p>This code shows how the use of the <code class="literal">:=</code>
                   10431:        operator can quickly lead to unexpected results. The first
                   10432:        paragraph is fairly common code. The second paragraph evaluates
                   10433:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10434:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10435:        <code class="literal">-Wall</code> is appended to the
                   10436:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10437:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10438:        paragraphs from above typically occur in completely unrelated
                   10439:        files.</p>
                   10440: </div>
1.41      asau     10441: <div class="sect2">
1.1       dsieger  10442: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10443: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10444: <p>After all the files have been loaded, the values of the
                   10445:        variables cannot be changed anymore. Variables that are used in
                   10446:        the shell commands are expanded at this point.</p>
                   10447: </div>
                   10448: </div>
1.41      asau     10449: <div class="sect1">
1.1       dsieger  10450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10451: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10452: <p>There are many ways in which the definition and use of a
                   10453:        variable can be restricted in order to detect bugs and
                   10454:        violations of the (mostly unwritten) policies. See the
                   10455:        <code class="literal">pkglint</code> developer's documentation for further
                   10456:        details.</p>
                   10457: </div>
1.41      asau     10458: <div class="sect1">
1.1       dsieger  10459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10460: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10461: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10462:        of the following classes. Cases where a file falls into more
                   10463:        than one class should be avoided as it often leads to subtle
                   10464:        bugs.</p>
1.41      asau     10465: <div class="sect2">
1.1       dsieger  10466: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10467: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10468: <p>In a traditional imperative programming language some of
                   10469:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10470:        procedures. They take some input parameters and&mdash;after
                   10471:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10472:        variables in <code class="filename">Makefile</code>s have global scope
                   10473:        care must be taken not to use parameter names that have already
                   10474:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10475:        bad choice for a parameter name.</p>
                   10476: <p>Procedures are completely evaluated at preprocessing time.
                   10477:        That is, when calling a procedure all input parameters must be
                   10478:        completely resolvable. For example,
                   10479:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10480:        parameter since it is very likely that further text will be
                   10481:        added after calling the procedure, which would effectively apply
                   10482:        the procedure to only a part of the variable. Also, references
                   10483:        to other variables wit will be modified after calling the
                   10484:        procedure.</p>
                   10485: <p>A procedure can declare its output parameters either as
                   10486:        suitable for use in preprocessing directives or as only
                   10487:        available at runtime. The latter alternative is for variables
                   10488:        that contain references to other runtime variables.</p>
                   10489: <p>Procedures shall be written such that it is possible to
                   10490:        call the procedure more than once. That is, the file must not
                   10491:        contain multiple-inclusion guards.</p>
                   10492: <p>Examples for procedures are
                   10493:        <code class="filename">mk/bsd.options.mk</code> and
                   10494:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10495:        that the parameters are evaluated at load time, they should be
                   10496:        assigned using the <code class="literal">:=</code> operator, which should
                   10497:        be used only for this purpose.</p>
                   10498: </div>
1.41      asau     10499: <div class="sect2">
1.1       dsieger  10500: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10501: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10502: <p>Action files take some input parameters and may define
                   10503:        runtime variables. They shall not define loadtime variables.
                   10504:        There are action files that are included implicitly by the
                   10505:        pkgsrc infrastructure, while other must be included
                   10506:        explicitly.</p>
                   10507: <p>An example for action files is
                   10508:        <code class="filename">mk/subst.mk</code>.</p>
                   10509: </div>
                   10510: </div>
1.41      asau     10511: <div class="sect1">
1.1       dsieger  10512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10513: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10514: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10515:        a set of variable definitions, and include the file
                   10516:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10517:        Before that, they may also include various other
                   10518:        <code class="filename">*.mk</code> files if they need to query the
                   10519:        availability of certain features like the type of compiler or
                   10520:        the X11 implementation. Due to the heavy use of preprocessor
                   10521:        directives like <code class="literal">.if</code> and
                   10522:        <code class="literal">.for</code>, the order in which the files are loaded
                   10523:        matters.</p>
                   10524: <p>This section describes at which point the various files
                   10525:        are loaded and gives reasons for that order.</p>
1.41      asau     10526: <div class="sect2">
1.1       dsieger  10527: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10528: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10529: </h3></div></div></div>
                   10530: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10531:        is to define some essential variables like
                   10532:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10533:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10534: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10535:        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   10536:        After that, those variables
1.1       dsieger  10537:        that have not been overridden by the user are loaded from
                   10538:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10539: <p>After the user settings, the system settings and platform
                   10540:        settings are loaded, which may override the user
                   10541:        settings.</p>
                   10542: <p>Then, the tool definitions are loaded. The tool wrappers
                   10543:        are not yet in effect. This only happens when building a
                   10544:        package, so the proper variables must be used instead of the
                   10545:        direct tool names.</p>
                   10546: <p>As the last steps, some essential variables from the
                   10547:        wrapper and the package system flavor are loaded, as well as the
                   10548:        variables that have been cached in earlier phases of a package
                   10549:        build.</p>
                   10550: </div>
1.41      asau     10551: <div class="sect2">
1.1       dsieger  10552: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10553: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10554: </h3></div></div></div>
                   10555: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10556: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10557:        loaded, which fill default values for those variables that have
                   10558:        not been defined by the package. These variables may later
                   10559:        be used even in unrelated files.</p>
                   10560: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10561:        provides the target <code class="literal">error-check</code> that is added
                   10562:        as a special dependency to all other targets that use
                   10563:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10564:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10565: <p>Then, the package-specific hacks from
                   10566:        <code class="filename">hacks.mk</code> are included.</p>
                   10567: <p>Then, various other files follow. Most of them don't have
                   10568:        any dependencies on what they need to have included before or
                   10569:        after them, though some do.</p>
                   10570: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10571:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10572:        restricts the use of these variables to all the files that have
                   10573:        been included before. Appearances in later files will be
                   10574:        silently ignored.</p>
                   10575: <p>Then, the files for the main targets are included, in the
                   10576:        order of later execution, though the actual order should not
                   10577:        matter.</p>
                   10578: <p>At last, some more files are included that don't set any
                   10579:        interesting variables but rather just define make targets to be
                   10580:        executed.</p>
                   10581: </div>
                   10582: </div>
                   10583: </div>
1.41      asau     10584: <div class="chapter">
1.1       dsieger  10585: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10586: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10587: <div class="toc">
                   10588: <p><b>Table of Contents</b></p>
                   10589: <dl>
1.6       rillig   10590: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10591: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10592: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10593: <dd><dl>
1.6       rillig   10594: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10595: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10596: </dl></dd>
                   10597: </dl>
                   10598: </div>
                   10599: <p>The pkgsrc infrastructure consists of a large codebase,
                   10600:        and there are many corners where every little bit of a file is
                   10601:        well thought out, making pkgsrc likely to fail as soon as
                   10602:        anything is changed near those parts. To prevent most changes
                   10603:        from breaking anything, a suite of regression tests should go
                   10604:        along with every important part of the pkgsrc infrastructure.
                   10605:        This chapter describes how regression tests work in pkgsrc and
                   10606:        how you can add new tests.</p>
1.41      asau     10607: <div class="sect1">
1.1       dsieger  10608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10609: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10610: <p></p>
                   10611: </div>
1.41      asau     10612: <div class="sect1">
1.1       dsieger  10613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10614: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10615: <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  10616:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10617:        can simply run that command, which will run all tests in the
                   10618:        <code class="filename">regress</code> category.</p>
                   10619: </div>
1.41      asau     10620: <div class="sect1">
1.1       dsieger  10621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10622: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10623: <p>Every directory in the <code class="filename">regress</code>
                   10624:        category that contains a file called <code class="filename">spec</code>
                   10625:        is considered a regression test. This file is a shell program
1.10      hubertf  10626:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10627:        The following functions can be overridden to suit your
                   10628:        needs.</p>
1.41      asau     10629: <div class="sect2">
1.1       dsieger  10630: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10631: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10632: <p>These functions do not take any parameters. They are all
1.23      wiz      10633:        called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
1.1       dsieger  10634:        to check the exitcodes of any commands you run in the
                   10635:        test.</p>
1.41      asau     10636: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10637: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10638: <dd><p>This function prepares the environment for the
                   10639:        test. By default it does nothing.</p></dd>
                   10640: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10641: <dd><p>This function runs the actual test. By default,
                   10642:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10643:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10644:        error messages into the file
                   10645:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10646: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10647: <dd><p>This function is run after the test and is
                   10648:        typically used to compare the actual output from the one that is
                   10649:        expected. It can make use of the various helper functions from
                   10650:        the next section.</p></dd>
                   10651: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10652: <dd><p>This function cleans everything up after the
                   10653:        test has been run. By default it does nothing.</p></dd>
                   10654: </dl></div>
                   10655: </div>
1.41      asau     10656: <div class="sect2">
1.1       dsieger  10657: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10658: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41      asau     10659: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10660: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10661: <dd><p>This function compares the exitcode of the
1.10      hubertf  10662:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1       dsieger  10663:        If they differ, the test will fail.</p></dd>
                   10664: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10665: <dd><p>This function checks for each of its parameters
1.10      hubertf  10666:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1       dsieger  10667:        extended regular expression. If it does not, the test will
                   10668:        fail.</p></dd>
                   10669: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10670: <dd><p>This function checks for each of its parameters
1.10      hubertf  10671:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10672:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10673:        If any of the regular expressions matches, the test will
                   10674:        fail.</p></dd>
                   10675: </dl></div>
                   10676: </div>
                   10677: </div>
                   10678: </div>
1.41      asau     10679: <div class="chapter">
1.1       dsieger  10680: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10681: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10682: <div class="toc">
                   10683: <p><b>Table of Contents</b></p>
                   10684: <dl>
1.6       rillig   10685: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10686: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10687: </dl>
                   10688: </div>
                   10689: <p>The pkgsrc system has already been ported to many
                   10690:        operating systems, hardware architectures and compilers. This
                   10691:        chapter explains the necessary steps to make pkgsrc even more
                   10692:        portable.</p>
1.41      asau     10693: <div class="sect1">
1.1       dsieger  10694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10695: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10696: <p>To port pkgsrc to a new operating system (called
                   10697:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10698:        following files:</p>
1.41      asau     10699: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10700: <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>
                   10701: <dd><p>This file contains some basic definitions, for
                   10702:        example the name of the C
                   10703:        compiler.</p></dd>
                   10704: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10705: <dd><p>Insert code that defines the variables
                   10706:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10707:        <code class="varname">LOWER_OS_VERSION</code>,
                   10708:        <code class="varname">LOWER_VENDOR</code>,
                   10709:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10710:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10711:        appear in this file.</p></dd>
                   10712: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10713: <dd><p>This file contains the platform-specific
                   10714:        definitions that are used by pkgsrc. Start by copying one of the
                   10715:        other files and edit it to your
                   10716:        needs.</p></dd>
                   10717: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10718: <dd><p>This file contains a list of directories,
                   10719:        together with their permission bits and ownership. These
                   10720:        directories will be created automatically with every package
                   10721:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10722:        be removed.</p></dd>
                   10723: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10724: <dd><p>Just copy one of the pre-existing x11.dist files
                   10725:        to your
                   10726:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10727: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10728: <dd><p>On some operating systems, the tools that are
                   10729:        provided with the base system are not good enough for pkgsrc.
1.29      dholland 10730:        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  10731:        narrow limit on the line length they can process. Therefore
                   10732:        pkgsrc brings its own tools, which can be enabled
                   10733:        here.</p></dd>
                   10734: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10735: <dd><p>This file defines the paths to all the tools
                   10736:        that are needed by one or the other package in pkgsrc, as well
                   10737:        as by pkgsrc itself. Find out where these tools are on your
                   10738:        platform and add them.</p></dd>
                   10739: </dl></div>
                   10740: <p>Now, you should be able to build some basic packages, like
                   10741:        <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>
                   10742: </div>
1.41      asau     10743: <div class="sect1">
1.1       dsieger  10744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10745: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10746: <p>TODO</p>
                   10747: </div>
                   10748: </div>
                   10749: </div>
1.41      asau     10750: <div class="appendix">
                   10751: <div class="titlepage"><div><div><h1 class="title">
                   10752: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  10753: <div class="toc">
                   10754: <p><b>Table of Contents</b></p>
                   10755: <dl>
                   10756: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10757: <dd><dl>
                   10758: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10759: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10760: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10761: <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  10762: </dl></dd>
                   10763: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10764: </dl>
                   10765: </div>
                   10766: <p>We checked to find a piece of software that wasn't in the packages
                   10767:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10768:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10769:     present in the tree is beyond us, but it's useful for the purposes of
                   10770:     this exercise.</p>
1.41      asau     10771: <div class="sect1">
1.1       dsieger  10772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10773: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     10774: <div class="sect2">
1.1       dsieger  10775: <div class="titlepage"><div><div><h3 class="title">
                   10776: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10777: <pre class="programlisting">
                   10778: # $NetBSD$
                   10779: #
                   10780: 
                   10781: DISTNAME=       bison-1.25
                   10782: CATEGORIES=     devel
                   10783: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10784: 
1.29      dholland 10785: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10786: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10787: COMMENT=        GNU yacc clone
                   10788: 
                   10789: GNU_CONFIGURE=  yes
1.46      wiz      10790: INFO_FILES=     yes
1.1       dsieger  10791: 
                   10792: .include "../../mk/bsd.pkg.mk"
                   10793: </pre>
                   10794: </div>
1.41      asau     10795: <div class="sect2">
1.1       dsieger  10796: <div class="titlepage"><div><div><h3 class="title">
                   10797: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10798: <pre class="programlisting">
                   10799: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.29      dholland 10800: 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  10801: of the NetBSD source tree is beyond me.
                   10802: </pre>
                   10803: </div>
1.41      asau     10804: <div class="sect2">
1.1       dsieger  10805: <div class="titlepage"><div><div><h3 class="title">
                   10806: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10807: <pre class="programlisting">
                   10808: @comment $NetBSD$
                   10809: bin/bison
                   10810: man/man1/bison.1.gz
                   10811: share/bison.simple
                   10812: share/bison.hairy
                   10813: </pre>
                   10814: </div>
1.41      asau     10815: <div class="sect2">
1.1       dsieger  10816: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10817: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10818: </h3></div></div></div>
                   10819: <p>The NetBSD package system comes with
                   10820:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10821:        which helps to check the contents of these
                   10822:        files. After installation it is quite easy to use, just change to the
                   10823:        directory of the package you wish to examine and execute
1.10      hubertf  10824:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10825: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10826: looks fine.</pre>
                   10827: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10828:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10829:        -Wall</strong></span> for a very thorough check.</p>
                   10830: </div>
                   10831: </div>
1.41      asau     10832: <div class="sect1">
1.1       dsieger  10833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10834: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10835: <p>Create the directory where the package lives,
                   10836:       plus any auxiliary directories:</p>
                   10837: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10838: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10839: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10840: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10841: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  10842:       <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  10843:       then continue with fetching the distfile:</p>
                   10844: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10845: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10846: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10847: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10848: ftp: Error retrieving file: 500 Internal error
                   10849: 
                   10850: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10851: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10852: ftp: Error retrieving file: 500 Internal error
                   10853: 
                   10854: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10855: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10856: Successfully retrieved file.</pre>
                   10857: <p>Generate the checksum of the distfile into
                   10858:       <code class="filename">distinfo</code>:</p>
                   10859: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10860: <p>Now compile:</p>
                   10861: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10862: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10863: ===&gt;  Extracting for bison-1.25
                   10864: ===&gt;  Patching for bison-1.25
                   10865: ===&gt;   Ignoring empty patch directory
                   10866: ===&gt;  Configuring for bison-1.25
                   10867: creating cache ./config.cache
                   10868: checking for gcc... cc
                   10869: checking whether we are using GNU C... yes
                   10870: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10871: checking how to run the C preprocessor... cc -E
                   10872: checking for minix/config.h... no
                   10873: checking for POSIXized ISC... no
                   10874: checking whether cross-compiling... no
                   10875: checking for ANSI C header files... yes
                   10876: checking for string.h... yes
                   10877: checking for stdlib.h... yes
                   10878: checking for memory.h... yes
                   10879: checking for working const... yes
                   10880: checking for working alloca.h... no
                   10881: checking for alloca... yes
                   10882: checking for strerror... yes
                   10883: updating cache ./config.cache
                   10884: creating ./config.status
                   10885: creating Makefile
                   10886: ===&gt;  Building for bison-1.25
                   10887: 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
                   10888: 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
                   10889: 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
                   10890: 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
                   10891: 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
                   10892: 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
                   10893: 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
                   10894: 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
                   10895: 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
                   10896: 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
                   10897: 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
                   10898: 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
                   10899: 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
                   10900: 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
                   10901: 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
                   10902: 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
                   10903: 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
                   10904: 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
                   10905: 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
                   10906: 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
                   10907: 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
                   10908: 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
                   10909: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10910: rm -f bison.s1
                   10911: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10912: <p>Everything seems OK, so install the files:</p>
                   10913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10914: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10915: ===&gt;  Installing for bison-1.25
                   10916: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10917: rm -f /usr/pkg/bin/bison
                   10918: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10919: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10920: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10921: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10922: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10923: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10924: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10925: ===&gt;  Registering installation for bison-1.25</pre>
                   10926: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10927:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10928:       binary package, do this now:</p>
                   10929: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10930: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10931: ===&gt;  Building package for bison-1.25
                   10932: Creating package bison-1.25.tgz
                   10933: Registering depends:.
                   10934: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10935: <p>Now that you don't need the source and object files
                   10936:       any more, clean up:</p>
                   10937: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10938: ===&gt;  Cleaning for bison-1.25</pre>
                   10939: </div>
                   10940: </div>
1.41      asau     10941: <div class="appendix">
                   10942: <div class="titlepage"><div><div><h1 class="title">
                   10943: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1       dsieger  10944: <div class="toc">
                   10945: <p><b>Table of Contents</b></p>
                   10946: <dl>
                   10947: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10948: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10949: </dl>
                   10950: </div>
1.41      asau     10951: <div class="sect1">
1.1       dsieger  10952: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10953: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10954: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10955: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10956: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10957: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10958: =&gt; [172219 bytes]
                   10959: Connected to ftp.plig.net.
                   10960: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10961: 331 Guest login ok, send your complete e-mail address as password.
                   10962: 230-You are user #5 of 500 simultaneous users allowed.
                   10963: 230-
                   10964: 230-  ___ _             _ _
                   10965: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10966: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10967: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10968: 230-         |_|   |_|     |___|         |___|
                   10969: 230-
                   10970: 230-** Welcome to ftp.plig.org **
                   10971: 230-
                   10972: 230-Please note that all transfers from this FTP site are logged. If you
                   10973: 230-do not like this, please disconnect now.
                   10974: 230-
1.18      snj      10975: 230-This archive is available via
1.1       dsieger  10976: 230-
                   10977: 230-HTTP:  http://ftp.plig.org/
                   10978: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10979: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10980: 230-
                   10981: 230-Please email comments, bug reports and requests for packages to be
                   10982: 230-mirrored to ftp-admin@plig.org.
                   10983: 230-
                   10984: 230-
                   10985: 230 Logged in anonymously.
                   10986: Remote system type is UNIX.
                   10987: Using binary mode to transfer files.
                   10988: 200 Type okay.
                   10989: 250 "/pub" is new cwd.
                   10990: 250-"/pub/figlet" is new cwd.
                   10991: 250-
                   10992: 250-Welcome to the figlet archive at ftp.figlet.org
                   10993: 250-
                   10994: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10995: 250-
                   10996: 250-The official FIGlet web page is:
                   10997: 250-   http://www.figlet.org/
                   10998: 250-
                   10999: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   11000: 250-contribute a font or something else, you can email us.
                   11001: 250
                   11002: 250 "/pub/figlet/program" is new cwd.
                   11003: 250 "/pub/figlet/program/unix" is new cwd.
                   11004: local: figlet221.tar.gz remote: figlet221.tar.gz
                   11005: 502 Unimplemented command.
                   11006: 227 Entering Passive Mode (195,40,6,41,246,104)
                   11007: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   11008: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   11009: 226 Transfer completed.
                   11010: 172219 bytes received in 00:02 (75.99 KB/s)
                   11011: 221 Goodbye.
                   11012: =&gt; Checksum OK for figlet221.tar.gz.
                   11013: ===&gt; Extracting for figlet-2.2.1nb2
                   11014: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   11015: ===&gt; Patching for figlet-2.2.1nb2
                   11016: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   11017: ===&gt; Overriding tools for figlet-2.2.1nb2
                   11018: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   11019: ===&gt; Configuring for figlet-2.2.1nb2
                   11020: ===&gt; Building for figlet-2.2.1nb2
                   11021: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   11022: chmod a+x figlet
                   11023: gcc -O2 -o chkfont chkfont.c
                   11024: =&gt; Unwrapping files-to-be-installed.
                   11025: <code class="prompt">#</code>
                   11026: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   11027: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11028: ===&gt; Installing for figlet-2.2.1nb2
                   11029: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   11030: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   11031: mkdir -p /usr/pkg/share/figlet
                   11032: cp figlet /usr/pkg/bin
                   11033: cp chkfont /usr/pkg/bin
                   11034: chmod 555 figlist showfigfonts
                   11035: cp figlist /usr/pkg/bin
                   11036: cp showfigfonts /usr/pkg/bin
                   11037: cp fonts/*.flf /usr/pkg/share/figlet
                   11038: cp fonts/*.flc /usr/pkg/share/figlet
                   11039: cp figlet.6 /usr/pkg/man/man6
                   11040: ===&gt; Registering installation for figlet-2.2.1nb2
                   11041: <code class="prompt">#</code></pre>
                   11042: </div>
1.41      asau     11043: <div class="sect1">
1.1       dsieger  11044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11045: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   11046: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   11047: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11048: ===&gt; Packaging figlet-2.2.1nb2
                   11049: ===&gt; Building binary package for figlet-2.2.1nb2
                   11050: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11051: Using SrcDir value of /usr/pkg
                   11052: Registering depends:.
                   11053: <code class="prompt">#</code></pre>
                   11054: </div>
                   11055: </div>
1.41      asau     11056: <div class="appendix">
                   11057: <div class="titlepage"><div><div><h1 class="title">
                   11058: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1       dsieger  11059: <div class="toc">
                   11060: <p><b>Table of Contents</b></p>
                   11061: <dl>
1.23      wiz      11062: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11063: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11064: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11065: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11066: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   11067: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11068: source packages</a></span></dt>
                   11069: </dl>
                   11070: </div>
                   11071: <p>As in other big projects, the directory layout of pkgsrc
                   11072:        is quite complex for newbies. This chapter explains where you
                   11073:        find things on the FTP server. The base directory on
1.10      hubertf  11074:        <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  11075:        On other servers it may be different, but inside this directory,
                   11076:        everything should look the same, no matter on which server you
                   11077:        are. This directory contains some subdirectories, which are
                   11078:        explained below.</p>
1.41      asau     11079: <div class="sect1">
1.1       dsieger  11080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11081: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  11082: <p>The directory <code class="filename">distfiles</code> contains lots
                   11083:        of archive files from all pkgsrc packages, which are mirrored
                   11084:        here. The subdirectories are called after their package names
                   11085:        and are used when the distributed files have names that don't
                   11086:        explicitly contain a version number or are otherwise too generic
                   11087:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11088: </div>
1.41      asau     11089: <div class="sect1">
1.1       dsieger  11090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11091: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  11092: <p>This directory contains things that individual pkgsrc
                   11093:        developers find worth publishing.</p>
                   11094: </div>
1.41      asau     11095: <div class="sect1">
1.1       dsieger  11096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11097: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   11098: <p>This directory contains binary packages for the various
                   11099:        platforms that are supported by pkgsrc.
                   11100:        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.41      asau     11101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      11102: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   11103:        operating system for which the packages have been built. The
1.10      hubertf  11104:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   11105:        command, so it may differ from the one you are used to
                   11106:        hear.</p></li>
1.23      wiz      11107: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   11108:        architecture of the platform for which the packages have been
1.10      hubertf  11109:        built. It also includes the <code class="varname">ABI</code> (Application
                   11110:        Binary Interface) for platforms that have several of
                   11111:        them.</p></li>
1.23      wiz      11112: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   11113:        the operating system. For version numbers that change often (for
                   11114:        example NetBSD-current), the often-changing part should be
                   11115:        replaced with an <code class="literal">x</code>, for example
                   11116:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      11117: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 11118:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   11119:        for a stable branch, or <code class="literal">head</code> for packages
                   11120:        built from the HEAD branch. The latter should only be used when
                   11121:        the packages are updated on a regular basis. Otherwise the date
                   11122:        from checking out pkgsrc should be appended, for example
                   11123:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   11124: </ul></div>
                   11125: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11126:        can quickly click through the directories on the
                   11127:        server and find the best binary packages for their machines. Since they
                   11128:        usually know the operating system and the hardware architecture, OPSYS
                   11129:        and ARCH are placed first. After these choices, they can select the
                   11130:        best combination of OSVERSION and TAG together, since it is usually the
                   11131:        case that packages stay compatible between different version of the
                   11132:        operating system.</p>
                   11133: <p>In each of these directories, there is a
                   11134:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  11135:        <code class="filename">All</code> which contains all binary packages.
                   11136:        Besides that, there are various category directories that
                   11137:        contain symbolic links to the real binary packages.</p>
                   11138: </div>
1.41      asau     11139: <div class="sect1">
1.1       dsieger  11140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11141: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   11142: <p>Here are the reports from bulk builds, for those who want
                   11143:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      11144:        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   11145: </div>
1.41      asau     11146: <div class="sect1">
1.8       rillig   11147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11148: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11149: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11150: source packages</h2></div></div></div>
1.23      wiz      11151: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11152:        that is the files that define how to create binary packages from
                   11153:        source archives.</p>
                   11154: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11155:        snapshot of the CVS repository, which is updated regularly. The
                   11156:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11157:        directory, ready to be downloaded as a whole.</p>
                   11158: <p>In the directories for the quarterly branches, there is an
                   11159:        additional file called
1.22      jakllsch 11160:        <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  11161:        which contains the state of pkgsrc when it was branched.</p>
                   11162: </div>
                   11163: </div>
1.41      asau     11164: <div class="appendix">
                   11165: <div class="titlepage"><div><div><h1 class="title">
                   11166: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  11167: <div class="toc">
                   11168: <p><b>Table of Contents</b></p>
                   11169: <dl>
                   11170: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   11171: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11172: </dl>
                   11173: </div>
                   11174: <p>This section contains information on editing the pkgsrc
                   11175:        guide itself.</p>
1.41      asau     11176: <div class="sect1">
1.1       dsieger  11177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11178: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11179: <p>The pkgsrc guide's source code is stored in
                   11180:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11181:        are created from it:</p>
1.41      asau     11182: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      11183: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11184: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11185: <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>
                   11186: <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  11187:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      11188: <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  11189:        PostScript version of the pkgsrc guide.</p></li>
                   11190: </ul></div>
                   11191: </div>
1.41      asau     11192: <div class="sect1">
1.1       dsieger  11193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11194: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   11195: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      11196: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     11197: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  11198:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   11199:        documentation) installed. These are automatically installed when
                   11200:        you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41      asau     11201: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  11202:        right directory. All further steps will take place
                   11203:        here.</p></li>
1.41      asau     11204: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  11205:        <code class="filename">files/</code>.</p></li>
1.41      asau     11206: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  11207:        guide for valid XML and to build the final output files. If you
                   11208:        get any errors at this stage, you can just edit the files, as
                   11209:        there are only symbolic links in the working directory, pointing
                   11210:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     11211: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  11212:        commit)</strong></span></p></li>
1.41      asau     11213: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  11214:        regenerate the output files with the proper RCS
                   11215:        Ids.</p></li>
1.41      asau     11216: <li class="step">
1.10      hubertf  11217: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  11218:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11219:        <code class="filename">htdocs</code>.</p>
1.41      asau     11220: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  11221: <h3 class="title">Note</h3>
                   11222: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  11223:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11224:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  11225:        directory.</p>
                   11226: </div>
                   11227: </li>
                   11228: </ol></div>
                   11229: </div>
                   11230: </div>
                   11231: </div></body>
                   11232: </html>

CVSweb <webmaster@jp.NetBSD.org>