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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
1.23      wiz        10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The pkgsrc guide">
1.1       dsieger    11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.10      hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.4       rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6       rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.23      wiz        35: <div><div class="abstract" title="Abstract">
1.1       dsieger    36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger    69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
                     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     81: <dd><dl>
                     82: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     83: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     84: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     85: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     86: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     87: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     88: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                     89: </dl></dd>
                     90: </dl></dd>
                     91: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     92: <dd><dl>
                     93: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     94: <dd><dl>
                     95: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     96: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     98: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    101: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    102: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    103: </dl></dd>
                    104: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    105: <dd><dl>
                    106: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    107: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    108: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    109: </dl></dd>
                    110: </dl></dd>
                    111: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    112: <dd><dl>
                    113: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    114: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    115: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    116: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   117: <dd><dl>
1.4       rillig    118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       119: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    120: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   121: </dl></dd>
1.4       rillig    122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    123: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   124: </dl></dd>
                    125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    126: <dd><dl>
                    127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    129: </dl></dd>
                    130: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    131: builds)</a></span></dt>
1.1       dsieger   132: <dd><dl>
1.6       rillig    133: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    134: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    136: <dd><dl>
                    137: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    138: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    139: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    140: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    141: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    142: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    143: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    144: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    145: </dl></dd>
                    146: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    147: <dd><dl>
                    148: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    150: </dl></dd>
1.6       rillig    151: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    152: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    153: </dl></dd>
                    154: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    155: <dd><dl>
1.23      wiz       156: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    157: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    158: </dl></dd>
                    159: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    160: <dd><dl>
                    161: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    162: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    164: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    165: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23      wiz       168: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6       rillig    169: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       170: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                    171: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    172: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.6       rillig    173: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    174: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    175: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       176: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6       rillig    177: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.23      wiz       178: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   179: </dl></dd>
                    180: </dl></dd>
                    181: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    182: <dd><dl>
1.6       rillig    183: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   184: <dd><dl>
1.6       rillig    185: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   186: <dd><dl>
1.6       rillig    187: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    188: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil      189: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger   190: </dl></dd>
1.6       rillig    191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    192: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    193: </dl></dd>
                    194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    195: <dd><dl>
1.23      wiz       196: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    197: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig    198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    199: <dd><dl>
                    200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    205: </dl></dd>
                    206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    208: <dd><dl>
                    209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    212: </dl></dd>
1.23      wiz       213: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    214: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig    215: </dl></dd>
1.23      wiz       216: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz       219: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig    220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    222: <dd><dl>
                    223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    228: </dl></dd>
                    229: </dl></dd>
                    230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    231: <dd><dl>
                    232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz       233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6       rillig    235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz       237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6       rillig    238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    240: </dl></dd>
                    241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    242: <dd><dl>
                    243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz       244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    245: <dd><dl>
                    246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz       247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    248:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    249:       and
                    250:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    251:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    252: </dl></dd>
1.23      wiz       253: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig    254: <dd><dl>
1.23      wiz       255: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6       rillig    256: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    257: </dl></dd>
                    258: </dl></dd>
                    259: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    262: <dd><dl>
                    263: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    264: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    265: </dl></dd>
                    266: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    267: <dd><dl>
1.23      wiz       268: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6       rillig    269: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    270: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    271: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    272: </dl></dd>
                    273: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    274: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    275: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    276: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    277: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    278: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    279: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    280: </dl></dd>
                    281: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    282: <dd><dl>
                    283: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz       284: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6       rillig    285: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    286: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    287: </dl></dd>
                    288: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    289: <dd><dl>
                    290: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz       294: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    295: <dd><dl>
                    296: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    297: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    298: </dl></dd>
1.23      wiz       299: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    306: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    308: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig    309: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    310: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    311: </dl></dd>
                    312: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    315: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    316: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    317: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    318: </dl></dd>
                    319: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    320: <dd><dl>
                    321: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    322: <dd><dl>
                    323: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz       324: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6       rillig    325: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    326: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    327: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    328: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    329: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    330: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    331: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    332: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    333: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    334: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    335: </dl></dd>
1.23      wiz       336: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    337: <dd><dl>
                    338: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    339: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    340: </dl></dd>
1.23      wiz       341: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig    342: <dd><dl>
                    343: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    344: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    345: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    346: </dl></dd>
                    347: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    348: <dd><dl>
                    349: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    350: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    351: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                    352: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    353: </dl></dd>
1.23      wiz       354: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    357: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz       358: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
1.6       rillig    359: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    360: </dl></dd>
1.23      wiz       361: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig    362: <dd><dl>
                    363: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    364: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    365: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    367: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    368: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    369: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    370: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    371: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj       372: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig    373: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    374: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    375: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    376: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    377: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    378: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    379: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    380: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   381:     emulation</a></span></dt>
1.6       rillig    382: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    383: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   384: </dl></dd>
1.6       rillig    385: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   386: </dl></dd>
1.6       rillig    387: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    388: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   389: <dd><dl>
1.6       rillig    390: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    391: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    392: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33      wiz       393: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig    394: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj       395: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    396: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig    397: </dl></dd>
                    398: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    399: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    400: <dd><dl>
                    401: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    402: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    403: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    404: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   405: </dl></dd>
                    406: </dl></dd>
                    407: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    408: <dd><dl>
1.6       rillig    409: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.6       rillig    411: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    412: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    413: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   414: <dd><dl>
1.6       rillig    415: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    416: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   417: </dl></dd>
1.6       rillig    418: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    419: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   420: <dd><dl>
1.6       rillig    421: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    422: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   423: </dl></dd>
1.6       rillig    424: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   425: <dd><dl>
1.23      wiz       426: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    427: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1       dsieger   428: </dl></dd>
                    429: </dl></dd>
1.6       rillig    430: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   431: <dd><dl>
1.6       rillig    432: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    433: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    434: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   435: <dd><dl>
1.6       rillig    436: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    437: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   438: </dl></dd>
                    439: </dl></dd>
1.6       rillig    440: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   441: <dd><dl>
1.6       rillig    442: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    443: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   444: </dl></dd>
                    445: </dl></dd>
                    446: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    447: <dd><dl>
                    448: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    449: <dd><dl>
                    450: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    451: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    452: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       453: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1       dsieger   454: </dl></dd>
                    455: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    456: </dl></dd>
                    457: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    458: <dd><dl>
                    459: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    460: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    461: </dl></dd>
                    462: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    463: <dd><dl>
1.23      wiz       464: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    465: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    467: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    468: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    469: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   470: source packages</a></span></dt>
                    471: </dl></dd>
                    472: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    473: <dd><dl>
                    474: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    475: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    476: </dl></dd>
                    477: </dl>
                    478: </div>
                    479: <div class="list-of-tables">
                    480: <p><b>List of Tables</b></p>
                    481: <dl>
                    482: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    483: </dt>
1.6       rillig    484: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   485: </dt>
1.6       rillig    486: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   487: </dt>
                    488: </dl>
                    489: </div>
1.23      wiz       490: <div class="chapter" title="Chapter 1. What is pkgsrc?">
1.1       dsieger   491: <div class="titlepage"><div><div><h2 class="title">
                    492: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    493: <div class="toc">
                    494: <p><b>Table of Contents</b></p>
                    495: <dl>
                    496: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    497: <dd><dl>
                    498: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    499: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    500: </dl></dd>
                    501: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    502: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    503: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    504: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    505: </dl>
                    506: </div>
1.23      wiz       507: <div class="sect1" title="1.1. Introduction">
1.1       dsieger   508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    509: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    510: <p>There is a lot of software freely available for Unix-based
                    511: systems, which is usually available in form of the source code. Before
                    512: such software can be used, it needs to be configured to the local
                    513: system, compiled and installed, and this is exactly what The NetBSD
                    514: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    515: to handle binary packages, so that not every user has to build the
                    516: packages for himself, which is a time-costly task.</p>
                    517: <p>pkgsrc currently contains several thousand packages,
                    518:       including:</p>
1.23      wiz       519: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    520: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.1       dsieger   521:          web server</p></li>
1.23      wiz       522: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1       dsieger   523:          web browser</p></li>
1.23      wiz       524: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1       dsieger   525:          Desktop Environment</p></li>
1.23      wiz       526: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.1       dsieger   527:          Desktop Environment</p></li>
                    528: </ul></div>
                    529: <p>...just to name a few.</p>
                    530: <p>pkgsrc has built-in support for handling varying dependencies,
                    531:       such as pthreads and X11, and extended features such as IPv6 support on
                    532:       a range of platforms.</p>
1.23      wiz       533: <div class="sect2" title="1.1.1. Why pkgsrc?">
1.1       dsieger   534: <div class="titlepage"><div><div><h3 class="title">
                    535: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    536: <p>
                    537: pkgsrc provides the following key features:
                    538: </p>
1.23      wiz       539: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    540: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   541:   and installation of binary packages. The source and latest
                    542:   patches are retrieved from a master or mirror download site, checksum
                    543:   verified, then built on your system. Support for binary-only
                    544:   distributions is available for both native platforms and NetBSD
                    545:   emulated platforms.</p></li>
1.23      wiz       546: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   547:   including binaries, libraries, man pages and other
                    548:   documentation.</p></li>
1.23      wiz       549: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1       dsieger   550:   are handled automatically. The configuration files of various
                    551:   packages are handled automatically during updates, so local changes
                    552:   are preserved.</p></li>
1.23      wiz       553: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   554:   consists of highly portable code. This allows the greatest speed of
1.25      spz       555:   development when porting to a new platform. This portability also
1.1       dsieger   556:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    557:   platforms</em></span>.</p></li>
1.23      wiz       558: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   559:   international encryption requirements and build-time options for a
                    560:   large number of packages are all set in a simple, central
                    561:   configuration file.</p></li>
1.23      wiz       562: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   563:   freely available under a BSD license, so you may extend and adapt
                    564:   pkgsrc to your needs. Support for local packages and patches is
                    565:   available right out of the box, so you can configure it specifically
                    566:   for your environment.</p></li>
                    567: </ul></div>
                    568: <p>The following principles are basic to pkgsrc:</p>
1.23      wiz       569: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                    570: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  571: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   572: them and to complain about them rather than to just install the package
                    573: and hope that it works. There are numerous checks in pkgsrc that try to
                    574: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
                    575: of shell scripts), and post-installation checks (installed files,
                    576: references to shared libraries, script interpreters).</p></li>
1.23      wiz       577: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  578: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   579: pkgsrc has been ported to many operating systems. Care is taken that
                    580: packages behave the same on all platforms.</p></li>
                    581: </ul></div>
                    582: </div>
1.23      wiz       583: <div class="sect2" title="1.1.2. Supported platforms">
1.1       dsieger   584: <div class="titlepage"><div><div><h3 class="title">
                    585: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    586: <p>pkgsrc consists of both a source distribution and a binary
                    587: distribution for these operating systems. After retrieving the required
                    588: source or binaries, you can be up and running with pkgsrc in just
                    589: minutes!</p>
                    590: <p>pkgsrc was derived from FreeBSD's ports system, and
                    591:       initially developed for NetBSD only. Since then, pkgsrc has
                    592:       grown a lot, and now supports the following platforms:</p>
                    593: <div class="table">
                    594: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    595: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    596: <colgroup>
                    597: <col>
                    598: <col>
                    599: </colgroup>
                    600: <thead><tr>
                    601: <th>Platform</th>
                    602: <th>Date Support Added</th>
                    603: </tr></thead>
                    604: <tbody>
                    605: <tr>
1.10      hubertf   606: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   607: <td align="center">Aug 1997</td>
                    608: </tr>
                    609: <tr>
1.10      hubertf   610: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   611: <td align="center">Mar 1999</td>
                    612: </tr>
                    613: <tr>
1.10      hubertf   614: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   615: <td align="center">Jun 1999</td>
                    616: </tr>
                    617: <tr>
                    618: <td>
1.10      hubertf   619:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    620:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1       dsieger   621:         </td>
                    622: <td align="center">Oct 2001</td>
                    623: </tr>
                    624: <tr>
1.10      hubertf   625: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   626: <td align="center">Nov 2002</td>
                    627: </tr>
                    628: <tr>
1.10      hubertf   629: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   630: <td align="center">Nov 2002</td>
                    631: </tr>
                    632: <tr>
1.10      hubertf   633: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   634: <td align="center">Dec 2002</td>
                    635: </tr>
                    636: <tr>
                    637: <td>BSD/OS</td>
                    638: <td align="center">Dec 2003</td>
                    639: </tr>
                    640: <tr>
1.10      hubertf   641: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   642: <td align="center">Dec 2003</td>
                    643: </tr>
                    644: <tr>
                    645: <td>
1.10      hubertf   646:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   647:           (Microsoft Windows Services for Unix)
                    648:         </td>
                    649: <td align="center">Mar 2004</td>
                    650: </tr>
                    651: <tr>
1.10      hubertf   652: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   653: <td align="center">Oct 2004</td>
                    654: </tr>
                    655: <tr>
1.10      hubertf   656: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   657: <td align="center">Nov 2004</td>
                    658: </tr>
                    659: <tr>
1.10      hubertf   660: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   661: <td align="center">Apr 2007</td>
                    662: </tr>
1.23      wiz       663: <tr>
                    664: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    665: <td align="center">Sep 2010</td>
                    666: </tr>
1.1       dsieger   667: </tbody>
                    668: </table></div>
                    669: </div>
                    670: <br class="table-break">
                    671: </div>
                    672: </div>
1.23      wiz       673: <div class="sect1" title="1.2. Overview">
1.1       dsieger   674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    675: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    676: <p>This document is divided into three parts. The first,
1.10      hubertf   677:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   678:        describes how one can use one of the packages in the Package
                    679:        Collection, either by installing a precompiled binary package,
                    680:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   681:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1       dsieger   682:        package so it can be easily built by other NetBSD users without
                    683:        knowing about the package's building details. The third part,
1.10      hubertf   684:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   685:        is intended for those who want to understand how pkgsrc is
                    686:        implemented.</p>
                    687: <p>This document is available in various formats:
1.10      hubertf   688:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1       dsieger   689: </div>
1.23      wiz       690: <div class="sect1" title="1.3. Terminology">
1.1       dsieger   691: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    692: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       693: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    694:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   695:       terminology used within this document.</p>
                    696: <div class="variablelist"><dl>
                    697: <dt><span class="term">Package</span></dt>
                    698: <dd><p>A set of files and building instructions
                    699:            that describe what's necessary
                    700:            to build a certain piece of software using
                    701:             pkgsrc. Packages are traditionally stored under
                    702:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    703: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       704: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   705:          is part of the NetBSD operating system and can be bootstrapped
                    706:          to run on non-NetBSD operating systems as well.  It handles
                    707:          building (compiling), installing, and removing of
                    708:          packages.</p></dd>
                    709: <dt><span class="term">Distfile</span></dt>
                    710: <dd><p>This term describes the file or files that are
                    711:            provided by the author of the piece of software to
                    712:            distribute his work. All the changes necessary to build on
                    713:            NetBSD are reflected in the corresponding package. Usually
                    714:            the distfile is in the form of a compressed tar-archive,
                    715:            but other types are possible, too. Distfiles are usually
                    716:            stored below
                    717:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    718: <dt><span class="term">Port</span></dt>
                    719: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    720:            for what we call a package.
1.23      wiz       721:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   722:            architecture.</p></dd>
                    723: <dt><span class="term">Precompiled/binary package</span></dt>
                    724: <dd>
                    725: <p>A set of binaries built with pkgsrc from a distfile
                    726:            and stuffed together in a single <code class="filename">.tgz</code>
                    727:            file so it can be installed on machines of the same
                    728:            machine architecture without the need to
                    729:            recompile. Packages are usually generated in
                    730:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       731:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       732: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   733:            especially in the context of precompiled packages.</p>
                    734: </dd>
                    735: <dt><span class="term">Program</span></dt>
                    736: <dd><p>The piece of software to be installed which will be
                    737:          constructed from all the files in the distfile by the
                    738:          actions defined in the corresponding package.</p></dd>
                    739: </dl></div>
1.23      wiz       740: <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
1.1       dsieger   741: <div class="titlepage"><div><div><h3 class="title">
                    742: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
                    743: <div class="variablelist"><dl>
                    744: <dt><span class="term">pkgsrc users</span></dt>
                    745: <dd>
                    746: <p>The
                    747:        pkgsrc users are people who use the packages provided by pkgsrc.
                    748:        Typically they are system administrators. The people using the
1.23      wiz       749:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    750:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   751: <p>There are two kinds of pkgsrc users: Some only want to
                    752:        install pre-built binary packages. Others build the pkgsrc
                    753:        packages from source, either for installing them directly or for
1.10      hubertf   754:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.1       dsieger   755:        documentation.</p>
                    756: </dd>
                    757: <dt><span class="term">package maintainers</span></dt>
                    758: <dd><p>A
1.10      hubertf   759:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.1       dsieger   760: <dt><span class="term">infrastructure developers</span></dt>
                    761: <dd><p>These people are involved in all those files
                    762:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   763:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.1       dsieger   764:        too.</p></dd>
                    765: </dl></div>
                    766: </div>
                    767: </div>
1.23      wiz       768: <div class="sect1" title="1.4. Typography">
1.1       dsieger   769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    770: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    771: <p>When giving examples for commands, shell prompts are used to
                    772:       show if the command should/can be issued as root, or if
1.23      wiz       773:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.1       dsieger   774:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    775:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    776: </div>
                    777: </div>
1.23      wiz       778: <div class="part" title="Part I. The pkgsrc user's guide">
1.1       dsieger   779: <div class="titlepage"><div><div><h1 class="title">
                    780: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    781: <div class="toc">
                    782: <p><b>Table of Contents</b></p>
                    783: <dl>
                    784: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    785: <dd><dl>
                    786: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    787: <dd><dl>
                    788: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       789: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   790: </dl></dd>
                    791: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    792: <dd><dl>
                    793: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    794: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    795: </dl></dd>
                    796: </dl></dd>
                    797: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    798: <dd><dl>
                    799: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    800: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    801: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    802: <dd><dl>
                    803: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    804: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    805: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    806: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    807: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    808: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    809: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                    810: </dl></dd>
                    811: </dl></dd>
                    812: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    813: <dd><dl>
                    814: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    815: <dd><dl>
                    816: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    817: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    818: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    819: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    820: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    821: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    822: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    823: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    824: </dl></dd>
                    825: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    826: <dd><dl>
                    827: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    828: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    829: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    830: </dl></dd>
                    831: </dl></dd>
                    832: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    833: <dd><dl>
                    834: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    835: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    836: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    837: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   838: <dd><dl>
1.4       rillig    839: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       840: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    841: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   842: </dl></dd>
1.4       rillig    843: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    844: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   845: </dl></dd>
                    846: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    847: <dd><dl>
                    848: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    849: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    850: </dl></dd>
                    851: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    852: builds)</a></span></dt>
1.1       dsieger   853: <dd><dl>
1.6       rillig    854: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    855: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    856: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    857: <dd><dl>
                    858: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    859: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    860: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    861: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    862: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    863: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    864: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    865: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    866: </dl></dd>
                    867: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    868: <dd><dl>
                    869: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    870: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    871: </dl></dd>
1.6       rillig    872: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    873: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    876: <dd><dl>
1.23      wiz       877: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    878: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    879: </dl></dd>
                    880: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    884: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    885: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    886: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    887: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23      wiz       889: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6       rillig    890: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz       891: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                    892: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                    893: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
1.6       rillig    894: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    895: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    896: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz       897: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6       rillig    898: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.23      wiz       899: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   900: </dl></dd>
                    901: </dl>
                    902: </div>
1.23      wiz       903: <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
1.1       dsieger   904: <div class="titlepage"><div><div><h2 class="title">
                    905: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    906: <div class="toc">
                    907: <p><b>Table of Contents</b></p>
                    908: <dl>
                    909: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    910: <dd><dl>
                    911: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23      wiz       912: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   913: </dl></dd>
                    914: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    915: <dd><dl>
                    916: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    917: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    918: </dl></dd>
                    919: </dl>
                    920: </div>
                    921: <p>Before you download and extract the files, you need to decide
                    922: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    923: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    924: free to install the sources and binary packages wherever you want in
                    925: your filesystem, provided that the pathname does not contain white-space
                    926: or other characters that are interpreted specially by the shell and some
                    927: other programs. A safe bet is to use only letters, digits, underscores
                    928: and dashes.</p>
1.23      wiz       929: <div class="sect1" title="2.1. Getting pkgsrc for the first time">
1.1       dsieger   930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    931: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    932: <p>Before you download any pkgsrc files, you should decide
                    933:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    934:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    935:        quarterly basis from the current branch and only gets modified
                    936:        for security updates. The names of the stable branches are built
                    937:        from the year and the quarter, for example
1.21      snj       938:        <code class="literal">2009Q1</code>.</p>
1.1       dsieger   939: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       940:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    941:        Both ways are described here.</p>
                    942: <div class="sect2" title="2.1.1. As tar file">
1.1       dsieger   943: <div class="titlepage"><div><div><h3 class="title">
                    944: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    945: <p>The primary download location for all pkgsrc files is
1.10      hubertf   946:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.1       dsieger   947:        number of subdirectories for different purposes, which are
1.10      hubertf   948:        described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.1       dsieger   949: <p>The tar file for the current branch is in the directory
1.10      hubertf   950:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1       dsieger   951:        It is autogenerated daily.</p>
1.21      snj       952: <p>The tar file for the stable branch 2009Q1 is in the
                    953:        directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.12      weinem    954: <p>To download a pkgsrc stable tarball, run:</p>
                    955: <pre class="screen">
1.22      jakllsch  956: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
                    957: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12      weinem    958:        stable branch to be downloaded, for example, 
1.23      wiz       959:        <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</p>
1.12      weinem    960: <p>Then, extract it with:</p>
1.22      jakllsch  961: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.12      weinem    962: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    963:        in <code class="filename">/usr/</code> and all the package source will be 
                    964:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    965: <p>To download pkgsrc-current, run:</p>
                    966: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1       dsieger   967: </div>
1.23      wiz       968: <div class="sect2" title="2.1.2. Via anonymous CVS">
1.1       dsieger   969: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz       970: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    971: <p>To fetch a specific pkgsrc stable branch, run:</p>
                    972: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
                    973: </pre>
                    974: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
                    975:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
                    976: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    977:        in your <code class="filename">/usr/</code> directory and all the package source 
                    978:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    979: <p>To fetch the pkgsrc current branch, run:</p>
                    980: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger   981: </pre>
1.29      dholland  982: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23      wiz       983: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
                    984: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
                    985: </pre>
                    986: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    987:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    988:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    989: <pre class="programlisting">
                    990: # set CVS remote shell command
                    991: CVS_RSH=ssh
                    992: export CVS_RSH
                    993: </pre>
                    994: <p>By default, CVS doesn't do things like most people would expect it to do.
                    995:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                    996:        in your home directory and saving the following lines to it.
                    997:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                    998:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig    999: <pre class="programlisting">
                   1000: # recommended CVS configuration file from the pkgsrc guide
1.23      wiz      1001: cvs -q -z3
1.2       rillig   1002: checkout -P
1.4       rillig   1003: update -dP
                   1004: diff -upN
1.2       rillig   1005: rdiff -u
1.23      wiz      1006: release -d
1.2       rillig   1007: </pre>
1.1       dsieger  1008: </div>
                   1009: </div>
1.23      wiz      1010: <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1.1       dsieger  1011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1012: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1013: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1014:        (which also works if you have first installed it via a tar
                   1015:        file). It saves bandwidth and hard disk activity, compared to
                   1016:        downloading the tar file again.</p>
1.23      wiz      1017: <div class="sect2" title="2.2.1. Via tar files">
1.1       dsieger  1018: <div class="titlepage"><div><div><h3 class="title">
                   1019: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.23      wiz      1020: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1021: <h3 class="title">Warning</h3>
                   1022: <p>When updating from a tar file, you first need to
                   1023:        completely remove the old pkgsrc directory. Otherwise those
                   1024:        files that have been removed from pkgsrc in the mean time will
                   1025:        not be removed on your local disk, resulting in inconsistencies.
                   1026:        When removing the old files, any changes that you have done to
                   1027:        the pkgsrc files will be lost after updating. Therefore updating
                   1028:        via CVS is strongly recommended.</p>
                   1029: </div>
                   1030: <p>Note that by default the distfiles and the binary packages
                   1031:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1032:        before updating. You can also configure pkgsrc to use other than
                   1033:        the default directories by setting the
                   1034:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1035:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1036: <p>To update pkgsrc from a tar file, download the tar file as
                   1037:        explained above. Then, make sure that you have not made any
                   1038:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1039:        directory and extract the new tar file. Done.</p>
                   1040: </div>
1.23      wiz      1041: <div class="sect2" title="2.2.2. Via CVS">
1.1       dsieger  1042: <div class="titlepage"><div><div><h3 class="title">
                   1043: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25      spz      1044: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1045: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1046: </pre>
                   1047: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
                   1048: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
                   1049: </pre>
1.23      wiz      1050: <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1.1       dsieger  1051: <div class="titlepage"><div><div><h4 class="title">
                   1052: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1053: <p>When updating pkgsrc, the CVS program keeps track of the
                   1054:        branch you selected. But if you, for whatever reason, want to
                   1055:        switch from the stable branch to the current one, you can do it
1.23      wiz      1056:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1057:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1058:        back to the stable branch, add the
1.23      wiz      1059:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1.1       dsieger  1060: </div>
1.23      wiz      1061: <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1.1       dsieger  1062: <div class="titlepage"><div><div><h4 class="title">
                   1063: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1064: <p>When you update pkgsrc, the CVS program will only touch
                   1065:        those files that are registered in the CVS repository. That
                   1066:        means that any packages that you created on your own will stay
                   1067:        unmodified. If you change files that are managed by CVS, later
                   1068:        updates will try to merge your changes with those that have been
                   1069:        done by others. See the CVS manual, chapter
1.23      wiz      1070:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1071: </div>
                   1072: </div>
                   1073: </div>
                   1074: </div>
1.23      wiz      1075: <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1.1       dsieger  1076: <div class="titlepage"><div><div><h2 class="title">
                   1077: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1078: <div class="toc">
                   1079: <p><b>Table of Contents</b></p>
                   1080: <dl>
                   1081: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1082: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1083: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1084: <dd><dl>
                   1085: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1086: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1087: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1088: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1089: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1090: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1091: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                   1092: </dl></dd>
                   1093: </dl>
                   1094: </div>
1.23      wiz      1095: <div class="sect1" title="3.1. Binary distribution">
1.1       dsieger  1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1097: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1098: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1099: </div>
1.23      wiz      1100: <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1.1       dsieger  1101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1102: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1104: <pre class="screen">
                   1105: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1108:     </pre>
1.10      hubertf  1109: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.1       dsieger  1110:     pkgsrc before bootstrapping. The given
1.10      hubertf  1111:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.1       dsieger  1112:     <code class="filename">/usr/pkg</code> for the
                   1113:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1114:     and <code class="filename">/var/db/pkg</code> for the package database
                   1115:     directory where pkgsrc will do its internal bookkeeping.
                   1116:     However, these can also be set using command-line
                   1117:     arguments.</p>
1.23      wiz      1118: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1119: <h3 class="title">Note</h3>
1.10      hubertf  1120: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1121:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1122:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1123:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1124: </div>
                   1125: </div>
1.23      wiz      1126: <div class="sect1" title="3.3. Platform-specific notes">
1.1       dsieger  1127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1128: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1129: <p>Here are some platform-specific notes you should be aware of.</p>
1.23      wiz      1130: <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1.1       dsieger  1131: <div class="titlepage"><div><div><h3 class="title">
                   1132: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.22      jakllsch 1133: <p>Darwin 5.x and up are supported. Before you start, you
                   1134:       will need to download and install the Mac OS X Developer Tools
                   1135:       from Apple's Developer Connection. See
                   1136:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
                   1137:       for details.  Also, make sure you install X11 (an optional
                   1138:       package included with the Developer Tools) if you intend to
                   1139:       build packages that use the X11 Window System.</p>
1.1       dsieger  1140: </div>
1.23      wiz      1141: <div class="sect2" title="3.3.2. FreeBSD">
1.1       dsieger  1142: <div class="titlepage"><div><div><h3 class="title">
                   1143: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.29      dholland 1144: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1       dsieger  1145:       other versions may work.</p>
                   1146: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1147:       with the FreeBSD userland tools. There are several steps:</p>
1.23      wiz      1148: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1149: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1       dsieger  1150:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1151:          recommended that you choose a different location (e.g.
                   1152:          <code class="filename">/usr/pkgdb</code>) by
                   1153:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1154: <li class="listitem">
1.1       dsieger  1155: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1156:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1157: <pre class="screen">
                   1158: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1159: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1160: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1161: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1162: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1163:          </pre>
                   1164: </li>
1.23      wiz      1165: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1166:          <code class="filename">/etc/mk.conf.example</code> file
                   1167:          when you use the bootstrap script.</p></li>
                   1168: </ol></div>
                   1169: </div>
1.23      wiz      1170: <div class="sect2" title="3.3.3. Interix">
1.1       dsieger  1171: <div class="titlepage"><div><div><h3 class="title">
                   1172: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
                   1173: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1174:       providing a Unix-like environment with a tighter kernel integration than
                   1175:       available with Cygwin.  It is part of the Windows Services for Unix
                   1176:       package, available for free for any licensed copy of Windows 2000, XP
1.10      hubertf  1177:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1       dsieger  1178: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1179:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1180:       of pthreads, but other parts of libc may also be lacking.)</p>
1.24      wiz      1181: <p>Services for Unix Applications (aka SUA) is an integrated
                   1182:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1183:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1184:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1185:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1186:       work as well. The Interix 5.x subsystem has not yet been tested
                   1187:       with pkgsrc.</p>
1.23      wiz      1188: <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1.1       dsieger  1189: <div class="titlepage"><div><div><h4 class="title">
                   1190: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
                   1191: <p>At an absolute minimum, the following packages must be installed from
                   1192:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.23      wiz      1193: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1194: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1195: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1196: <li class="listitem"><p>Remote Connectivity</p></li>
                   1197: <li class="listitem"><p>Interix SDK</p></li>
1.1       dsieger  1198: </ul></div>
                   1199: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1200:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1201:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1202:        pkgsrc (or from a binary package).</p>
                   1203: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1204:        not need to be installed, but Remote Connectivity itself should be
                   1205:        installed in order to have a working inetd.</p>
                   1206: <p>During installation you may be asked whether to enable setuid
                   1207:        behavior for Interix programs, and whether to make pathnames default to
                   1208:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1209:        enabled.  (Without case-sensitivity, a large number of packages including
                   1210:        perl will not build.)</p>
                   1211: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1212:        works (via the Data Execution Prevention feature).  In order to use
                   1213:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1214:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1215:        must be installed.  Hotfixes are available from Microsoft through a
1.14      jmcneill 1216:        support contract; however, Debian Interix Port has made most Interix
                   1217:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1       dsieger  1218: <p>In addition to the hotfix noted above, it may be necessary to
                   1219:        disable Data Execution Prevention entirely to make Interix functional.
                   1220:        This may happen only with certain types of CPUs; the cause is not fully
                   1221:        understood at this time.  If gcc or other applications still segfault
                   1222:        repeatedly after installing one of the hotfixes note above, the
                   1223:        following option can be added to the appropriate "boot.ini" line on the
                   1224:        Windows boot drive:  /NoExecute=AlwaysOff
                   1225:        (WARNING, this will disable DEP completely, which may be a security
                   1226:        risk if applications are often run as a user in the Administrators
                   1227:        group!)</p>
                   1228: </div>
1.23      wiz      1229: <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1.1       dsieger  1230: <div class="titlepage"><div><div><h4 class="title">
                   1231: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
                   1232: <p>If SFU is already installed and you wish to alter these settings to work
                   1233:        with pkgsrc, note the following things.</p>
1.23      wiz      1234: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1235: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1       dsieger  1236:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1237:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.23      wiz      1238: <li class="listitem">
1.1       dsieger  1239: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1240:            change the following registry key:</p>
                   1241: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1242: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1243: </li>
1.23      wiz      1244: <li class="listitem">
1.1       dsieger  1245: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1246:            following registry key:</p>
                   1247: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1248: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1249: </li>
                   1250: </ul></div>
                   1251: </div>
1.23      wiz      1252: <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1.1       dsieger  1253: <div class="titlepage"><div><div><h4 class="title">
                   1254: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
                   1255: <p>The package manager (either the pkgsrc "su" user, or the user
                   1256:        running "pkg_add") must be a member of the local Administrators
                   1257:        group.  Such a user must also be used to run the bootstrap.  This is
                   1258:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1259: <p>The package manager should use a umask of 002.  "make install" will
                   1260:        automatically complain if this is not the case.  This ensures that
                   1261:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1262: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1263:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1264:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1265:        the same time as the pkgsrc packages, ensure that you use the proper
                   1266:        pkg_* tools for each type of binary package.</p>
                   1267: <p>The TERM setting used for DOS-type console windows (including those
                   1268:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1269:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1270:        entry provides adequate emulation in most cases:</p>
                   1271: <pre class="programlisting">
                   1272: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1273:        </pre>
                   1274: </div>
1.23      wiz      1275: <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1.1       dsieger  1276: <div class="titlepage"><div><div><h4 class="title">
                   1277: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
                   1278: <p>Though Interix suffices as a familiar and flexible substitute
                   1279:        for a full Unix-like platform, it has some drawbacks that should
                   1280:        be noted for those desiring to make the most of Interix.</p>
1.23      wiz      1281: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1282: <li class="listitem">
1.1       dsieger  1283: <p><span class="strong"><strong>X11:</strong></span></p>
                   1284: <p>Interix comes with the standard set of X11R6 client libraries,
                   1285:          and can run X11 based applications, but it does
                   1286:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.10      hubertf  1287:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1288:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1       dsieger  1289:          (available in a trimmed version for Interix from Interop Systems as the
1.10      hubertf  1290:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1       dsieger  1291:          and the free X11 server included with
1.10      hubertf  1292:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1       dsieger  1293: </li>
1.23      wiz      1294: <li class="listitem">
1.1       dsieger  1295: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1296: <p>Because Interix runs in a completely different NT subsystem from
                   1297:          Win32 applications, it does not currently support various X11
                   1298:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1299:          Most interactive applications to a local X server will run
                   1300:          reasonably fast, but full motion video and other graphics
                   1301:          intensive applications may require a faster-than-expected CPU.</p>
                   1302: </li>
1.23      wiz      1303: <li class="listitem">
1.1       dsieger  1304: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1305: <p>Interix has no native support for audio output.  For audio
1.10      hubertf  1306:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1       dsieger  1307:          audio system on Interix.  Unlike on most platforms, the
                   1308:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.10      hubertf  1309:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1       dsieger  1310:          server component.  To output audio via an Interix host, the
                   1311:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
                   1312:          must also be installed.</p>
                   1313: </li>
1.23      wiz      1314: <li class="listitem">
1.1       dsieger  1315: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1316: <p>Direct device access is not currently supported in Interix, so it
                   1317:          is not currently possible to access CD/DVD drives, USB devices,
                   1318:          or SCSI devices through non-filesystem means.  Among other things,
                   1319:          this makes it impossible to use Interix directly for CD/DVD
                   1320:          burning.</p>
                   1321: </li>
1.23      wiz      1322: <li class="listitem">
1.1       dsieger  1323: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1324: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1325:          drives are also not directly accessible in Interix.  However,
                   1326:          support is in work to make tape drive access possible by using
                   1327:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1328:          esound server).</p>
                   1329: </li>
                   1330: </ul></div>
                   1331: </div>
1.23      wiz      1332: <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1.1       dsieger  1333: <div class="titlepage"><div><div><h4 class="title">
                   1334: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
                   1335: <p>It is not necessary, in general, to have a "root" user on the
                   1336:        Windows system; any member of the local Administrators group will
                   1337:        suffice.  However, some packages currently assume that the user
                   1338:        named "root" is the privileged user.  To accommodate these, you
                   1339:        may create such a user; make sure it is in the local group
                   1340:        Administrators (or your language equivalent).</p>
1.10      hubertf  1341: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1       dsieger  1342:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1343:        time being, install packages as the local Administrator (or
                   1344:        your language equivalent), or run the following command after
                   1345:        installing a package to work around the issue:</p>
                   1346: <pre class="screen">
                   1347: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1348:        </pre>
                   1349: </div>
                   1350: </div>
1.23      wiz      1351: <div class="sect2" title="3.3.4. IRIX">
1.1       dsieger  1352: <div class="titlepage"><div><div><h3 class="title">
                   1353: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
                   1354: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1355:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1356:       according to your preference.  If you do not have a license for the MIPSpro
1.10      hubertf  1357:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1       dsieger  1358: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29      dholland 1359:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1       dsieger  1360:       etc.</p>
                   1361: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1362:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1363:        you start out using "abi=n32", that's what all your packages will be built
                   1364:        with.</p>
                   1365: <p>Therefore, please make sure that you have no conflicting
                   1366:       <code class="varname">CFLAGS</code> in your environment or the
1.10      hubertf  1367:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1368:       try to link n32 object files with lib64 or vice versa.  Check your
                   1369:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1370: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1371:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1372:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1373:       link over a network-mounted file system.</p>
                   1374: <p>The bootstrapping process should set all the right options for programs such
                   1375:       as imake(1), but you may want to set some options depending on your local
                   1376:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1377:       course, your compiler's man pages for details.</p>
                   1378: <p>If you are using SGI's MIPSPro compiler, please set
                   1379: 
                   1380:       </p>
                   1381: <pre class="programlisting">
                   1382: PKGSRC_COMPILER=        mipspro
                   1383:       </pre>
                   1384: <p>
                   1385: 
1.10      hubertf  1386:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1387:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1388:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1389:       default.</p>
                   1390: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1391:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1392:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1393:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1394:       '--preserve-path' flag.</p>
                   1395: </div>
1.23      wiz      1396: <div class="sect2" title="3.3.5. Linux">
1.1       dsieger  1397: <div class="titlepage"><div><div><h3 class="title">
                   1398: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
                   1399: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1400:       either libtermcap or libcurses (libncurses).  Installing the
                   1401:       distributions libncurses-dev package (or equivalent) should fix
                   1402:       the problem.</p>
                   1403: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1404:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1405:       i386 have been tested.</p>
                   1406: <p>To bootstrap using icc, assuming the default icc installation
                   1407:       directory:</p>
                   1408: <pre class="programlisting">
1.31      wiz      1409: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1       dsieger  1410:       </pre>
1.23      wiz      1411: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1412: <h3 class="title">Note</h3>
1.31      wiz      1413: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1414: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1415: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1416: </div>
                   1417: <p>Use a value for ICCBASE that corresponds to the directory
                   1418:       where icc is installed. After bootstrapping, set
                   1419:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30      wiz      1420: <pre class="programlisting">
1.31      wiz      1421: ICCBASE=                /opt/intel/cc/10.1.008
1.1       dsieger  1422:       </pre>
1.31      wiz      1423: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1424:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1425:       install directory for icc 8.0. If you are using a more recent
                   1426:       version, be sure to set the correct path explicitly.
                   1427:       </p>
1.1       dsieger  1428: <p>pkgsrc uses the static linking method of the runtime libraries
                   1429:       provided by icc, so binaries can be run on other systems which do not
                   1430:       have the shared libraries installed.</p>
                   1431: <p>Libtool, however, extracts a list of libraries from the
1.29      dholland 1432:       <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  1433:       records it, throwing away the -Bstatic and -Bdynamic options
                   1434:       interspersed between the libraries.  This means that
                   1435:       libtool-linked C++ shared libraries will have a runtime
                   1436:       dependency on the icc libraries until this is fixed in
                   1437:       libtool.</p>
                   1438: </div>
1.23      wiz      1439: <div class="sect2" title="3.3.6. OpenBSD">
1.1       dsieger  1440: <div class="titlepage"><div><div><h3 class="title">
                   1441: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.29      dholland 1442: <p>OpenBSD 5.1 has been tested and supported,
                   1443:       other versions may work.</p>
1.1       dsieger  1444: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1445:       with the OpenBSD userland tools. There are several steps:</p>
1.23      wiz      1446: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1447: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1       dsieger  1448:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1449:          recommended that you choose a different location (e.g.
                   1450:          <code class="filename">/usr/pkgdb</code>) by
                   1451:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.23      wiz      1452: <li class="listitem">
1.1       dsieger  1453: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1454:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1455: <pre class="screen">
                   1456: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1457: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1458: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1459: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1460: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1461:          </pre>
                   1462: </li>
1.23      wiz      1463: <li class="listitem">
1.10      hubertf  1464: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1465:          <code class="filename">/etc/mk.conf.example</code> file
                   1466:          when you use the bootstrap script. OpenBSD's make program uses
1.10      hubertf  1467:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1468:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1469:          of the file with:</p>
                   1470: <pre class="programlisting">
                   1471: .ifdef BSD_PKG_MK
                   1472: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1473: .else
                   1474: # OpenBSD stuff
                   1475: .endif
                   1476:          </pre>
                   1477: </li>
                   1478: </ol></div>
                   1479: </div>
1.23      wiz      1480: <div class="sect2" title="3.3.7. Solaris">
1.1       dsieger  1481: <div class="titlepage"><div><div><h3 class="title">
                   1482: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
                   1483: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
                   1484:       You will need a working C compiler. Both gcc 2.95.3 and
                   1485:       Sun WorkShop 5 have been tested.</p>
                   1486: <p>The following packages are required on Solaris 8 for the bootstrap
                   1487:       process and to build packages.</p>
1.23      wiz      1488: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1489: <li class="listitem"><p>SUNWsprot</p></li>
                   1490: <li class="listitem"><p>SUNWarc</p></li>
                   1491: <li class="listitem"><p>SUNWbtool</p></li>
                   1492: <li class="listitem"><p>SUNWtoo</p></li>
                   1493: <li class="listitem"><p>SUNWlibm</p></li>
1.1       dsieger  1494: </ul></div>
                   1495: <p>Please note that the use of GNU binutils on Solaris is
                   1496:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1497: <p>Whichever compiler you use, please ensure the compiler tools and
                   1498:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1499:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1500:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.23      wiz      1501: <div class="sect3" title="3.3.7.1. If you are using gcc">
1.1       dsieger  1502: <div class="titlepage"><div><div><h4 class="title">
                   1503: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
                   1504: <p>It makes life much simpler if you only use the same gcc consistently
                   1505:        for building all packages.</p>
                   1506: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1507:        then either build gcc from
                   1508:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
                   1509:        package, then remove gcc used during bootstrapping.</p>
1.10      hubertf  1510: <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  1511: </div>
1.23      wiz      1512: <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1.1       dsieger  1513: <div class="titlepage"><div><div><h4 class="title">
                   1514: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
                   1515: <p>You will need at least the following packages installed (from WorkShop
                   1516:        5.0)</p>
1.23      wiz      1517: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1518: <li class="listitem"><p>SPROcc
1.1       dsieger  1519:          - Sun WorkShop Compiler C 5.0</p></li>
1.23      wiz      1520: <li class="listitem"><p>SPROcpl
1.1       dsieger  1521:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.23      wiz      1522: <li class="listitem"><p>SPROild
1.1       dsieger  1523:          - Sun WorkShop Incremental Linker</p></li>
1.23      wiz      1524: <li class="listitem"><p>SPROlang
1.1       dsieger  1525:          - Sun WorkShop Compilers common components</p></li>
                   1526: </ul></div>
                   1527: <p>You should set the following variables in your
1.10      hubertf  1528:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1529: <pre class="programlisting">
                   1530: CC=     cc
                   1531: CXX=    CC
                   1532: CPP=    cc -E
                   1533: CXXCPP= CC -E
                   1534: </pre>
1.23      wiz      1535: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1536: <h3 class="title">Note</h3>
                   1537: <p>The <code class="varname">CPP</code> setting might break some
                   1538:        packages that use the C preprocessor for processing things other
                   1539:        than C source code.</p>
                   1540: </div>
                   1541: </div>
1.23      wiz      1542: <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1.1       dsieger  1543: <div class="titlepage"><div><div><h4 class="title">
                   1544: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
                   1545: <p>To build 64-bit packages, you just need to have the
1.10      hubertf  1546:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1547: <pre class="programlisting">
                   1548: PKGSRC_COMPILER=        sunpro
                   1549: ABI=                    64
                   1550: </pre>
1.23      wiz      1551: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1552: <h3 class="title">Note</h3>
                   1553: <p>This setting has been tested for the SPARC
                   1554:        architecture. Intel and AMD machines need some more
                   1555:        work.</p>
                   1556: </div>
                   1557: </div>
1.23      wiz      1558: <div class="sect3" title="3.3.7.4. Common problems">
1.1       dsieger  1559: <div class="titlepage"><div><div><h4 class="title">
                   1560: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10      hubertf  1561: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1       dsieger  1562:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1563:       The workaround is to use another shell for the configure
                   1564:       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  1565:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1566: <pre class="programlisting">
                   1567: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1568: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1569:       </pre>
                   1570: <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>
                   1571: </div>
                   1572: </div>
                   1573: </div>
                   1574: </div>
1.23      wiz      1575: <div class="chapter" title="Chapter 4. Using pkgsrc">
1.1       dsieger  1576: <div class="titlepage"><div><div><h2 class="title">
                   1577: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1578: <div class="toc">
                   1579: <p><b>Table of Contents</b></p>
                   1580: <dl>
                   1581: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1582: <dd><dl>
                   1583: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1584: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1585: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1586: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1587: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1588: <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>
                   1589: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1590: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1591: </dl></dd>
                   1592: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1593: <dd><dl>
                   1594: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1595: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1596: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1597: </dl></dd>
                   1598: </dl>
                   1599: </div>
                   1600: <p>Basically, there are two ways of using pkgsrc. The first
                   1601: is to only install the package tools and to use binary packages
1.23      wiz      1602: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1603: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1604: of pkgsrc, too. Then you are able to build your own packages,
                   1605: and you can still use binary packages from someone else.</p>
1.23      wiz      1606: <div class="sect1" title="4.1. Using binary packages">
1.1       dsieger  1607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1608: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1609: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1610:   server and its mirrors, there are collections of binary packages,
                   1611:   ready to be installed. These binary packages have been built using the
                   1612:   default settings for the directories, that is:</p>
1.23      wiz      1613: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   1614: <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>
                   1615: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1616: <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   1617: </ul></div>
                   1618: <p>If you cannot use these directories for whatever reasons (maybe
                   1619:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1620:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.23      wiz      1621: <div class="sect2" title="4.1.1. Finding binary packages">
1.1       dsieger  1622: <div class="titlepage"><div><div><h3 class="title">
                   1623: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1624: <p>To install binary packages, you first need to know from where
                   1625:     to get them. The first place where you should look is on the main
1.10      hubertf  1626:     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   1627: <p>This directory contains binary packages for multiple
                   1628:     platforms. First, select your operating system. (Ignore the
                   1629:     directories with version numbers attached to it, they just exist for
                   1630:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1631:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1632: <p>In this directory, you often find a file called
                   1633:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1634:     management tools. If the file is missing, it is likely that your
                   1635:     operating system already provides those tools. Download the file and
                   1636:     extract it in the <code class="filename">/</code> directory. It will create
                   1637:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1638:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1639:     (the database of installed packages).</p>
1.1       dsieger  1640: </div>
1.23      wiz      1641: <div class="sect2" title="4.1.2. Installing binary packages">
1.1       dsieger  1642: <div class="titlepage"><div><div><h3 class="title">
                   1643: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1644: <p>In the directory from the last section, there is a
                   1645:     subdirectory called <code class="filename">All</code>, which contains all the
                   1646:     binary packages that are available for the platform, excluding those
                   1647:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1648:     medium you are using).</p>
1.9       rillig   1649: <p>To install packages directly from an FTP or HTTP server, run
                   1650:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1651:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1652: <pre class="screen">
                   1653: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1654: <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>
                   1655: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1656: </pre>
                   1657: <p>Instead of URLs, you can also use local paths, for example if
                   1658:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1659:     repository. If you want to install packages from multiple sources,
                   1660:     you can separate them by a semicolon in
                   1661:     <code class="varname">PKG_PATH</code>.</p>
                   1662: <p>After these preparations, installing a package is very
                   1663:     easy:</p>
                   1664: <pre class="screen">
                   1665: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1666: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1667: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1668: </pre>
1.1       dsieger  1669: <p>Note that any prerequisite packages needed to run the
                   1670:     package in question will be installed, too, assuming they are
                   1671:     present where you install from.</p>
1.23      wiz      1672: <p>Adding packages might install vulnerable packages.
                   1673:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1674:     regularly, especially after installing new packages, and verify
                   1675:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1676: <p>After you've installed packages, be sure to have
                   1677:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1678:     <code class="varname">PATH</code> so you can actually start the just
                   1679:     installed program.</p>
                   1680: </div>
1.23      wiz      1681: <div class="sect2" title="4.1.3. Deinstalling packages">
1.1       dsieger  1682: <div class="titlepage"><div><div><h3 class="title">
                   1683: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1684: <p>To deinstall a package, it does not matter whether it was
                   1685:     installed from source code or from a binary package. The
1.10      hubertf  1686:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1687:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1688:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1689:     name can be given with or without version number. Wildcards can
                   1690:     also be used to deinstall a set of packages, for example
                   1691:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1692:     so that the shell does not expand them before
                   1693:     <code class="literal">pkg_delete</code> sees them.</p>
                   1694: <p>The <code class="option">-r</code> option is very powerful: it
                   1695:     removes all the packages that require the package in question
                   1696:     and then removes the package itself. For example:
                   1697: 
                   1698:     </p>
                   1699: <pre class="screen">
                   1700: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1701:     </pre>
                   1702: <p>
                   1703: 
                   1704:     will remove jpeg and all the packages that used it; this allows
                   1705:     upgrading the jpeg package.</p>
                   1706: </div>
1.23      wiz      1707: <div class="sect2" title="4.1.4. Getting information about installed packages">
1.1       dsieger  1708: <div class="titlepage"><div><div><h3 class="title">
                   1709: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1710: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1711:     installed packages or binary package files.</p>
                   1712: </div>
1.23      wiz      1713: <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1.1       dsieger  1714: <div class="titlepage"><div><div><h3 class="title">
                   1715: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1716: <p>
                   1717:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1718:       known security vulnerabilities to packages which are (or have been)
                   1719:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1720:       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  1721:     </p>
                   1722: <p>
1.22      jakllsch 1723:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1724:       this list can be downloaded
                   1725:       automatically, and a security audit of all packages installed on a system
                   1726:       can take place.
                   1727:     </p>
                   1728: <p>
1.22      jakllsch 1729:       There are two components to auditing.  The first
                   1730:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1731:       is for downloading
1.1       dsieger  1732:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1733:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1734:       installed packages are vulnerable.  If a package is vulnerable, you
                   1735:       will see output similar to the following:
                   1736:     </p>
                   1737: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1738:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1739: <p>
1.22      jakllsch 1740:       You may wish to have the
1.10      hubertf  1741:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1742:       file downloaded daily so that
                   1743:       it remains current.  This may be done by adding an appropriate entry
1.29      dholland 1744:       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 1745:       </p>
                   1746: <pre class="screen">
                   1747: # download vulnerabilities file
                   1748: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1749:       </pre>
                   1750: <p>
                   1751:       will update the vulnerability list every day at 3AM. You may wish to do
                   1752:       this more often than once a day.
                   1753: 
                   1754:       In addition, you may wish to run the package audit from the daily
                   1755:       security script.  This may be accomplished by adding the following
                   1756:       line to <code class="filename">/etc/security.local</code>:
                   1757:       </p>
                   1758: <pre class="screen">
                   1759: /usr/sbin/pkg_admin audit
                   1760:       </pre>
                   1761: <p>
1.1       dsieger  1762:     </p>
                   1763: </div>
1.23      wiz      1764: <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1.1       dsieger  1765: <div class="titlepage"><div><div><h3 class="title">
                   1766: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1767: <p>
1.12      weinem   1768:       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      1769:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1770:       argument to check if your packages are up-to-date, e.g.
                   1771:     </p>
                   1772: <pre class="screen">
                   1773: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1774: ...
                   1775: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1776:     </pre>
1.10      hubertf  1777: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1778:     package on your system and rebuild any dependencies.
                   1779:     </p>
                   1780: </div>
1.23      wiz      1781: <div class="sect2" title="4.1.7. Other administrative functions">
1.1       dsieger  1782: <div class="titlepage"><div><div><h3 class="title">
                   1783: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1784: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1785:     administrative functions on the package system.</p>
                   1786: </div>
1.23      wiz      1787: <div class="sect2" title="4.1.8. A word of warning">
1.1       dsieger  1788: <div class="titlepage"><div><div><h3 class="title">
                   1789: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1790: <p>Please pay very careful attention to the warnings
1.29      dholland 1791:     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  1792:     inherent dangers of installing binary packages which you did
                   1793:     not create yourself, and the security holes that can be
                   1794:     introduced onto your system by indiscriminate adding of such
                   1795:     files.</p>
                   1796: <p>The same warning of course applies to every package you
                   1797:     install from source when you haven't completely read and
                   1798:     understood the source code of the package, the compiler that
                   1799:     is used to build the package and all the other tools that are
                   1800:     involved.</p>
                   1801: </div>
                   1802: </div>
1.23      wiz      1803: <div class="sect1" title="4.2. Building packages from source">
1.1       dsieger  1804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1805: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1806: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1807:   directory now contains a set of packages, organized into
                   1808:   categories. You can browse the online index of packages, or run
1.10      hubertf  1809:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1810:   directory to build local <code class="filename">README.html</code> files for
                   1811:   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>
                   1812: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1813:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1814:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1815:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1816:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1817:   system (inside a chroot is an exception). </p>
                   1818: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1819:   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  1820:   instructions how to create your own packages.</p>
1.23      wiz      1821: <div class="sect2" title="4.2.1. Requirements">
1.1       dsieger  1822: <div class="titlepage"><div><div><h3 class="title">
                   1823: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1824: <p>To build packages from source, you need a working C
                   1825:     compiler. On NetBSD, you need to install the
1.23      wiz      1826:     <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  1827:     sets. If you want to build X11-related packages, the
1.23      wiz      1828:     <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  1829:     sets are required, too.</p>
                   1830: </div>
1.23      wiz      1831: <div class="sect2" title="4.2.2. Fetching distfiles">
1.1       dsieger  1832: <div class="titlepage"><div><div><h3 class="title">
                   1833: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1834: <p>The first step for building a package is downloading the
                   1835:     distfiles (i.e. the unmodified source). If they have not yet been
                   1836:     downloaded, pkgsrc will fetch them automatically.</p>
                   1837: <p>If you have all files that you need in the
                   1838:     <code class="filename">distfiles</code> directory,
                   1839:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1840:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1841:     </p>
                   1842: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1843: <p>
1.10      hubertf  1844:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1845: <p>By default a list of distribution sites will be randomly
                   1846:     intermixed to prevent huge load on servers which holding popular
                   1847:     packages (for example, SourceForge.net mirrors). Thus, every
                   1848:     time when you need to fetch yet another distfile all the mirrors
                   1849:     will be tried in new (random) order. You can turn this feature
                   1850:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1851:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1852: <p>You can overwrite some of the major distribution sites to
                   1853:     fit to sites that are close to your own.  By setting one or two
                   1854:     variables you can modify the order in which the master sites are
                   1855:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1856:     delimited list of domain suffixes.
                   1857:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1858:     contains a whitespace delimited list of regular expressions.  It
                   1859:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1860:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1861:     some examples.  This may save some of your bandwidth and
                   1862:     time.</p>
                   1863: <p>You can change these settings either in your shell's environment, or,
                   1864:     if you want to keep the settings, by editing the
1.10      hubertf  1865:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1866:     and adding the definitions there.</p>
                   1867: <p>
                   1868:       If a package depends on many other packages (such as
                   1869:       <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
                   1870:       alternate between periods of
                   1871:       downloading source, and compiling. To ensure you have all the source
                   1872:       downloaded initially you can run the command:
                   1873:       </p>
                   1874: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1875: <p>
                   1876:       which will output and run a set of shell commands to fetch the
                   1877:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1878:       also choose to download the files manually.
                   1879:     </p>
                   1880: </div>
1.23      wiz      1881: <div class="sect2" title="4.2.3. How to build and install">
1.1       dsieger  1882: <div class="titlepage"><div><div><h3 class="title">
                   1883: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1884: <p>
                   1885:       Once the software has downloaded, any patches will be applied, then it
                   1886:       will be compiled for you. This may take some time depending on your
                   1887:       computer, and how many other packages the software depends on and their
                   1888:       compile time.
                   1889:     </p>
1.23      wiz      1890: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1891: <h3 class="title">Note</h3>
                   1892: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1893:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1894:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1895: </div>
                   1896: <p>For example, type</p>
                   1897: <pre class="screen">
                   1898: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1899: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1900:     </pre>
                   1901: <p>at the shell prompt to build the various components of the
                   1902:     package.</p>
                   1903: <p>The next stage is to actually install the newly compiled
                   1904:     program onto your system. Do this by entering:
                   1905: 
                   1906:     </p>
                   1907: <pre class="screen">
                   1908: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1909:     </pre>
                   1910: <p>
                   1911: 
                   1912:     while you are still in the directory for whatever package you
                   1913:     are installing.</p>
                   1914: <p>Installing the package on your system may require you to
                   1915:     be root.  However, pkgsrc has a
                   1916:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1917:     to only become root for the actual installation step.</p>
                   1918: <p>That's it, the software should now be installed and setup for use.
                   1919:     You can now enter:
                   1920: 
                   1921:     </p>
                   1922: <pre class="screen">
                   1923: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1924:     </pre>
                   1925: <p>
                   1926: 
                   1927:     to remove the compiled files in the work directory, as you shouldn't need
                   1928:     them any more. If other packages were also added to your system
                   1929:     (dependencies) to allow your program to compile, you can tidy these up
                   1930:     also with the command:</p>
                   1931: <pre class="screen">
                   1932: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1933:     </pre>
                   1934: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1935:     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  1936: <p>The program is installed under the default root of the
                   1937:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1938:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1939:     variable in your environment, and it will use that value as the
                   1940:     root of your packages tree. So, to use
                   1941:     <code class="filename">/usr/local</code>, set
                   1942:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1943:     Please note that you should use a directory which is dedicated to
                   1944:     packages and not shared with other programs (i.e., do not try and
                   1945:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1946:     to add any of your own files or directories (such as
                   1947:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1948:     <code class="filename">pkgsrc/</code>) below the
                   1949:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1950:     conflicts between programs and other files installed by the
                   1951:     package system and whatever else may have been installed
                   1952:     there.</p>
1.10      hubertf  1953: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1954:     alter some configuration options at build time.  Have a look at
                   1955:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1956:     of what will be set there by default.  Environment variables such
                   1957:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1958:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1959:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1960: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1961:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1962:     or being installed. This may be for debugging purposes, or out of
                   1963:     simple curiosity. A number of utility values have been added to
                   1964:     help with this.</p>
1.23      wiz      1965: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1966: <li class="listitem">
1.29      dholland 1967: <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  1968:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1969:        information will be displayed. For example,</p>
                   1970: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1971: <p>will show all the commands that are invoked, up to and
1.23      wiz      1972:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1973: </li>
1.23      wiz      1974: <li class="listitem">
1.29      dholland 1975: <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  1976:        definition, then the <code class="varname">VARNAME</code> definition
                   1977:        should be used, in conjunction with the show-var
1.29      dholland 1978:        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  1979:        variable <code class="varname">LOCALBASE</code>:</p>
                   1980: <pre class="screen">
                   1981: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1982: /usr/pkg
                   1983: <code class="prompt">%</code>
                   1984:        </pre>
                   1985: </li>
                   1986: </ol></div>
                   1987: <p>If you want to install a binary package that you've either
                   1988:     created yourself (see next section), that you put into
                   1989:     pkgsrc/packages manually or that is located on a remote FTP
                   1990:     server, you can use the "bin-install" target. This target will
1.29      dholland 1991:     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  1992:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1993:     sites searched is kept in the variable
                   1994:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.29      dholland 1995:     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  1996:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1997:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1998:     details.</p>
                   1999: <p>A final word of warning: If you set up a system that has a
                   2000:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2001:     set that before any packages are installed, as you cannot use
                   2002:     several directories for the same purpose. Doing so will result in
                   2003:     pkgsrc not being able to properly detect your installed packages,
                   2004:     and fail miserably. Note also that precompiled binary packages are
                   2005:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2006:     <code class="filename">/usr/pkg</code>, and that you should
                   2007:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2008:     <code class="varname">LOCALBASE</code>.</p>
                   2009: </div>
                   2010: </div>
                   2011: </div>
1.23      wiz      2012: <div class="chapter" title="Chapter 5. Configuring pkgsrc">
1.1       dsieger  2013: <div class="titlepage"><div><div><h2 class="title">
                   2014: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2015: <div class="toc">
                   2016: <p><b>Table of Contents</b></p>
                   2017: <dl>
                   2018: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2019: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   2020: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2021: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2022: <dd><dl>
1.4       rillig   2023: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz      2024: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2025: <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  2026: </dl></dd>
1.4       rillig   2027: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2028: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2029: </dl>
                   2030: </div>
1.4       rillig   2031: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2032: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2033: that file depends on the installation. On NetBSD, when you use
1.29      dholland 2034: <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  2035: <code class="filename">/etc/</code>. In all other cases the default location is
                   2036: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2037: bootstrap program to install the binary packages.</p>
                   2038: <p>During the bootstrap, an example configuration file is created. To
                   2039: use that, you have to create the directory
                   2040: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2041: there.</p>
                   2042: <p>The format of the configuration file is that of the usual
                   2043: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2044: is done by setting variables in this file. Note that you can define all
                   2045: kinds of variables, and no special error checking (for example for
                   2046: spelling mistakes) takes place, so you have to try it out to see if it
                   2047: works.</p>
1.23      wiz      2048: <div class="sect1" title="5.1. General configuration">
1.1       dsieger  2049: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2050: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2051: <p>In this section, you can find some variables that apply to all
                   2052:     pkgsrc packages. A complete list of the variables that can be
                   2053:     configured by the user is available in
                   2054:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2055:     comments that describe each variable's intent.</p>
1.23      wiz      2056: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2057: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  2058:            packages will be installed. The default is
                   2059:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2060:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      2061: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2062:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  2063:            installed. The default is
                   2064:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      2065: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  2066:            X11 is installed on the system. The default is
                   2067:            <code class="filename">/usr/X11R6</code>.</p></li>
1.23      wiz      2068: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  2069:            downloaded copies of the original source distributions used
                   2070:            for building pkgsrc packages. The default is
                   2071:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      2072: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  2073:            database about installed packages is stored.  The default is
                   2074:            <code class="filename">/var/db/pkg</code>.</p></li>
1.23      wiz      2075: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  2076:            If set, override the packages'
                   2077:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      2078: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  2079:            Backup location(s) for distribution files and patch files
                   2080:            if not found locally or in
                   2081:            <code class="filename">${MASTER_SITES}</code> or
                   2082:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2083:            The defaults are
1.25      spz      2084:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1       dsieger  2085:            and
                   2086:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      2087: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  2088:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2089:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      2090:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2091:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2092: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 2093:            List of acceptable licenses. License names are case-sensitive.
                   2094:            Whenever you try to build a package whose license is not in this
                   2095:            list, you will get an error message. If the license condition is
                   2096:            simple enough, the error message will include specific
                   2097:            instructions on how to change this variable.</p></li>
1.1       dsieger  2098: </ul></div>
                   2099: </div>
1.23      wiz      2100: <div class="sect1" title="5.2. Variables affecting the build process">
1.1       dsieger  2101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2102: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2103: <p>XXX
                   2104:       </p>
1.23      wiz      2105: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2106: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  2107:            directory for the binary packages. The default is
                   2108:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      2109: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  2110:            The top level directory where, if defined, the separate
                   2111:            working directories will get created, and symbolically
                   2112:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2113:            This is useful for building packages on several
                   2114:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2115:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2116:            is local to every architecture. (It should be noted that
                   2117:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 2118:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2119:            root of the pkgsrc tree. It is possible to have many
                   2120:            pkgsrc tree instances.)</p></li>
1.23      wiz      2121: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  2122:            Directory for local patches that aren't part of pkgsrc.
1.10      hubertf  2123:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2124:            information.</p></li>
1.23      wiz      2125: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  2126:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2127:            BSD-style Makefile. If this is not set,
                   2128:            <code class="varname">MAKECONF</code> is set to
                   2129:            <code class="filename">/dev/null</code> to avoid picking up
                   2130:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23      wiz      2131: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger  2132:            By default, dependencies are only installed, and no binary
                   2133:            package is created for them. You can set this variable to
                   2134:            <code class="literal">package</code> to automatically create binary
                   2135:            packages after installing dependencies.</p></li>
                   2136: </ul></div>
                   2137: </div>
1.23      wiz      2138: <div class="sect1" title="5.3. Variables affecting the installation process">
1.1       dsieger  2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   2140: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24      wiz      2141: <p>Most packages support installation into a
1.4       rillig   2142:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2143:     to be built, before the actual filesystem is touched. DESTDIR
                   2144:     support exists in two variations:</p>
1.23      wiz      2145: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2146: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      2147:       installation and packaging is still run as root.</p></li>
                   2148: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2149:       build, installation and packaging as normal user. Root
                   2150:       privileges are only needed to add packages.</p></li>
                   2151: </ul></div>
                   2152: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
                   2153:     you can set
                   2154:     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
                   2155:     so it's preferable to convert a package to DESTDIR instead.</p>
1.4       rillig   2156: <p>DESTDIR support changes the behaviour of various targets
                   2157:     slightly. To install a package after building it, use
                   2158:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2159:     <code class="literal">install</code> don't do that any
                   2160:     longer. <code class="literal">package-install</code> can be used as
                   2161:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2162:     will ask for the root password to install the package and fail,
                   2163:     <code class="literal">package-install</code> will ask again.</p>
                   2164: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2165:     clean</code></strong> needs to be run as root.</p>
1.17      imil     2166: <p>Considering the <code class="filename">foo/bar</code> package,
                   2167:     DESTDIR full support can be tested using the following commands
                   2168: 
                   2169: </p>
                   2170: <pre class="programlisting">
                   2171: <code class="prompt">$</code> id
                   2172: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2173: <code class="prompt">$</code> mkdir $HOME/packages
                   2174: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2175: </pre>
                   2176: <p>
                   2177: 
                   2178:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2179:     should be needed
                   2180: 
                   2181: </p>
                   2182: <pre class="programlisting">
1.20      snj      2183: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17      imil     2184: </pre>
                   2185: <p>
                   2186: 
                   2187:     Create a package without root privileges
                   2188: 
                   2189: </p>
                   2190: <pre class="programlisting">
1.20      snj      2191: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17      imil     2192: </pre>
                   2193: <p>
                   2194: 
                   2195:     For the following command, you must be able to gain root
1.29      dholland 2196:     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     2197: 
                   2198: </p>
                   2199: <pre class="programlisting">
1.20      snj      2200: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17      imil     2201: </pre>
                   2202: <p>
                   2203: 
                   2204:     Then, as a simple user
                   2205: 
                   2206: </p>
                   2207: <pre class="programlisting">
                   2208: <code class="prompt">$</code> make clean
                   2209: </pre>
                   2210: <p>
                   2211: 
                   2212:     </p>
1.4       rillig   2213: </div>
1.23      wiz      2214: <div class="sect1" title="5.4. Selecting and configuring the compiler">
1.4       rillig   2215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2216: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.23      wiz      2217: <div class="sect2" title="5.4.1. Selecting the compiler">
1.1       dsieger  2218: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2219: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2220: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2221:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2222: <div class="variablelist"><dl>
                   2223: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2224: <dd>
                   2225: <p>This is a list of values specifying the chain of
                   2226:          compilers to invoke when building packages.  Valid values
                   2227:          are:</p>
1.23      wiz      2228: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2229: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  2230:            distributed C/C++ (chainable)</p></li>
1.23      wiz      2231: <li class="listitem"><p><code class="varname">ccache</code>:
1.1       dsieger  2232:            compiler cache (chainable)</p></li>
1.23      wiz      2233: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  2234:            GNU C/C++ Compiler</p></li>
1.23      wiz      2235: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2236:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23      wiz      2237: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  2238:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      2239: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  2240:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2241: </ul></div>
                   2242: <p>The default is
1.23      wiz      2243:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  2244:          <code class="varname">ccache</code> and/or
                   2245:          <code class="varname">distcc</code> with an appropriate
                   2246:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      2247:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  2248:          variable should always be terminated with a value for
                   2249:          a real compiler.  Note that only one real compiler
1.23      wiz      2250:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  2251:          is not allowed).</p>
                   2252: </dd>
                   2253: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2254: <dd><p>This specifies the minimum version of GCC to use
                   2255:          when building packages.  If the system GCC doesn't
                   2256:          satisfy this requirement, then pkgsrc will build and
                   2257:          install one of the GCC packages to use instead.</p></dd>
                   2258: </dl></div>
                   2259: </div>
1.23      wiz      2260: <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
1.1       dsieger  2261: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2262: <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  2263: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2264:        please make sure to use the <code class="literal">+=</code> operator
                   2265:        instead of the <code class="literal">=</code> operator:</p>
                   2266: <pre class="programlisting">
                   2267: CFLAGS+=        -your -flags
                   2268: </pre>
                   2269: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      2270:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  2271:        need to add their own flags.  You may want to take a look
                   2272:        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      2273:        package if you're interested in optimization specifically
                   2274:        for the current CPU. </p>
1.1       dsieger  2275: </div>
1.23      wiz      2276: <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
1.1       dsieger  2277: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2278: <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  2279: <p>If you want to pass flags to the linker, both in the configure
                   2280: step and the build step, you can do this in two ways.  Either set
                   2281: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2282: between the two is that <code class="varname">LIBS</code> will be appended to
                   2283: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2284: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2285: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2286: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2287: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2288: settings, use the <code class="literal">+=</code> operator:</p>
                   2289: <pre class="programlisting">
                   2290: LDFLAGS+=        -your -linkerflags
                   2291: </pre>
                   2292: </div>
                   2293: </div>
1.23      wiz      2294: <div class="sect1" title="5.5. Developer/advanced settings">
1.1       dsieger  2295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2296: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2297: <p>XXX
                   2298:       </p>
1.23      wiz      2299: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2300: <li class="listitem">
1.1       dsieger  2301: <p><code class="varname">PKG_DEVELOPER</code>:
                   2302:            Run some sanity checks that package developers want:
                   2303:            </p>
1.23      wiz      2304: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2305: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  2306:              fuzz</p></li>
1.23      wiz      2307: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  2308:              binaries will find their shared libs.</p></li>
                   2309: </ul></div>
                   2310: <p>
                   2311:        </p>
                   2312: </li>
1.23      wiz      2313: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  2314:        of debugging output which is displayed whilst making and
                   2315:        installing the package.  The default value for this is 0,
                   2316:        which will not display the commands as they are executed
                   2317:        (normal, default, quiet operation); the value 1 will display
                   2318:        all shell commands before their invocation, and the value 2
                   2319:        will display both the shell commands before their invocation,
1.10      hubertf  2320:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger  2321:        -x</strong></span> will be displayed.</p></li>
                   2322: </ul></div>
                   2323: <p>
                   2324:     </p>
                   2325: </div>
1.23      wiz      2326: <div class="sect1" title="5.6. Selecting Build Options">
1.1       dsieger  2327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2328: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2329: <p>Some packages have build time options, usually to select
                   2330:     between different dependencies, enable optional support for big
                   2331:     dependencies or enable experimental features.</p>
                   2332: <p>To see which options, if any, a package supports, and which
1.10      hubertf  2333:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2334:     show-options</strong></span>, for example:</p>
                   2335: <pre class="programlisting">
                   2336:     The following options are supported by this package:
                   2337:         ssl      Enable SSL support.
                   2338:     Exactly one of the following gecko options is required:
                   2339:         firefox  Use firefox as gecko rendering engine.
                   2340:         mozilla  Use mozilla as gecko rendering engine.
                   2341:     At most one of the following database options may be selected:
                   2342:         mysql    Enable support for MySQL database.
                   2343:         pgsql    Enable support for PostgreSQL database.
                   2344: 
                   2345:     These options are enabled by default: firefox
                   2346:     These options are currently enabled: mozilla ssl
                   2347: </pre>
                   2348: <p>The following variables can be defined in
1.10      hubertf  2349:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2350:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2351:     which can be used to select or disable options for all packages
                   2352:     that support them, and
                   2353:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2354:     which can be used to select or disable options specifically for
                   2355:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      2356:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2357:     are disabled. A few examples:</p>
                   2358: <pre class="screen">
1.10      hubertf  2359: <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  2360: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2361: PKG_OPTIONS.kdebase=    debug -sasl
                   2362: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2363: <p>It is important to note that options that were specifically
1.18      snj      2364:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   2365:     you do not wish to include the option.  If you are unsure you can view
                   2366:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2367: <p>The following settings are consulted in the order given, and
                   2368:     the last setting that selects or disables an option is
                   2369:     used:</p>
1.23      wiz      2370: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2371: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2372:       maintainer</p></li>
1.23      wiz      2373: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2374:       variables (see below)</p></li>
1.23      wiz      2375: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2376: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  2377: </ol></div>
                   2378: <p>For groups of mutually exclusive options, the last option
                   2379:     selected is used, all others are automatically disabled.  If an
                   2380:     option of the group is explicitly disabled, the previously
                   2381:     selected option, if any, is used.  It is an error if no option
                   2382:     from a required group of options is selected, and building the
                   2383:     package will fail.</p>
                   2384: <p>Before the options framework was introduced, build options
                   2385:     were selected by setting a variable (often named
                   2386:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2387:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2388:     transition to the options framework for the user, these legacy
                   2389:     variables are converted to the appropriate options setting
                   2390:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2391:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2392:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2393:     directly.  Support for the legacy variables will be removed
                   2394:     eventually.</p>
                   2395: </div>
                   2396: </div>
1.23      wiz      2397: <div class="chapter" title="Chapter 6. Creating binary packages">
1.1       dsieger  2398: <div class="titlepage"><div><div><h2 class="title">
                   2399: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2400: <div class="toc">
                   2401: <p><b>Table of Contents</b></p>
                   2402: <dl>
                   2403: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2404: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2405: </dl>
                   2406: </div>
1.23      wiz      2407: <div class="sect1" title="6.1. Building a single binary package">
1.1       dsieger  2408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2409: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2410: <p>Once you have built and installed a package, you can create
                   2411:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29      dholland 2412:     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  2413:     the same package on a group of hosts and wasting CPU time. It also
                   2414:     provides a simple means for others to install your package, should
                   2415:     you distribute it.</p>
                   2416: <p>To create a binary package, change into the appropriate
1.10      hubertf  2417:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2418:     package</strong></span>:</p>
                   2419: <pre class="screen">
                   2420: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2421: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2422:     </pre>
                   2423: <p>This will build and install your package (if not already done),
                   2424:     and then build a binary package from what was installed. You can
1.10      hubertf  2425:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2426:     it. Binary packages are created by default in
                   2427:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2428:     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  2429:     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  2430: <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  2431:     such a binary package.</p>
                   2432: </div>
1.23      wiz      2433: <div class="sect1" title="6.2. Settings for creation of binary packages">
1.1       dsieger  2434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2435: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2436: <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   2437: </div>
                   2438: </div>
1.23      wiz      2439: <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
1.6       rillig   2440: <div class="titlepage"><div><div><h2 class="title">
                   2441: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2442: builds)</h2></div></div></div>
                   2443: <div class="toc">
                   2444: <p><b>Table of Contents</b></p>
                   2445: <dl>
                   2446: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2447: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2448: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2449: <dd><dl>
                   2450: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2451: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2452: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2453: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2454: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2455: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2456: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2457: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2458: </dl></dd>
                   2459: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig   2460: <dd><dl>
                   2461: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2462: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2463: </dl></dd>
1.6       rillig   2464: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2465: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2466: </dl>
                   2467: </div>
                   2468: <p>When you have multiple machines that should run the same packages,
                   2469: it is wasted time if they all build their packages themselves from
                   2470: source. There are two ways of getting a set of binary packages: The old
                   2471: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2472: system. This chapter describes how to set them up so that the packages
                   2473: are most likely to be usable later.</p>
1.23      wiz      2474: <div class="sect1" title="7.1. Think first, build later">
1.6       rillig   2475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2476: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2477: <p>Since a bulk build takes several days or even weeks to finish, you
                   2478: should think about the setup before you start everything. Pay attention
                   2479: to at least the following points:</p>
1.23      wiz      2480: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2481: <li class="listitem">
1.6       rillig   2482: <p>If you want to upload the binary packages to
                   2483: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2484: packages:</p>
1.23      wiz      2485: <div class="itemizedlist"><ul class="itemizedlist" type="circle">
                   2486: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6       rillig   2487: by a NetBSD developer on a trusted machine (that is, where you and only
                   2488: you have root access).</p></li>
1.23      wiz      2489: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21      snj      2490: the stable branches (like 2009Q1), so that users browsing the available
1.6       rillig   2491: collections can see at a glance how old the packages
                   2492: are.</p></li>
1.23      wiz      2493: <li class="listitem"><p>The packages must be built as root, since some packages
1.6       rillig   2494: require set-uid binaries at runtime, and creating those packages as
                   2495: unprivileged user doesn't work well at the moment.</p></li>
                   2496: </ul></div>
                   2497: </li>
1.23      wiz      2498: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6       rillig   2499: your system. Most bulk builds run as root, so they should be run at least
                   2500: in a chroot environment or something even more restrictive, depending on
                   2501: what the operating system provides. There have been numerous cases where
                   2502: certain packages tried to install files outside the
                   2503: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2504: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2505: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2506: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2507: that you don't need any package during the build.</p></li>
                   2508: </ul></div>
                   2509: </div>
1.23      wiz      2510: <div class="sect1" title="7.2. Requirements of a bulk build">
1.6       rillig   2511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2512: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2513: <p>A complete bulk build requires lots of disk space. Some of the
                   2514: disk space can be read-only, some other must be writable. Some can be on
                   2515: remote filesystems (such as NFS) and some should be local. Some can be
                   2516: temporary filesystems, others must survive a sudden reboot.</p>
1.23      wiz      2517: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2518: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2519: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2520: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2521: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2522: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2523: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6       rillig   2524: </ul></div>
1.1       dsieger  2525: </div>
1.23      wiz      2526: <div class="sect1" title="7.3. Running an old-style bulk build">
1.1       dsieger  2527: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2528: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.23      wiz      2529: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15      rillig   2530: <h3 class="title">Note</h3>
                   2531: <p>There are two ways of doing a bulk build. The old-style
1.23      wiz      2532: one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
1.15      rillig   2533: way.</p>
1.6       rillig   2534: </div>
1.23      wiz      2535: <div class="sect2" title="7.3.1. Configuration">
1.1       dsieger  2536: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2537: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.23      wiz      2538: <div class="sect3" title="7.3.1.1. build.conf">
1.1       dsieger  2539: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2540: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2541: </h4></div></div></div>
                   2542: <p>The <code class="filename">build.conf</code> file is the main
                   2543:        configuration file for bulk builds. You can configure how your
                   2544:        copy of pkgsrc is kept up to date, how the distfiles are
                   2545:        downloaded, how the packages are built and how the report is
                   2546:        generated. You can find an annotated example file in
                   2547:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2548:        it, copy <code class="filename">build.conf-example</code> to
                   2549:        <code class="filename">build.conf</code> and edit it, following the
                   2550:        comments in that file.</p>
                   2551: </div>
1.23      wiz      2552: <div class="sect3" title="7.3.1.2. mk.conf">
1.1       dsieger  2553: <div class="titlepage"><div><div><h4 class="title">
1.10      hubertf  2554: <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   2555: </h4></div></div></div>
1.10      hubertf  2556: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2557:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2558:        details of the default settings. You will want to ensure that
                   2559:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22      jakllsch 2560:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4       rillig   2561:        completely bypasses the license check.</p>
1.1       dsieger  2562: <pre class="programlisting">
                   2563: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2564: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2565: BSDSRCDIR=      /usr/src
                   2566: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2567: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2568: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2569: PKG_DEVELOPER?= yes
1.22      jakllsch 2570: SKIP_LICENSE_CHECK=    yes
1.1       dsieger  2571: </pre>
                   2572: <p>Some options that are especially useful for bulk builds
                   2573:        can be found at the top lines of the file
                   2574:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2575:        options of these are briefly described here.</p>
1.23      wiz      2576: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2577: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1       dsieger  2578:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23      wiz      2579:          <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
                   2580: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1       dsieger  2581:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2582:          to the directory where all log files are created. Otherwise the
                   2583:          log files are created in the pkgsrc directory.</p></li>
1.23      wiz      2584: <li class="listitem"><p>Another important variable is
1.1       dsieger  2585:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2586:          should be always available while building other
                   2587:          packages.</p></li>
                   2588: </ul></div>
                   2589: <p>Some other options are scattered in the pkgsrc
                   2590:        infrastructure:</p>
1.23      wiz      2591: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2592: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2593:          should be set to <code class="literal">yes</code>. The purpose of the
                   2594:          bulk builds is creating binary packages, no matter if they
                   2595:          are vulnerable or not. Leaving this variable unset would
                   2596:          prevent the bulk build system from even trying to build
                   2597:          them, so possible building errors would not show
                   2598:          up.</p></li>
                   2599: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1       dsieger  2600:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23      wiz      2601:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
1.1       dsieger  2602:          matches the <code class="filename">PLIST</code>.</p></li>
1.23      wiz      2603: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1       dsieger  2604:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23      wiz      2605:          <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
                   2606:          <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
1.1       dsieger  2607:          interpreter.</p></li>
1.23      wiz      2608: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2609:          set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
1.1       dsieger  2610:          package's self-test before installing it. Note that some
1.23      wiz      2611:          packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
1.1       dsieger  2612:          numbers, so you need to assure that the machine on which you
                   2613:          are doing the bulk builds is not completely idle. Otherwise
                   2614:          some test programs will seem to hang, while they are just
                   2615:          waiting for new random data to be
                   2616:          available.</p></li>
                   2617: </ul></div>
                   2618: </div>
1.23      wiz      2619: <div class="sect3" title="7.3.1.3. pre-build.local">
1.1       dsieger  2620: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2621: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2622: </h4></div></div></div>
                   2623: <p>It is possible to configure the bulk build to perform
                   2624:        certain site-specific tasks at the end of the pre-build
                   2625:        stage.  If the file
                   2626:        <code class="filename">pre-build.local</code> exists in
                   2627:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29      dholland 2628:        (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  2629:        stage.  An example use of
                   2630:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2631: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2632:        &gt; misc/openoffice/$BROKENF</pre>
                   2633: <p>to prevent the system from trying to build a particular package
                   2634:        which requires nearly 3 GB of disk space.</p>
                   2635: </div>
                   2636: </div>
1.23      wiz      2637: <div class="sect2" title="7.3.2. Other environmental considerations">
1.1       dsieger  2638: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2639: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2640: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2641:       deleted at the start of bulk builds, make sure your login
                   2642:       shell is placed somewhere else. Either drop it into
                   2643:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2644:       shell in the passwd file), or (re-)install it via
1.29      dholland 2645:       <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  2646:       you can login after a reboot (remember that your current
                   2647:       process won't die if the package is removed, you just can't
                   2648:       start any new instances of the shell any more).  Also, if you
                   2649:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2650:       version of ssh for some reason, be sure to install ssh before
                   2651:       starting it from <code class="filename">rc.local</code>:</p>
                   2652: <pre class="programlisting">
                   2653: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2654: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2655:   /usr/pkg/etc/rc.d/sshd
                   2656: fi
                   2657: </pre>
                   2658: <p>Not doing so will result in you being not able to log in
                   2659:       via ssh after the bulk build is finished or if the machine
                   2660:       gets rebooted or crashes. You have been warned! :)</p>
                   2661: </div>
1.23      wiz      2662: <div class="sect2" title="7.3.3. Operation">
1.1       dsieger  2663: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2664: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2665: <p>Make sure you don't need any of the packages still
                   2666:       installed.</p>
1.23      wiz      2667: <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  2668: <h3 class="title">Warning</h3>
                   2669: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2670:        configuration files and some more files from
                   2671:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2672:        possibly other locations will be removed! So don't run a bulk
                   2673:        build with privileges that might harm your
                   2674:        system.</em></span></p>
                   2675: </div>
                   2676: <p>Be sure to remove all other things that might
                   2677:       interfere with builds, like some libs installed in
                   2678:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2679: <pre class="screen">
                   2680: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2681: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2682:       </pre>
                   2683: <p>If for some reason your last build didn't complete (power
                   2684:       failure, system panic, ...), you can continue it by
                   2685:       running:</p>
                   2686: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2687: <p>At the end of the bulk build, you will get a summary via mail,
                   2688:       and find build logs in the directory specified by
                   2689:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2690:       file.</p>
                   2691: </div>
1.23      wiz      2692: <div class="sect2" title="7.3.4. What it does">
1.1       dsieger  2693: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2694: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2695: <p>The bulk builds consist of three steps:</p>
                   2696: <div class="variablelist"><dl>
                   2697: <dt><span class="term">1. pre-build</span></dt>
                   2698: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2699:            cleans out any broken distfiles, and removes all
                   2700:            packages installed.</p></dd>
                   2701: <dt><span class="term">2. the bulk build</span></dt>
1.23      wiz      2702: <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
1.1       dsieger  2703:            an optimised order in which packages will be
                   2704:            built. Packages that don't require other packages will
                   2705:            be built first, and packages with many dependencies will
                   2706:            be built later.</p></dd>
                   2707: <dt><span class="term">3. post-build</span></dt>
                   2708: <dd><p>Generates a report that's placed in the directory
                   2709:            specified in the <code class="filename">build.conf</code> file
                   2710:            named <code class="filename">broken.html</code>, a short version
                   2711:            of that report will also be mailed to the build's
                   2712:            admin.</p></dd>
                   2713: </dl></div>
                   2714: <p>During the build, a list of broken packages will be compiled
                   2715:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2716:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2717:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2718:       of broken builds can be found in the package's
                   2719:       directory. These files are used by the bulk-targets to mark
                   2720:       broken builds to not waste time trying to rebuild them, and
                   2721:       they can be used to debug these broken package builds
                   2722:       later.</p>
                   2723: </div>
1.23      wiz      2724: <div class="sect2" title="7.3.5. Disk space requirements">
1.1       dsieger  2725: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2726: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2727: <p>Currently, roughly the following requirements are valid for
                   2728:       NetBSD 2.0/i386:</p>
1.23      wiz      2729: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2730: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
                   2731: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2732: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1       dsieger  2733: </ul></div>
                   2734: <p>Note that all pkgs will be de-installed as soon as they are
                   2735:       turned into a binary package, and that sources are removed,
                   2736:       so there is no excessively huge demand to disk
                   2737:       space. Afterwards, if the package is needed again, it will
1.29      dholland 2738:       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  2739:       there are no cycles wasted by recompiling.</p>
                   2740: </div>
1.23      wiz      2741: <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
1.1       dsieger  2742: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2743: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2744: <p>If you don't want all the packages nuked from a machine
                   2745:       (rendering it useless for anything but pkg compiling), there
                   2746:       is the possibility of doing the package bulk build inside a
                   2747:       chroot environment.</p>
                   2748: <p>The first step is to set up a chroot sandbox,
                   2749:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2750:       using null mounts, or manually.</p>
                   2751: <p>There is a shell script called
                   2752:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2753:       up the sandbox environment using null mounts. It will also
                   2754:       create a script called <code class="filename">sandbox</code> in the
                   2755:       root of the sandbox environment, which will allow the null
1.10      hubertf  2756:       mounts to be activated using the <span class="command"><strong>sandbox
1.1       dsieger  2757:       mount</strong></span> command and deactivated using the
1.10      hubertf  2758:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1       dsieger  2759: <p>To set up a sandbox environment by hand, after extracting all
1.10      hubertf  2760:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1       dsieger  2761:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2762:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2763:       are present and properly configured:</p>
1.23      wiz      2764: <div class="procedure"><ol class="procedure" type="1">
                   2765: <li class="step" title="Step 1">
1.1       dsieger  2766: <p>Kernel</p>
                   2767: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2768: </li>
1.23      wiz      2769: <li class="step" title="Step 2">
1.1       dsieger  2770: <p><code class="filename">/dev/*</code></p>
                   2771: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2772: </li>
1.23      wiz      2773: <li class="step" title="Step 3">
1.1       dsieger  2774: <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>
                   2775: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2776: </li>
1.23      wiz      2777: <li class="step" title="Step 4">
1.1       dsieger  2778: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2779: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2780: </li>
1.23      wiz      2781: <li class="step" title="Step 5">
1.1       dsieger  2782: <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>
                   2783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2784: </li>
1.23      wiz      2785: <li class="step" title="Step 6">
1.1       dsieger  2786: <p><code class="filename">/usr/src</code> (system sources,
1.14      jmcneill 2787:          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  2788: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2789:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2790: </li>
1.23      wiz      2791: <li class="step" title="Step 7">
1.1       dsieger  2792: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2793: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2794: </li>
1.23      wiz      2795: <li class="step" title="Step 8">
1.1       dsieger  2796: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2797: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2798: </li>
1.23      wiz      2799: <li class="step" title="Step 9">
1.1       dsieger  2800: <p>Checkout pkgsrc via cvs into
                   2801:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2802: <pre class="screen">
                   2803: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2804: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2805:          </pre>
                   2806: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2807:          you do development in, as this will likely cause problems!</p>
                   2808: </li>
1.23      wiz      2809: <li class="step" title="Step 10"><p>Make
1.1       dsieger  2810:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2811:          <code class="filename">.../distfiles</code> point somewhere
                   2812:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.23      wiz      2813: <li class="step" title="Step 11"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
                   2814: <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.1       dsieger  2815: </ol></div>
                   2816: <p>When the chroot sandbox is set up, you can start
                   2817:       the build with the following steps:</p>
                   2818: <pre class="screen">
                   2819: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2820: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2821:       </pre>
                   2822: <p>This will just jump inside the sandbox and start building.  At
                   2823:        the end of the build, mail will be sent with the results of
                   2824:        the build. Created binary pkgs will be in
                   2825:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2826:       (wherever that points/mounts to/from).</p>
                   2827: </div>
1.23      wiz      2828: <div class="sect2" title="7.3.7. Building a partial set of packages">
1.1       dsieger  2829: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2830: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2831: <p>In addition to building a complete set of all packages in
                   2832:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2833:       may be used to build a subset of the packages contained in
                   2834:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.10      hubertf  2835:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.23      wiz      2836: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2837: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
                   2838: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
                   2839: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
                   2840: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1       dsieger  2841: </ul></div>
                   2842: <p>will define the set of packages which should be built.
                   2843:       The bulk build code will also include any packages which are
                   2844:       needed as dependencies for the explicitly listed packages.</p>
                   2845: <p>One use of this is to do a bulk build with
                   2846:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2847:       periodically to have a complete set of the binary packages
                   2848:       needed for your site available without the overhead of
                   2849:       building extra packages that are not needed.</p>
                   2850: </div>
1.23      wiz      2851: <div class="sect2" title="7.3.8. Uploading results of a bulk build">
1.1       dsieger  2852: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2853: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2854: <p>This section describes how pkgsrc developers can upload binary
                   2855:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2856: <p>If you would like to automatically create checksum files for the
                   2857:       binary packages you intend to upload, remember to set
                   2858:       <code class="varname">MKSUMS=yes</code> in your
                   2859:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2860: <p>If you would like to PGP sign the checksum files (highly
                   2861:       recommended!), remember to set
                   2862:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2863:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2864:       your GPG password to sign the files before uploading everything.</p>
                   2865: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2866:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2867:       file, i.e. adjust it to something like one of the following:</p>
1.25      spz      2868: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
                   2869: <p>Please use appropriate values for "20xxQy" (the branch),
                   2870:       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1       dsieger  2871:       is different from your local login, write your login directly
                   2872:       into the variable, e.g. my local account is "feyrer", but for my
                   2873:       login "hubertf", I use:</p>
1.25      spz      2874: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1       dsieger  2875: <p>A separate <code class="filename">upload</code> directory is used
                   2876:       here to allow "closing" the directory during upload. To do
                   2877:       so, run the following command on ftp.NetBSD.org next:</p>
1.25      spz      2878: <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  2879: <p>Before uploading the binary pkgs, ssh authentication needs
                   2880:       to be set up. This example shows how to set up temporary keys
                   2881:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2882:       (assuming that no keys should be present there usually):</p>
                   2883: <pre class="screen">
                   2884: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2885: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25      spz      2886: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
                   2887: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1       dsieger  2888:       </pre>
1.25      spz      2889: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1       dsieger  2890:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25      spz      2891:       file on ftp.NetBSD.org. You should remove the key after the
1.1       dsieger  2892:       upload is done!</p>
                   2893: <p>Next, test if your ssh connection really works:</p>
                   2894: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2895: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2896: <p>Now after all this works, you can exit the sandbox and start
                   2897:       the upload:</p>
                   2898: <pre class="screen">
                   2899: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2900: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2901: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2902:       </pre>
1.29      dholland 2903: <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
                   2904:       <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  2905:       upload. The upload script will take care of not uploading
1.23      wiz      2906:       restricted packages.</p>
1.1       dsieger  2907: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2908: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2909:       Gdd:x! </pre>
                   2910: <p>Use whatever is needed to remove the key you've entered
                   2911:       before! Last, move the uploaded packages out of the
                   2912:       <code class="filename">upload</code> directory to have them accessible
                   2913:       to everyone:</p>
                   2914: <pre class="screen">
1.25      spz      2915: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1       dsieger  2916: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2917: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25      spz      2918: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
                   2919: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1       dsieger  2920:       </pre>
                   2921: </div>
                   2922: </div>
1.23      wiz      2923: <div class="sect1" title="7.4. Running a pbulk-style bulk build">
1.1       dsieger  2924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2925: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2926: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.23      wiz      2927: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2928: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2929: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2930: </ul></div>
1.23      wiz      2931: <div class="sect2" title="7.4.1. Preparation">
1.15      rillig   2932: <div class="titlepage"><div><div><h3 class="title">
                   2933: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
                   2934: <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>
                   2935: <pre class="screen">
                   2936: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2937: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   2938: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   2939: </pre>
                   2940: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.23      wiz      2941: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   2942: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   2943: <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>
                   2944: <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>
                   2945: <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>
                   2946: <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   2947: </ul></div>
                   2948: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   2949: <pre class="screen">
                   2950: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   2951: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   2952: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   2953: </pre>
                   2954: <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>
                   2955: </div>
1.23      wiz      2956: <div class="sect2" title="7.4.2. Configuration">
1.6       rillig   2957: <div class="titlepage"><div><div><h3 class="title">
1.15      rillig   2958: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14      jmcneill 2959: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15      rillig   2960: <p>TODO: continue writing</p>
1.6       rillig   2961: </div>
                   2962: </div>
1.23      wiz      2963: <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
1.6       rillig   2964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2965: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2966: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2967:     create a CD-ROM set of the resulting binary packages to assist
                   2968:     in installing packages on other machines.  The
                   2969:     <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
                   2970:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2971:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2972:     way that keeps all the dependencies for a given package on the same
                   2973:     CD as that package.</p>
1.23      wiz      2974: <div class="sect2" title="7.5.1. Example of cdpack">
1.1       dsieger  2975: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2976: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2977: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2978:       man page. The following short example assumes that the binary
                   2979:       packages are left in
                   2980:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2981:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2982:       hold the ISO 9660 images.</p>
                   2983: <pre class="screen">
                   2984: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2985: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2986: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2987:       </pre>
                   2988: <p>If you wish to include a common set of files
                   2989:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2990:       etc.) on each CD in the collection, then you need to create a
                   2991:       directory which contains these files. e.g.</p>
                   2992: <pre class="screen">
                   2993: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2994: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2995: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2996: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2997: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2998: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2999: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3000:       </pre>
                   3001: <p>Now create the images:</p>
                   3002: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   3003: <p>Each image will contain <code class="filename">README</code>,
                   3004:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3005:       in their root directories.</p>
                   3006: </div>
                   3007: </div>
                   3008: </div>
1.23      wiz      3009: <div class="chapter" title="Chapter 8. Directory layout of the installed files">
1.1       dsieger  3010: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3011: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  3012: <div class="toc">
                   3013: <p><b>Table of Contents</b></p>
                   3014: <dl>
1.23      wiz      3015: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   3016: <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  3017: </dl>
                   3018: </div>
                   3019: <p>The files that are installed by pkgsrc are organized in a way that
                   3020: is similar to what you find in the <code class="filename">/usr</code> directory
                   3021: of the base system. But some details are different. This is because
                   3022: pkgsrc initially came from FreeBSD and had adopted its file system
                   3023: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3024: which operating system you are using pkgsrc with, you can expect the
                   3025: same layout for pkgsrc.</p>
                   3026: <p>There are mainly four root directories for pkgsrc, which are all
                   3027: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3028: When pkgsrc has been installed as root, the default locations
                   3029: are:</p>
                   3030: <pre class="programlisting">
                   3031: LOCALBASE=              /usr/pkg
                   3032: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3033: VARBASE=                /var
                   3034: PKG_DBDIR=              /var/db/pkg
                   3035: </pre>
                   3036: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3037: user), the default locations are:</p>
                   3038: <pre class="programlisting">
                   3039: LOCALBASE=              ${HOME}/pkg
                   3040: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3041: VARBASE=                ${HOME}/pkg/var
                   3042: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3043: </pre>
                   3044: <p>What these four directories are for, and what they look like is
                   3045: explained below.</p>
1.23      wiz      3046: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3047: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  3048: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      3049: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  3050: the well-known subdirectories like <code class="filename">bin</code>,
                   3051: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3052: <code class="filename">share</code> and
                   3053: <code class="filename">sbin</code>.</p></li>
1.23      wiz      3054: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  3055: <code class="filename">/var</code> in the base system. Some programs (especially
                   3056: games, network daemons) need write access to it during normal
                   3057: operation.</p></li>
1.23      wiz      3058: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  3059: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  3060: 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  3061: itself.</p></li>
                   3062: </ul></div>
1.23      wiz      3063: <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
1.1       dsieger  3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3065: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3066: </h2></div></div></div>
                   3067: <p>The following directories exist in a typical pkgsrc installation
                   3068: in <code class="filename">${LOCALBASE}</code>.</p>
                   3069: <div class="variablelist"><dl>
                   3070: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3071: <dd><p>Contains executable programs that are intended to be
                   3072: directly used by the end user.</p></dd>
                   3073: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3074: <dd><p>Contains files for the emulation layers of various other
                   3075: operating systems, especially for
                   3076: NetBSD.</p></dd>
                   3077: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3078: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3079: <dd><p>Contains
                   3080: the configuration files.</p></dd>
                   3081: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3082: <dd><p>Contains headers for the C and C++ programming
                   3083: languages.</p></dd>
                   3084: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3085: <dd><p>Contains GNU info files of various
                   3086: packages.</p></dd>
                   3087: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3088: <dd><p>Contains shared and static
                   3089: libraries.</p></dd>
                   3090: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3091: <dd><p>Contains data files that don't change after
                   3092: installation. Other data files belong into
                   3093: <code class="filename">${VARBASE}</code>.</p></dd>
                   3094: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3095: <dd><p>Contains programs that are not intended to be used by
                   3096: end users, such as helper programs or network
                   3097: daemons.</p></dd>
                   3098: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3099: <dd><p>Contains programs that are intended to be executed as
                   3100: CGI scripts by a web server.</p></dd>
                   3101: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3102: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3103: <dd><p>Contains brief
                   3104: documentation in form of manual pages.</p></dd>
                   3105: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3106: <dd><p>Contains programs that are intended to be used only by
                   3107: the super-user.</p></dd>
                   3108: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3109: <dd><p>Contains platform-independent data files that don't
                   3110: change after installation.</p></dd>
                   3111: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3112: <dd><p>Contains documentation files provided by the
                   3113: packages.</p></dd>
                   3114: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3115: <dd><p>Contains example files provided by the packages. Among
                   3116: others, the original configuration files are saved here and copied to
                   3117: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3118: installation.</p></dd>
                   3119: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3120: <dd><p>Contains the original files for rc.d
                   3121: scripts.</p></dd>
                   3122: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3123: <code class="filename">${VARBASE}</code>)</span></dt>
                   3124: <dd><p>Contains files
                   3125: that may be modified after
                   3126: installation.</p></dd>
                   3127: </dl></div>
                   3128: </div>
1.23      wiz      3129: <div class="sect1" title="8.2. File system layout in ${VARBASE}">
1.1       dsieger  3130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3131: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3132: </h2></div></div></div>
                   3133: <div class="variablelist"><dl>
                   3134: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3135: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3136: <dd><p>Contains
                   3137: information about the currently installed
                   3138: packages.</p></dd>
                   3139: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3140: <dd><p>Contains highscore
                   3141: files.</p></dd>
                   3142: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3143: <dd><p>Contains log files.</p></dd>
                   3144: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3145: <dd><p>Contains informational files about daemons that are
                   3146: currently running.</p></dd>
                   3147: </dl></div>
                   3148: </div>
                   3149: </div>
1.23      wiz      3150: <div class="chapter" title="Chapter 9. Frequently Asked Questions">
1.1       dsieger  3151: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3152: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3153: <div class="toc">
                   3154: <p><b>Table of Contents</b></p>
                   3155: <dl>
1.6       rillig   3156: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3157: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3159: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3160: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3161: <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>
                   3162: <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      3163: <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   3164: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23      wiz      3165: <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
                   3166: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
                   3167: <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   3168: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3169: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3170: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23      wiz      3171: <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   3172: <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      3173: <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  3174: </dl>
                   3175: </div>
                   3176: <p>This section contains hints, tips &amp; tricks on special things in
                   3177: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3178: it contains items for both pkgsrc users and developers.</p>
1.23      wiz      3179: <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
1.1       dsieger  3180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3181: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3182: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.23      wiz      3183: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3184: <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  3185:          This is a general purpose list for most issues regarding
                   3186:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3187:          for pkgsrc configuration, unexpected build failures, using
                   3188:          particular packages, upgrading pkgsrc installations,
                   3189:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3190:          proposals for changes that impact the pkgsrc user community,
                   3191:          e.g. major infrastructure changes, new features, package
                   3192:          removals, etc., may also be posted.</p></li>
1.23      wiz      3193: <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  3194:          A list where the results of pkgsrc bulk builds are sent and
                   3195:          discussed.</p></li>
1.23      wiz      3196: <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  3197:          This list is for those who are interested in getting a
                   3198:          commit message for every change committed to pkgsrc. It is
                   3199:          also available in digest form, meaning one daily message
                   3200:          containing all commit messages for changes to the package
                   3201:          source tree in that 24 hour period.</p></li>
                   3202: </ul></div>
                   3203: <p>To subscribe, do:</p>
                   3204: <pre class="programlisting">
                   3205: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3206: </pre>
                   3207: <p>Archives for all these mailing lists are available from
1.10      hubertf  3208: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  3209: </div>
1.23      wiz      3210: <div class="sect1" title="9.2. Where's the pkgviews documentation?">
1.1       dsieger  3211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3212: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3213: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3214: pkgviews User's guide in
                   3215: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3216: </div>
1.23      wiz      3217: <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
1.1       dsieger  3218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3219: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3220: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3221: a number of useful utilities for both users and developers of pkgsrc.  This
                   3222: section attempts only to make the reader aware of the utilities and when
                   3223: they might be useful, and not to duplicate the documentation that comes
                   3224: with each package.</p>
                   3225: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.23      wiz      3226: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1       dsieger  3227:       Symlinks for use by buildlink.</p></li></ul></div>
                   3228: <p>OS tool augmentation (automatically installed when needed):</p>
1.23      wiz      3229: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3230: <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  3231:       Calculates various kinds of checksums (including SHA1).</p></li>
1.23      wiz      3232: <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  3233:       Compatibility library for pkgsrc tools.</p></li>
1.23      wiz      3234: <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  3235:       non-BSD systems due to lack of native mtree.</p></li>
1.23      wiz      3236: <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  3237:       Up-to-date replacement for
                   3238:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3239:       systems where pkg_install is not present.</p></li>
                   3240: </ul></div>
                   3241: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.23      wiz      3242: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3243: <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  3244:       Create a binary package from an
1.10      hubertf  3245:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  3246:       save the old package.</p></li>
1.23      wiz      3247: <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  3248:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3249:       from multiple locations. It currently supports the following
                   3250:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23      wiz      3251: <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  3252:       packages someplace else (enabled by default).</p></li>
1.23      wiz      3253: <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  3254:       the best compiler flags to optimise code for your current
1.23      wiz      3255:       CPU and compiler. </p></li>
1.1       dsieger  3256: </ul></div>
                   3257: <p>Utilities for keeping track of installed packages, being up to date,
                   3258: etc:</p>
1.23      wiz      3259: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3260: <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  3261:       packages whose installed versions do not match the latest pkgsrc
                   3262:       entries.</p></li>
1.23      wiz      3263: <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  3264:       dependency graphs of packages, to aid in choosing a strategy for
                   3265:       updating.</p></li>
1.23      wiz      3266: <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  3267:       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      3268: <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   3269:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23      wiz      3270: <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  3271:       does various checks on the complete pkgsrc system.</p></li>
1.23      wiz      3272: <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  3273:       packages you have installed.</p></li>
                   3274: </ul></div>
                   3275: <p>Utilities for people maintaining or creating individual packages:</p>
1.23      wiz      3276: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3277: <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  3278:       making and maintaining patches for a package (includes pkgdiff,
                   3279:       pkgvi, mkpatches, etc.).</p></li>
1.23      wiz      3280: <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  3281:       <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
                   3282:       converting to pkgsrc.</p></li>
1.23      wiz      3283: <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  3284:       pkgsrc to a Solaris package.</p></li>
                   3285: </ul></div>
                   3286: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3287: utilities)</p>
1.23      wiz      3288: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3289: <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  3290:       packages in a chrooted area.</p></li>
1.23      wiz      3291: <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  3292:       kernel version for chrooted cross builds.</p></li>
                   3293: </ul></div>
                   3294: </div>
1.23      wiz      3295: <div class="sect1" title="9.4. How to use pkgsrc as non-root">
1.1       dsieger  3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3297: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3298: <p>If you want to use pkgsrc as non-root user, you can set some
                   3299: variables to make pkgsrc work under these conditions.  At the very least,
1.23      wiz      3300: 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  3301: will turn on unprivileged mode and set multiple related variables to allow
                   3302: installation of packages as non-root.</p>
                   3303: <p>In case the defaults are not enough, you may want to tune some other
                   3304: variables used.  For example, if the automatic user/group detection leads
                   3305: to incorrect values (or not the ones you would like to use), you can change
                   3306: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3307: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3308: <p>As regards bootstrapping, please note that the
1.10      hubertf  3309: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23      wiz      3310: given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
1.1       dsieger  3311: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3312: installation targets.  These directories can be overridden by the
1.23      wiz      3313: <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
1.1       dsieger  3314: that allow finer tuning of the tree layout.</p>
                   3315: </div>
1.23      wiz      3316: <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
1.1       dsieger  3317: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3318: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3319: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3320: enable this feature by adding the option
                   3321: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  3322: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3323: distfile is found, pkgsrc will try to resume it.</p>
                   3324: <p>You can also
1.29      dholland 3325: 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  3326: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3327: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3328: by using the value manual.  A value of custom disables the system defaults
                   3329: and dependency tracking for the fetch program.  In that case you have to
                   3330: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3331: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3332: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  3333: <p>For example, if you want to use
1.16      jnemeth  3334: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  3335: like:</p>
                   3336: <pre class="programlisting">
1.16      jnemeth  3337: FETCH_USING=   wget
1.1       dsieger  3338: </pre>
                   3339: </div>
1.23      wiz      3340: <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
1.1       dsieger  3341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3342: <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   3343: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3344: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3345: you will have to add the following line into
1.10      hubertf  3346: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3347: <pre class="programlisting">
1.4       rillig   3348: X11_TYPE=modular
1.1       dsieger  3349: </pre>
1.23      wiz      3350: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  3351: <h3 class="title">Note</h3>
1.4       rillig   3352: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3353: </p>
1.1       dsieger  3354: </div>
                   3355: </div>
1.23      wiz      3356: <div class="sect1" title="9.7. How to fetch files from behind a firewall">
1.1       dsieger  3357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3358: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3359: <p>If you are sitting behind a firewall which does not allow direct
                   3360: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3361: relevant proxy hosts.  This is done using an environment variable in the
                   3362: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      3363: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  3364: port 80 as the proxy port number.  So the proxy environment variables
                   3365: are:</p>
                   3366: <pre class="programlisting">
                   3367: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3368: http_proxy=http://orpheus.amdahl.com:80/
                   3369: </pre>
                   3370: </div>
1.23      wiz      3371: <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
1.1       dsieger  3372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  3373: <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  3374: <p>This depends on which utility is used to retrieve distfiles.  From
                   3375: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3376: the first available command from the following list:</p>
1.23      wiz      3377: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   3378: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3379: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  3380: </ul></div>
                   3381: <p>On a default NetBSD installation, this will be
                   3382: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3383: connections first, and falls back to active connections if the server
                   3384: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  3385: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3386: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3387: <p>Having that option present will prevent
                   3388: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3389: transfers.</p>
                   3390: </div>
1.23      wiz      3391: <div class="sect1" title="9.9. How to fetch all distfiles at once">
1.1       dsieger  3392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3393: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3394: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  3395: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      3396: 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  3397: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  3398: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  3399: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3400: resulting list to your machine at work/school and use it there.  If you
1.29      dholland 3401: 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  3402: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3403: URL:</p>
                   3404: <p>At home:</p>
                   3405: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3406: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3407: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3408: <p>At work:</p>
                   3409: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3410: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3411: home.</p>
                   3412: <p>If you have a machine running NetBSD, and you want to get
                   3413: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3414: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  3415: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  3416: directly by running:</p>
                   3417: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3418: <p>If you even decide to ignore
                   3419: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3420: by running:</p>
                   3421: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3422: </div>
1.23      wiz      3423: <div class="sect1" title="9.10. What does &#8220;Don't know how to make /usr/share/tmac/tmac.andoc&#8221; mean?">
1.1       dsieger  3424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3425: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
                   3426: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  3427: <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>
                   3428: package, you get the error from make that it doesn't know how to make
                   3429: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      3430: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  3431: the NetBSD base distribution on your machine.  It is recommended to do
                   3432: that to format man pages.</p>
                   3433: <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
                   3434: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  3435: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3436: </div>
1.23      wiz      3437: <div class="sect1" title="9.11. What does &#8220;Could not find bsd.own.mk&#8221; mean?">
1.1       dsieger  3438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3439: <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  3440: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3441: when you installed your NetBSD machine.  Please get and install it, by
                   3442: extracting it in <code class="filename">/</code>:</p>
                   3443: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3444: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3445: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  3446: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  3447: -r</strong></span>).</p>
                   3448: </div>
1.23      wiz      3449: <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
1.1       dsieger  3450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3451: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3452: <p>When installing packages as non-root user and using the just-in-time
1.29      dholland 3453: <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  3454: password for each required package installed.  To avoid this, the sudo
                   3455: package can be used, which does password caching over a limited time.  To
                   3456: use it, install sudo (either as binary package or from
                   3457: <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  3458: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3459: <span class="emphasis"><em>after</em></span> the definition of the
                   3460: <code class="varname">LOCALBASE</code> variable:</p>
                   3461: <pre class="programlisting">
                   3462: .if exists(${LOCALBASE}/bin/sudo)
                   3463: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3464: .endif
                   3465: </pre>
                   3466: </div>
1.23      wiz      3467: <div class="sect1" title="9.13. How do I change the location of configuration files?">
1.1       dsieger  3468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3469: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3470: <p>As the system administrator, you can choose where configuration files
                   3471: are installed.  The default settings make all these files go into
                   3472: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3473: be suboptimal depending on your expectations (e.g., a read-only,
                   3474: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3475: configuration of the provided packages).</p>
                   3476: <p>In order to change the defaults, you can modify the
                   3477: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3478: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3479: directory; some common examples include <code class="filename">/etc</code> or
                   3480: <code class="filename">/etc/pkg</code>.</p>
                   3481: <p>Furthermore, you can change this value on a per-package basis by
                   3482: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3483: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3484: package you would like to modify, that is, the contents of
                   3485: <code class="varname">PKGBASE</code>.</p>
                   3486: <p>Note that after changing these settings, you must rebuild and
                   3487: reinstall any affected packages.</p>
                   3488: </div>
1.23      wiz      3489: <div class="sect1" title="9.14. Automated security checks">
1.1       dsieger  3490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3491: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3492: <p>Please be aware that there can often be bugs in third-party software,
                   3493: and some of these bugs can leave a machine vulnerable to exploitation by
                   3494: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3495: maintains a database of known-exploits to packages which have at one time
                   3496: been included in pkgsrc.  The database can be downloaded automatically, and
                   3497: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3498: do this, refer to the following two tools (installed as part of the
                   3499: <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      3500: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3501: <li class="listitem">
1.20      snj      3502: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3503:     download a list of the security vulnerabilities information.  This list
1.25      spz      3504:     is kept up to date by the pkgsrc security team, and is distributed
                   3505:     from the NetBSD ftp server:</p>
                   3506: <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  3507: </li>
1.23      wiz      3508: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3509:     current machine, checking each known vulnerability.  If a
1.1       dsieger  3510:     vulnerable package is installed, it will be shown by output to stdout,
                   3511:     including a description of the type of vulnerability, and a URL
                   3512:     containing more information.</p></li>
                   3513: </ol></div>
1.14      jmcneill 3514: <p>Use of these tools is strongly recommended!  After
1.23      wiz      3515: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.1       dsieger  3516: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14      jmcneill 3517: pkg_install</code></strong>.</p>
1.1       dsieger  3518: <p>If this package is installed, pkgsrc builds will use it to
1.10      hubertf  3519: 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  3520: check.</p>
                   3521: </div>
1.23      wiz      3522: <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
1.1       dsieger  3523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3524: <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  3525: <p>When you add your own preferences to the
                   3526:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3527:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3528:        environment variables to the <code class="filename">./configure</code>
1.29      dholland 3529:        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  3530:        <code class="varname">CFLAGS</code> from the environment variable by
                   3531:        overriding them in the <code class="filename">Makefile</code>s of their
                   3532:        package.</p>
                   3533: <p>Currently there is no solution to this problem. If you
                   3534:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3535:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3536:        directory and then inspect any <code class="filename">Makefile</code> and
                   3537:        <code class="filename">Makefile.in</code> for whether they define
                   3538:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3539:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  3540:        programmers write so bad code that it only works for the
                   3541:        specific combination of <code class="varname">CFLAGS</code> they have
                   3542:        chosen.</p>
                   3543: </div>
1.23      wiz      3544: <div class="sect1" title="9.16. A package does not build. What shall I do?">
1.1       dsieger  3545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3546: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3547: <div class="procedure"><ol class="procedure" type="1">
                   3548: <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  3549:        case that occurs often is that people only update pkgsrc in
                   3550:        parts, because of performance reasons. Since pkgsrc is one large
                   3551:        system, not a collection of many small systems, there are
                   3552:        sometimes changes that only work when the whole pkgsrc tree is
                   3553:        updated.</p></li>
1.23      wiz      3554: <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
                   3555:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3556:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  3557:        files.</p></li>
1.23      wiz      3558: <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3559:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3560:        verify this.</p></li>
1.23      wiz      3561: <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
1.1       dsieger  3562:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3563: </ol></div>
                   3564: </div>
1.23      wiz      3565: <div class="sect1" title="9.17. What does &#8220;Makefile appears to contain unresolved cvs/rcs/??? merge conflicts&#8221; mean?">
1.1       dsieger  3566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23      wiz      3567: <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  3568: <p>You have modified a file from pkgsrc, and someone else has
                   3569: modified that same file afterwards in the CVS repository. Both changes
                   3570: are in the same region of the file, so when you updated pkgsrc, the
                   3571: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3572: file. Because of these markers, the file is no longer a valid
                   3573: <code class="filename">Makefile</code>.</p>
                   3574: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3575: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3576: -dP</strong></span> in that directory to download the current version.</p>
                   3577: </div>
                   3578: </div>
                   3579: </div>
1.23      wiz      3580: <div class="part" title="Part II. The pkgsrc developer's guide">
1.1       dsieger  3581: <div class="titlepage"><div><div><h1 class="title">
                   3582: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.23      wiz      3583: <div class="partintro" title="The pkgsrc developer's guide">
1.1       dsieger  3584: <div></div>
                   3585: <p>This part of the book deals with creating and
1.23      wiz      3586:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3587:        guide on creating a new package. The remaining chapters are more
                   3588:        like a reference manual for pkgsrc.</p>
                   3589: <div class="toc">
                   3590: <p><b>Table of Contents</b></p>
                   3591: <dl>
1.6       rillig   3592: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3593: <dd><dl>
1.6       rillig   3594: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3595: <dd><dl>
1.6       rillig   3596: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3597: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3598: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3599: </dl></dd>
1.6       rillig   3600: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3601: <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>
                   3602: </dl></dd>
                   3603: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3604: <dd><dl>
1.23      wiz      3605: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3606: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   3607: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3608: <dd><dl>
                   3609: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3610: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3611: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3612: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3613: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3614: </dl></dd>
                   3615: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3616: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3617: <dd><dl>
                   3618: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3619: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3620: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3621: </dl></dd>
1.23      wiz      3622: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3623: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   3624: </dl></dd>
1.23      wiz      3625: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3626: <dd><dl>
                   3627: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      3628: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   3629: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3630: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3631: <dd><dl>
                   3632: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3633: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3634: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3635: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3636: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3637: </dl></dd>
                   3638: </dl></dd>
                   3639: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3640: <dd><dl>
                   3641: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      3642: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3643: <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   3644: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3645: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      3646: <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   3647: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3648: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3649: </dl></dd>
                   3650: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3651: <dd><dl>
                   3652: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      3653: <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   3654: <dd><dl>
                   3655: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      3656: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3657:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3658:       and
                   3659:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3660:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   3661: </dl></dd>
1.23      wiz      3662: <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   3663: <dd><dl>
1.23      wiz      3664: <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   3665: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3666: </dl></dd>
                   3667: </dl></dd>
                   3668: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3669: <dd><dl>
                   3670: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3671: <dd><dl>
                   3672: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3673: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3674: </dl></dd>
                   3675: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3676: <dd><dl>
1.23      wiz      3677: <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   3678: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3679: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3680: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3681: </dl></dd>
                   3682: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3683: <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>
                   3684: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3685: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3686: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3687: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3688: <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>
                   3689: </dl></dd>
                   3690: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3691: <dd><dl>
                   3692: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      3693: <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   3694: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3695: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3696: </dl></dd>
                   3697: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3698: <dd><dl>
                   3699: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3700: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3701: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3702: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      3703: <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   3704: <dd><dl>
                   3705: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3706: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3707: </dl></dd>
1.23      wiz      3708: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3709: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3710: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3711: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3712: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3713: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3714: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3715: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3716: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3717: <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   3718: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3719: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3720: </dl></dd>
                   3721: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3722: <dd><dl>
                   3723: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3724: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3725: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3726: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3727: </dl></dd>
                   3728: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3729: <dd><dl>
                   3730: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3731: <dd><dl>
                   3732: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      3733: <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   3734: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3735: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3736: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3737: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3738: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3739: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3740: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3741: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3742: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3743: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3744: </dl></dd>
1.23      wiz      3745: <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   3746: <dd><dl>
                   3747: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3748: <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>
                   3749: </dl></dd>
1.23      wiz      3750: <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   3751: <dd><dl>
                   3752: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3753: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3754: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3755: </dl></dd>
                   3756: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3757: <dd><dl>
                   3758: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3759: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3760: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3761: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3762: </dl></dd>
1.23      wiz      3763: <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   3764: <dd><dl>
                   3765: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      3767: <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   3768: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3769: </dl></dd>
1.23      wiz      3770: <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   3771: <dd><dl>
                   3772: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3773: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3774: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3775: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3776: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3777: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3778: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3779: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3780: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      3781: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   3782: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3783: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3784: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3785: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3786: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3787: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3788: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3789: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3790:     emulation</a></span></dt>
1.6       rillig   3791: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3792: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3793: </dl></dd>
1.6       rillig   3794: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3795: </dl></dd>
1.6       rillig   3796: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3797: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3798: <dd><dl>
1.6       rillig   3799: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3800: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3801: <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      3802: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   3803: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      3804: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3805: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6       rillig   3806: </dl></dd>
                   3807: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3808: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3809: <dd><dl>
                   3810: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3811: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3812: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3813: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3814: </dl></dd>
                   3815: </dl>
                   3816: </div>
                   3817: </div>
1.23      wiz      3818: <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
1.1       dsieger  3819: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3820: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3821: <div class="toc">
                   3822: <p><b>Table of Contents</b></p>
                   3823: <dl>
1.6       rillig   3824: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3825: <dd><dl>
1.6       rillig   3826: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3827: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17      imil     3828: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3829: </dl></dd>
1.6       rillig   3830: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3831: <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  3832: </dl>
                   3833: </div>
                   3834: <p>When you find a package that is not yet in pkgsrc, you
                   3835: most likely have a URL from where you can download the source
                   3836: code. Starting with this URL, creating a package involves only a
                   3837: few steps.</p>
1.23      wiz      3838: <div class="procedure"><ol class="procedure" type="1">
                   3839: <li class="step" title="Step 1"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
                   3840: <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3841: category in which you want to place your package. You can also create a
                   3842: directory of your own (maybe called <code class="filename">local</code>). In that
                   3843: category directory, create another directory for your package and change
                   3844: into it.</p></li>
1.23      wiz      3845: <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3846: you for a URL. Enter the URL of the distribution file (in most cases a
                   3847: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3848: of your package are created automatically. The distribution file is
                   3849: extracted automatically to fill in some details in the
                   3850: <code class="filename">Makefile</code> that would otherwise have to be done
                   3851: manually.</p></li>
1.23      wiz      3852: <li class="step" title="Step 4">
1.1       dsieger  3853: <p>Examine the extracted files to determine the dependencies of
                   3854: your package. Ideally, this is mentioned in some
                   3855: <code class="filename">README</code> file, but things may differ. For each of
                   3856: these dependencies, look where it exists in pkgsrc, and if there is a
                   3857: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3858: line to your package <code class="filename">Makefile</code> which includes that
                   3859: file just before the last line. If the
1.25      spz      3860: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3861: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3862: <p>If you just need binaries from a package, add a
1.1       dsieger  3863: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3864: version of the dependency and where it can be found in pkgsrc. This line
                   3865: should be placed in the third paragraph. If the dependency is only
                   3866: needed for building the package, but not when using it, use
                   3867: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3868: Your package may then look like this:</p>
                   3869: <pre class="programlisting">
                   3870: [...]
                   3871: 
                   3872: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3873: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3874: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3875: 
                   3876: [...]
                   3877: 
                   3878: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3879: .include "../../devel/glib2/buildlink3.mk"
                   3880: .include "../../mk/bsd.pkg.mk"
                   3881: </pre>
                   3882: </li>
1.23      wiz      3883: <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   3884: 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  3885: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3886: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3887: -e</strong></span>, which outputs additional
                   3888: explanations.</p></li>
1.23      wiz      3889: <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3890: 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  3891: over there, you can hopefully continue here.</p></li>
1.23      wiz      3892: <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3893: directory from the extracted files. Besides these files, a lot of cache
                   3894: files and other system information has been saved in the working
                   3895: directory, which may become wrong after you edited the
                   3896: <code class="filename">Makefile</code>.</p></li>
1.23      wiz      3897: <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10      hubertf  3898: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.23      wiz      3899: <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
1.10      hubertf  3900: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3901: everything works.</p></li>
1.23      wiz      3902: <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3903: contains a list of the files that are installed by the package, is
1.10      hubertf  3904: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3905: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3906: the file using your preferred text editor to see if the list of
                   3907: files looks plausible.</p></li>
1.23      wiz      3908: <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3909: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.23      wiz      3910: <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3911: has been registered in the database of installed files, but with an
1.10      hubertf  3912: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3913: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3914: registered with the list of files from
                   3915: <code class="filename">PLIST</code>.</p></li>
1.23      wiz      3916: <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3917: package from the set of installed files.</p></li>
                   3918: </ol></div>
1.23      wiz      3919: <div class="sect1" title="10.1. Common types of packages">
1.1       dsieger  3920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3921: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.23      wiz      3922: <div class="sect2" title="10.1.1. Perl modules">
1.1       dsieger  3923: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3924: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3925: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3926: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3927: </div>
1.23      wiz      3928: <div class="sect2" title="10.1.2. KDE applications">
1.1       dsieger  3929: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3930: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  3931: <p>KDE applications should always include
                   3932: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   3933: settings that are typical of KDE packages.</p>
                   3934: </div>
1.23      wiz      3935: <div class="sect2" title="10.1.3. Python modules and programs">
1.17      imil     3936: <div class="titlepage"><div><div><h3 class="title">
                   3937: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3938: <p>Python modules and programs packages are easily created using a
                   3939: set of predefined variables.</p>
1.23      wiz      3940: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3941: easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3942: If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
                   3943: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
1.17      imil     3944: pkgsrc will make use of this framework.
1.23      wiz      3945: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3946: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
1.17      imil     3947: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3948: to the name of the script.</p>
                   3949: <p>
                   3950: If the default Python versions are not supported by the software, set the
                   3951: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   3952: the software is known to work with, from the most recent to the older
                   3953: one, e.g.
                   3954: </p>
                   3955: <pre class="programlisting">
1.22      jakllsch 3956: PYTHON_VERSIONS_ACCEPTED=       25 24
1.17      imil     3957: </pre>
                   3958: <p>
                   3959: If the packaged software is a Python module, include
1.23      wiz      3960: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
1.17      imil     3961: In this case, the package directory should be called
1.23      wiz      3962: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3963: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3964: </p>
                   3965: <pre class="programlisting">
                   3966: DISTNAME=   foopymodule-1.2.10
                   3967: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3968: </pre>
                   3969: <p>If it is an application, also include
1.23      wiz      3970: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
                   3971: before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
1.17      imil     3972: <p>If the packaged software, either it is an application or a module, is
                   3973: egg-aware, you only need to include
1.23      wiz      3974: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
1.17      imil     3975: <p>In order to correctly set the path to the Python interpreter, use the
                   3976: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   3977: that must be corrected. For example :
                   3978: </p>
                   3979: <pre class="programlisting">
                   3980: REPLACE_PYTHON=   ${WRKSRC}/*.py
                   3981: </pre>
                   3982: </div>
1.1       dsieger  3983: </div>
1.23      wiz      3984: <div class="sect1" title="10.2. Examples">
1.1       dsieger  3985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3986: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.23      wiz      3987: <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
1.1       dsieger  3988: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3989: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.23      wiz      3990: <div class="sect3" title="10.2.1.1. The initial package">
1.1       dsieger  3991: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3992: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3993: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      3994: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  3995: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      3996: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  3997: <pre class="programlisting">
                   3998: <code class="prompt">$</code> mkdir www/nvu
                   3999: <code class="prompt">$</code> cd www/nvu
                   4000: </pre>
                   4001: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  4002: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  4003: <pre class="programlisting">
                   4004: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4005: </pre>
                   4006: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4007: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      4008: 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  4009: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4010: <code class="varname">COMMENT</code> fields. Then the package
                   4011: <code class="filename">Makefile</code> looked like that:</p>
                   4012: <pre class="programlisting">
                   4013: # $NetBSD$
                   4014: #
                   4015: 
                   4016: DISTNAME=       nvu-1.0-sources
                   4017: PKGNAME=        nvu-1.0
                   4018: CATEGORIES=     www
                   4019: MASTER_SITES=   http://cvs.nvu.com/download/
                   4020: EXTRACT_SUFX=   .tar.bz2
                   4021: 
                   4022: MAINTAINER=     rillig@NetBSD.org
                   4023: HOMEPAGE=       http://cvs.nvu.com/
                   4024: COMMENT=        Web Authoring System
                   4025: 
                   4026: # url2pkg-marker (please do not remove this line.)
                   4027: .include "../../mk/bsd.pkg.mk"
                   4028: </pre>
                   4029: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4030: source archive:</p>
                   4031: <pre class="programlisting">
                   4032: url2pkg&gt; Running "make makesum" ...
                   4033: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4034: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4035: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4036: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4037: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4038: url2pkg&gt; Running "make extract" ...
                   4039: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4040: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4041: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4042: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4043: ===&gt; Installing dependencies for nvu-1.0
                   4044: ===&gt; Overriding tools for nvu-1.0
                   4045: ===&gt; Extracting for nvu-1.0
                   4046: url2pkg&gt; Adjusting the Makefile.
                   4047: 
                   4048: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4049: 
                   4050: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4051: </pre>
                   4052: </div>
1.23      wiz      4053: <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
1.1       dsieger  4054: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4055: <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  4056: <p>Now that the package has been extracted, let's see what's inside
                   4057: it. The package has a <code class="filename">README.txt</code>, but that only
                   4058: says something about mozilla, so it's probably useless for seeing what
                   4059: dependencies this package has. But since there is a GNU configure script
                   4060: in the package, let's hope that it will complain about everything it
                   4061: needs.</p>
                   4062: <pre class="programlisting">
                   4063: <code class="prompt">$</code> bmake
                   4064: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4065: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4066: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4067: ===&gt; Patching for nvu-1.0
                   4068: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4069: ===&gt; Configuring for nvu-1.0
                   4070: [...]
                   4071: configure: error: Perl 5.004 or higher is required.
                   4072: [...]
                   4073: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4074: [...]
                   4075: </pre>
                   4076: <p>That worked quite well. So I opened the package Makefile in my
                   4077: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      4078: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  4079: package have changed now, and since a perl wrapper is automatically
1.23      wiz      4080: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  4081: from scratch.</p>
                   4082: <pre class="programlisting">
                   4083: <code class="prompt">$</code> bmake clean
                   4084: ===&gt; Cleaning for nvu-1.0
                   4085: <code class="prompt">$</code> bmake
                   4086: [...]
                   4087: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4088: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4089: [...]
                   4090: </pre>
1.23      wiz      4091: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  4092: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4093: <pre class="programlisting">
                   4094: [...]
                   4095: checking for GTK - version &gt;= 1.2.0... no
                   4096: *** Could not run GTK test program, checking why...
                   4097: [...]
                   4098: </pre>
                   4099: <p>Now to the other dependencies. The first question is: Where is the
                   4100: GTK package hidden in pkgsrc?</p>
                   4101: <pre class="programlisting">
                   4102: <code class="prompt">$</code> echo ../../*/gtk*
                   4103: [many packages ...]
                   4104: <code class="prompt">$</code> echo ../../*/gtk
                   4105: ../../x11/gtk
                   4106: <code class="prompt">$</code> echo ../../*/gtk2
                   4107: ../../x11/gtk2
                   4108: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4109: ../../x11/gtk2/buildlink3.mk
                   4110: </pre>
                   4111: <p>The first try was definitely too broad. The second one had exactly
                   4112: one result, which is very good. But there is one pitfall with GNOME
                   4113: packages. Before GNOME 2 had been released, there were already many
                   4114: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4115: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      4116: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  4117: whether this was the case here, and indeed it was.</p>
                   4118: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4119: file, adding the dependency is very easy. I just inserted an
                   4120: <code class="literal">.include</code> line before the last line of the package
                   4121: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4122: <pre class="programlisting">
                   4123: [...]
                   4124: .include "../../x11/gtk2/buildlink3.mk"
                   4125: .include "../../mk/bsd.pkg.mk
                   4126: </pre>
1.10      hubertf  4127: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  4128: was:</p>
                   4129: <pre class="programlisting">
                   4130: [...]
                   4131: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4132: checking for GTK - version &gt;= 1.2.0... no
                   4133: *** Could not run GTK test program, checking why...
                   4134: *** The test program failed to compile or link. See the file config.log for the
                   4135: *** exact error that occured. This usually means GTK was incorrectly installed
                   4136: *** or that you have moved GTK since it was installed. In the latter case, you
                   4137: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4138: configure: error: Test for GTK failed.
                   4139: [...]
                   4140: </pre>
1.23      wiz      4141: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   4142: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  4143: told me that this package really wanted to have the GNOME 1 version of
                   4144: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  4145: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  4146: So I changed the <code class="literal">x11/gtk2</code> to
                   4147: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4148: and tried again.</p>
                   4149: <pre class="programlisting">
                   4150: [...]
                   4151: 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
                   4152: In file included from xpidl.c:42:
                   4153: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4154: In file included from xpidl.c:42:
                   4155: xpidl.h:132: error: parse error before "IDL_ns"
                   4156: [...]
                   4157: </pre>
                   4158: <p>The package still does not find all of its dependencies. Now the
                   4159: question is: Which package provides the
                   4160: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4161: <pre class="programlisting">
                   4162: <code class="prompt">$</code> echo ../../*/*idl*
                   4163: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4164: <code class="prompt">$</code> echo ../../*/*IDL*
                   4165: ../../net/libIDL
                   4166: </pre>
                   4167: <p>Let's take the one from the second try. So I included the
                   4168: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4169: again. But the error didn't change. After digging through some of the
                   4170: code, I concluded that the build process of the package was broken and
                   4171: couldn't have ever worked, but since the Mozilla source tree is quite
                   4172: large, I didn't want to fix it. So I added the following to the package
                   4173: <code class="filename">Makefile</code> and tried again:</p>
                   4174: <pre class="programlisting">
                   4175: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4176: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4177: </pre>
                   4178: <p>The latter line is needed because the package expects the library
                   4179: <code class="filename">libIDL.so</code>, but only
                   4180: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4181: wrapper to rewrite that on the fly.</p>
                   4182: <p>The next problem was related to a recent change of the FreeType
                   4183: 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>
                   4184: which patch files were relevant for this issue and copied them to the
                   4185: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4186: patches so that they applied cleanly and retried again. This time,
                   4187: everything worked.</p>
                   4188: </div>
1.23      wiz      4189: <div class="sect3" title="10.2.1.3. Installing the package">
1.1       dsieger  4190: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4191: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4192: <pre class="programlisting">
                   4193: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4194: [...]
                   4195: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4196: <code class="prompt">$</code> bmake deinstall
                   4197: <code class="prompt">$</code> bmake install
                   4198: </pre>
                   4199: </div>
                   4200: </div>
                   4201: </div>
                   4202: </div>
1.23      wiz      4203: <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
1.1       dsieger  4204: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4205: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4206: <div class="toc">
                   4207: <p><b>Table of Contents</b></p>
                   4208: <dl>
1.23      wiz      4209: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   4210: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6       rillig   4211: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4212: <dd><dl>
                   4213: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4214: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4215: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4216: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4217: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4218: </dl></dd>
                   4219: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4220: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4221: <dd><dl>
                   4222: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4223: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4224: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4225: </dl></dd>
1.23      wiz      4226: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   4227: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  4228: </dl>
                   4229: </div>
                   4230: <p>Whenever you're preparing a package, there are a number of
                   4231: files involved which are described in the following
                   4232: sections.</p>
1.23      wiz      4233: <div class="sect1" title="11.1. Makefile">
1.1       dsieger  4234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4235: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4236: </h2></div></div></div>
                   4237: <p>Building, installation and creation of a binary package are all
                   4238:   controlled by the package's <code class="filename">Makefile</code>.
                   4239:   The <code class="filename">Makefile</code> describes various things about
                   4240:   a package, for example from where to get it, how to configure,
                   4241:   build, and install it.</p>
                   4242: <p>A package <code class="filename">Makefile</code> contains several
                   4243:   sections that describe the package.</p>
                   4244: <p>In the first section there are the following variables, which
                   4245:   should appear exactly in the order given here.  The order and
                   4246:   grouping of the variables is mostly historical and has no further
                   4247:   meaning.</p>
1.23      wiz      4248: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4249: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  4250:     distribution file to be downloaded from the package's
                   4251:     website.</p></li>
1.23      wiz      4252: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1       dsieger  4253:     package, as used by pkgsrc. You only need to provide it if
                   4254:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4255:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4256:     directory name together with the version number. It must match the
                   4257:     regular expression
                   4258:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4259:     starts with a letter or digit, and contains only letters, digits,
                   4260:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      4261: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1       dsieger  4262:     the package file to create if the <code class="varname">PKGNAME</code>
                   4263:     isn't unique on a SVR4 system. The default is
                   4264:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4265:     <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
                   4266:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4267:     does not produce an unique package name on a SVR4 system.
                   4268:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4269:     characters.</p></li>
1.23      wiz      4270: <li class="listitem">
1.1       dsieger  4271: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4272:     which the package fits in. You can choose any of the top-level
                   4273:     directories of pkgsrc for it.</p>
                   4274: <p>Currently the following values are available for
                   4275:     <code class="varname">CATEGORIES</code>. If more than
                   4276:     one is used, they need to be separated by spaces:</p>
                   4277: <pre class="programlisting">
                   4278: archivers     cross         geography     meta-pkgs     security
                   4279: audio         databases     graphics      misc          shells
                   4280: benchmarks    devel         ham           multimedia    sysutils
                   4281: biology       editors       inputmethod   net           textproc
                   4282: cad           emulators     lang          news          time
                   4283: chat          finance       mail          parallel      wm
                   4284: comms         fonts         math          pkgtools      www
                   4285: converters    games         mbone         print         x11
                   4286: </pre>
                   4287: </li>
1.23      wiz      4288: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  4289:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4290:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4291:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.23      wiz      4292:     <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  4293: </ul></div>
                   4294: <p>The second section contains information about separately
                   4295:   downloaded patches, if any.
                   4296:   </p>
1.23      wiz      4297: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4298: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1       dsieger  4299:     Name(s) of additional files that contain distribution patches.
                   4300:     There is no default. pkgsrc will look for them at
                   4301:     <code class="varname">PATCH_SITES</code>.
                   4302:     They will automatically be uncompressed before patching if
                   4303:     the names end with <code class="filename">.gz</code> or
                   4304:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      4305: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  4306:     Primary location(s) for distribution patch files (see
                   4307:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4308: </ul></div>
                   4309: <p>The third section contains the following variables.
                   4310:   </p>
1.23      wiz      4311: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4312: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 4313:     address of the person who feels responsible for this package,
                   4314:     and who is most likely to look at problems or questions regarding
1.29      dholland 4315:     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 4316:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4317:     before making changes to the package, but are not required to
                   4318:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4319:     to yourself. If you really can't maintain the package for future
                   4320:     updates, set it to
1.10      hubertf  4321:     <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      4322: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 4323:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4324:     developers to update or change the package without contacting
                   4325:     you first. A package Makefile should contain one of
                   4326:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4327:     not both.  </p></li>
1.23      wiz      4328: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  4329:     find more information about the package.</p></li>
1.23      wiz      4330: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  4331:     description of the package (should not include the package
                   4332:     name).</p></li>
                   4333: </ul></div>
                   4334: <p>Other variables that affect the build:
                   4335:   </p>
1.23      wiz      4336: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4337: <p><code class="varname">WRKSRC</code>: The directory where the
                   4338:       interesting distribution files of the package are found. The
                   4339:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4340:       works for most packages.</p>
                   4341: <p>If a package doesn't create a subdirectory for itself
                   4342:       (most GNU software does, for instance), but extracts itself in
                   4343:       the current directory, you should set
                   4344:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4345: <p>If a package doesn't create a subdirectory with the
                   4346:       name of <code class="varname">DISTNAME</code> but some different name,
                   4347:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4348:       <code class="filename">${WRKDIR}</code>, for example
                   4349:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4350:       <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>
                   4351: <p>The name of the working directory created by pkgsrc is
                   4352:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4353:       variable. By default, its value is
                   4354:       <code class="filename">work</code>. If you want to use the same
                   4355:       pkgsrc tree for building different kinds of binary packages,
                   4356:       you can change the variable according to your needs. Two
                   4357:       other variables handle common cases of setting
                   4358:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4359:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  4360:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4361:       the host's name is attached to the directory name. If
                   4362:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4363:       is attached, which might look like
                   4364:       <code class="filename">work.i386</code> or
                   4365:       <code class="filename">work.sparc</code>.</p>
                   4366: </li></ul></div>
                   4367: <p>Please pay attention to the following gotchas:</p>
1.23      wiz      4368: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4369: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  4370:       installed in compressed form by the package.  For packages using
                   4371:       BSD-style makefiles which honor MANZ, there is
                   4372:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      4373: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4374:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  4375:       below).</p></li>
1.23      wiz      4376: <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  4377: </ul></div>
                   4378: </div>
1.23      wiz      4379: <div class="sect1" title="11.2. distinfo">
1.1       dsieger  4380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4381: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4382: </h2></div></div></div>
                   4383: <p>The <code class="filename">distinfo</code> file contains the message
                   4384:   digest, or checksum, of each distfile needed for the package. This
                   4385:   ensures that the distfiles retrieved from the Internet have not been
                   4386:   corrupted during transfer or altered by a malign force to introduce
                   4387:   a security hole. Due to recent rumor about weaknesses of digest
                   4388:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4389:   message digests, as well as the file size.</p>
                   4390: <p>The <code class="filename">distinfo</code> file also contains the
                   4391:   checksums for all the patches found in the
1.10      hubertf  4392:   <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  4393: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10      hubertf  4394:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1       dsieger  4395:   command.</p>
                   4396: <p>Some packages have different sets of distfiles depending on
1.23      wiz      4397:   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  4398:   <code class="filename">distinfo</code> file and care should be taken when
                   4399:   upgrading such a package to ensure distfile information is not
                   4400:   lost.</p>
                   4401: </div>
1.23      wiz      4402: <div class="sect1" title="11.3. patches/*">
1.1       dsieger  4403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4404: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4405: <p>Many packages still don't work out-of-the box on the various
                   4406:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4407:   patch files are needed to make the package work. These patch files are
                   4408:   found in the <code class="filename">patches/</code> directory.</p>
                   4409: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4410:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.10      hubertf  4411:   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      4412:   order</a>.</p>
1.23      wiz      4413: <div class="sect2" title="11.3.1. Structure of a single patch file">
1.1       dsieger  4414: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4415: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4416: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  4417:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  4418:   problems. (To force patches to apply with fuzz you can set
                   4419:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4420:   should contain only changes for a single file, and no file should be
                   4421:   patched by more than one patch file. This helps to keep future
                   4422:   modifications simple.</p>
                   4423: <p>Each patch file is structured as follows: In the first line,
                   4424:   there is the RCS Id of the patch itself. The second line should be
                   4425:   empty for aesthetic reasons. After that, there should be a comment for
                   4426:   each change that the patch does. There are a number of standard
                   4427:   cases:</p>
1.23      wiz      4428: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4429: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  4430:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      4431: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  4432:   platform and other environment (for example, the compiler) that the
                   4433:   patch is needed for.</p></li>
                   4434: </ul></div>
1.24      wiz      4435: <p>In all, the patch should be commented so that any
1.1       dsieger  4436:   developer who knows the code of the application can make some use of
                   4437:   the patch. Special care should be taken for the upstream developers,
                   4438:   since we generally want that they accept our patches, so we have less
                   4439:   work in the future.</p>
                   4440: </div>
1.23      wiz      4441: <div class="sect2" title="11.3.2. Creating patch files">
1.1       dsieger  4442: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4443: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4444: <p>One important thing to mention is to pay attention that no RCS
                   4445:   IDs get stored in the patch files, as these will cause problems when
                   4446:   later checked into the NetBSD CVS tree. Use the
1.10      hubertf  4447:   <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  4448:   problems.</p>
                   4449: <p>For even more automation, we recommend using
1.10      hubertf  4450:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  4451:   whole set of patches. You just have to backup files before you
                   4452:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  4453:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4454:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  4455:   you upgrade a package this way, you can easily compare the new
                   4456:   set of patches with the previously existing one with
1.24      wiz      4457:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4458:   are replaced by new files, so carefully check if you want to take all
                   4459:   the changes.</p>
1.1       dsieger  4460: <p>When you have finished a package, remember to generate
1.10      hubertf  4461:   the checksums for the patch files by using the <span class="command"><strong>make
1.23      wiz      4462:   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  4463: <p>When adding a patch that corrects a problem in the
                   4464:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4465:   man pages should go), send the patch as a bug report to the
                   4466:   maintainer.  This benefits non-pkgsrc users of the package,
                   4467:   and usually makes it possible to remove the patch in future
                   4468:   version.</p>
1.2       rillig   4469: <p>The file names of the patch files are usually of the form
1.24      wiz      4470:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4471:   Many packages still use the previous convention
                   4472:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4473:   but new patches should be of the form containing the filename.
                   4474:   <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
                   4475:   automatically.</p>
1.1       dsieger  4476: </div>
1.23      wiz      4477: <div class="sect2" title="11.3.3. Sources where the patch files come from">
1.1       dsieger  4478: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4479: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4480: <p>If you want to share patches between multiple packages
                   4481:   in pkgsrc, e.g. because they use the same distfiles, set
                   4482:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4483:   can be found, e.g.:</p>
                   4484: <pre class="programlisting">
                   4485: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4486: </pre>
                   4487: <p>Patch files that are distributed by the author or other
                   4488:     maintainers can be listed in
                   4489:     <code class="varname">PATCHFILES</code>.</p>
                   4490: <p>If it is desired to store any patches that should not be
                   4491:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4492:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4493:     directory tree there is expected to have the same
1.23      wiz      4494:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  4495:     patches are expected to be stored inside these dirs (also
                   4496:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4497:     example, if you want to keep a private patch for
                   4498:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4499:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4500:     files in the named directory are expected to be patch files,
                   4501:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4502:     applied</em></span>.</p>
                   4503: </div>
1.23      wiz      4504: <div class="sect2" title="11.3.4. Patching guidelines">
1.1       dsieger  4505: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4506: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4507: <p>When fixing a portability issue in the code do not use
                   4508:       preprocessor magic to check for the current operating system nor
                   4509:       platform.  Doing so hurts portability to other platforms because
                   4510:       the OS-specific details are not abstracted appropriately.</p>
                   4511: <p>The general rule to follow is: instead of checking for the
                   4512:       operating system the application is being built on, check for the
                   4513:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4514:       instead of assuming that kqueue is available under NetBSD and
                   4515:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 4516:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4517:       yes, this generally involves patching the
1.10      hubertf  4518:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  4519:       that prevents some OSes from adopting interfaces from other OSes
                   4520:       (e.g. Linux implementing kqueue), something that the above checks
                   4521:       cannot take into account.</p>
                   4522: <p>Of course, checking for features generally involves more
                   4523:       work on the developer's side, but the resulting changes are
                   4524:       cleaner and there are chances they will work on many other
                   4525:       platforms.  Not to mention that there are higher chances of being
                   4526:       later integrated into the mainstream sources.  Remember:
                   4527:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4528: <p>Some typical examples:</p>
                   4529: <div class="table">
1.6       rillig   4530: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4531: <div class="table-contents"><table summary="Patching examples" border="1">
                   4532: <colgroup>
                   4533: <col>
                   4534: <col>
                   4535: <col>
                   4536: </colgroup>
                   4537: <thead><tr>
                   4538: <th>Where</th>
                   4539: <th>Incorrect</th>
                   4540: <th>Correct</th>
                   4541: </tr></thead>
                   4542: <tbody>
                   4543: <tr>
                   4544: <td>configure script</td>
                   4545: <td>
                   4546: <pre class="programlisting">
                   4547: case ${target_os} in
                   4548: netbsd*) have_kvm=yes ;;
                   4549: *)       have_kvm=no  ;;
                   4550: esac
                   4551: </pre>
                   4552:              </td>
                   4553: <td>
                   4554: <pre class="programlisting">
                   4555: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4556: </pre>
                   4557:              </td>
                   4558: </tr>
                   4559: <tr>
                   4560: <td>C source file</td>
                   4561: <td>
                   4562: <pre class="programlisting">
                   4563: #if defined(__NetBSD__)
                   4564: #  include &lt;sys/event.h&gt;
                   4565: #endif
                   4566: </pre>
                   4567:              </td>
                   4568: <td>
                   4569: <pre class="programlisting">
                   4570: #if defined(HAVE_SYS_EVENT_H)
                   4571: #  include &lt;sys/event.h&gt;
                   4572: #endif
                   4573: </pre>
                   4574:              </td>
                   4575: </tr>
                   4576: <tr>
                   4577: <td>C source file</td>
                   4578: <td>
                   4579: <pre class="programlisting">
                   4580: int
                   4581: monitor_file(...)
                   4582: {
                   4583: #if defined(__NetBSD__)
                   4584:         int fd = kqueue();
                   4585:         ...
                   4586: #else
                   4587:         ...
                   4588: #endif
                   4589: }
                   4590: </pre>
                   4591:              </td>
                   4592: <td>
                   4593: <pre class="programlisting">
                   4594: int
                   4595: monitor_file(...)
                   4596: {
                   4597: #if defined(HAVE_KQUEUE)
                   4598:         int fd = kqueue();
                   4599:         ...
                   4600: #else
                   4601:        ...
                   4602: #endif
                   4603: }
                   4604: </pre>
                   4605:              </td>
                   4606: </tr>
                   4607: </tbody>
                   4608: </table></div>
                   4609: </div>
                   4610: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  4611:       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
                   4612:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  4613:       2</a>).  It summarizes multiple details on how to make
                   4614:       software easier to package; all the suggestions in it were
                   4615:       collected from our experience in pkgsrc work, so they are possibly
                   4616:       helpful when creating patches too.</p>
                   4617: </div>
1.23      wiz      4618: <div class="sect2" title="11.3.5. Feedback to the author">
1.1       dsieger  4619: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4620: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4621: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4622:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4623:       improvements you do to a package to the mainstream developers.
                   4624:       This is the only way to get their attention on portability issues
                   4625:       and to ensure that future versions can be built out-of-the box on
                   4626:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4627:       the fixes straight from the packaged code.</p>
                   4628: <p>This generally involves cleaning up the patches
                   4629:       (because sometimes the patches that are
                   4630:       added to pkgsrc are quick hacks), filling bug reports in the
                   4631:       appropriate trackers for the projects and working with the
                   4632:       mainstream authors to accept your changes.  It is
                   4633:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4634:       the packages in pkgsrc are kept simple and thus further changes
                   4635:       can be done without much hassle.</p>
1.24      wiz      4636: <p>When you have done this, please add a URL to the upstream
                   4637:       bug report to the patch comment.</p>
1.1       dsieger  4638: <p>Support the idea of free software!</p>
                   4639: </div>
                   4640: </div>
1.23      wiz      4641: <div class="sect1" title="11.4. Other mandatory files">
1.1       dsieger  4642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4643: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1       dsieger  4644: <div class="variablelist"><dl>
                   4645: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4646: <dd><p>A multi-line description of the piece of software.  This should include
                   4647:          any credits where they are due.  Please bear in mind that others do not
                   4648:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4649:          will read everything that you write here.</p></dd>
                   4650: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4651: <dd><p>This file governs the files that are installed on your
                   4652:          system: all the binaries, manual pages, etc. There are other
                   4653:          directives which may be entered in this file, to control the
                   4654:          creation and deletion of directories, and the location of
1.10      hubertf  4655:          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  4656:          information.</p></dd>
                   4657: </dl></div>
                   4658: </div>
1.23      wiz      4659: <div class="sect1" title="11.5. Optional files">
1.1       dsieger  4660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4661: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.23      wiz      4662: <div class="sect2" title="11.5.1. Files affecting the binary package">
1.1       dsieger  4663: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4664: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1       dsieger  4665: <div class="variablelist"><dl>
                   4666: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      4667: <dd>
1.29      dholland 4668: <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  4669:            First time after package extraction and before files are
                   4670:            moved in place, the second time after the files to install
                   4671:            are moved in place. This can be used to do any custom
                   4672:            procedures not possible with @exec commands in
1.29      dholland 4673:            <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
                   4674:            <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      4675:            Please note that you can modify variables in it easily by using
                   4676:            <code class="varname">FILES_SUBST</code> in the package's
                   4677:            <code class="filename">Makefile</code>:</p>
                   4678: <pre class="programlisting">
                   4679: FILES_SUBST+=  SOMEVAR="somevalue"
                   4680: </pre>
                   4681: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4682:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4683:            performed for <code class="varname">PREFIX</code>,
                   4684:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4685:            <code class="varname">VARBASE</code>, and a few others, type
                   4686:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4687:            complete list.</p>
                   4688: </dd>
1.1       dsieger  4689: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4690: <dd><p>This script is executed before and after any files are removed.  It is
                   4691:            this script's responsibility to clean up any additional messy details
                   4692:            around the package's installation, since all pkg_delete knows is how to
                   4693:            delete the files created in the original distribution.
1.29      dholland 4694:            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>
                   4695:            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      4696:            The same methods to replace variables can be used as for
                   4697:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4698: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4699: <dd>
                   4700: <p>This file is displayed after installation of the package.
                   4701:            Useful for things like legal notices on almost-free
                   4702:            software and hints for updating config files after
                   4703:            installing modules for apache, PHP etc.
                   4704:            Please note that you can modify variables in it easily by using
                   4705:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4706:            <code class="filename">Makefile</code>:</p>
                   4707: <pre class="programlisting">
                   4708: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4709: </pre>
1.23      wiz      4710: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4711:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4712:            performed for <code class="varname">PKGNAME</code>,
                   4713:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4714:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4715:            <code class="varname">X11BASE</code>,
                   4716:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4717:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4718:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4719: <p>You can display a different or additional files by
                   4720:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4721:            default is <code class="filename">MESSAGE</code>, if the file
                   4722:            exists.</p>
                   4723: </dd>
                   4724: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4725: <dd><p>FIXME: There is no documentation on the
                   4726:        alternatives framework.</p></dd>
                   4727: </dl></div>
                   4728: </div>
1.23      wiz      4729: <div class="sect2" title="11.5.2. Files affecting the build process">
1.1       dsieger  4730: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4731: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1       dsieger  4732: <div class="variablelist"><dl>
                   4733: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4734: <dd><p>This file contains arbitrary things that could
                   4735:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4736:        to be used by more than one package. This file should only be
                   4737:        used when the packages that will use the file are known in
                   4738:        advance. For other purposes it is often better to write a
                   4739:        <code class="filename">*.mk</code> file and give it a good name that
                   4740:        describes what it does.</p></dd>
                   4741: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4742: <dd><p>This file contains the dependency information
1.10      hubertf  4743:        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  4744: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4745: <dd><p>This file contains workarounds for compiler bugs
                   4746:        and similar things. It is included automatically by the pkgsrc
                   4747:        infrastructure, so you don't need an extra
                   4748:        <code class="literal">.include</code> line for
                   4749:        it.</p></dd>
                   4750: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4751: <dd><p>This file contains the code for the
1.10      hubertf  4752:        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  4753:        selected by the user. If a package has only one or two options,
                   4754:        it is equally acceptable to put the code directly into the
                   4755:        <code class="filename">Makefile</code>.</p></dd>
                   4756: </dl></div>
                   4757: </div>
1.23      wiz      4758: <div class="sect2" title="11.5.3. Files affecting nothing at all">
1.1       dsieger  4759: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4760: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1       dsieger  4761: <div class="variablelist"><dl>
                   4762: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4763: <dd><p>These files do not take place in the creation of
                   4764:        a package and thus are purely informative to the package
                   4765:        developer.</p></dd>
                   4766: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4767: <dd><p>This file contains things that need to be done
                   4768:        to make the package even
                   4769:        better.</p></dd>
                   4770: </dl></div>
                   4771: </div>
                   4772: </div>
1.23      wiz      4773: <div class="sect1" title="11.6. work*">
1.1       dsieger  4774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4775: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4776: </h2></div></div></div>
1.10      hubertf  4777: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4778:     unpacked into the directory denoted by
                   4779:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4780:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4781:     directory is also used to keep various timestamp files.
                   4782:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4783:     The default is <code class="filename">${.CURDIR}/work</code>
                   4784:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4785:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4786: </div>
1.23      wiz      4787: <div class="sect1" title="11.7. files/*">
1.1       dsieger  4788: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4789: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4790: </h2></div></div></div>
                   4791: <p>If you have any files that you wish to be placed in the package prior
                   4792:     to configuration or building, you could place these files here and use
1.10      hubertf  4793:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4794:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4795:     this. Alternatively, you could simply diff the file against
                   4796:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4797:     the creation of this file.</p>
                   4798: <p>If you want to share files in this way with other
                   4799:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4800:     to the other package's <code class="filename">files</code> directory,
                   4801:     e.g.:</p>
                   4802: <pre class="programlisting">
                   4803: FILESDIR=${.CURDIR}/../xemacs/files
                   4804: </pre>
                   4805: </div>
                   4806: </div>
1.23      wiz      4807: <div class="chapter" title="Chapter 12. Programming in Makefiles">
1.1       dsieger  4808: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4809: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4810: <div class="toc">
                   4811: <p><b>Table of Contents</b></p>
                   4812: <dl>
1.6       rillig   4813: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      4814: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   4815: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4816: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4817: <dd><dl>
                   4818: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4819: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4820: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4821: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4822: <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  4823: </dl></dd>
                   4824: </dl>
                   4825: </div>
                   4826: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4827:   each of which forms a well-defined part of the pkgsrc system. Using
1.29      dholland 4828:   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  4829:   like pkgsrc requires some discipline to keep the code correct and
                   4830:   understandable.</p>
                   4831: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4832:   programming are variables (which are actually macros) and shell
                   4833:   commands. Among these shell commands may even be more complex ones
1.29      dholland 4834:   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  4835:   as intended it is necessary to quote all variables correctly when they
                   4836:   are used.</p>
                   4837: <p>This chapter describes some patterns, that appear quite often in
                   4838:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4839:   with them.</p>
1.23      wiz      4840: <div class="sect1" title="12.1. Caveats">
1.1       dsieger  4841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4842: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.23      wiz      4843: <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
1.1       dsieger  4844: <p>When you are creating a file as a
                   4845:     target of a rule, always write the data to a temporary file first
                   4846:     and finally rename that file. Otherwise there might occur an error
                   4847:     in the middle of generating the file, and when the user runs
1.29      dholland 4848:     <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  4849:     regenerated properly. Example:</p>
                   4850: <pre class="programlisting">
                   4851: wrong:
                   4852:         @echo "line 1" &gt; ${.TARGET}
                   4853:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4854:         @false
                   4855: 
                   4856: correct:
                   4857:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4858:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4859:         @false
                   4860:         @mv ${.TARGET}.tmp ${.TARGET}
                   4861: </pre>
1.10      hubertf  4862: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4863:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4864:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4865:     correct</strong></span> gives an error message twice, as expected.</p>
1.29      dholland 4866: <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  4867:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4868:     happens when it is interrupted, for example by pressing
                   4869:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29      dholland 4870:     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  4871: </li></ul></div>
                   4872: </div>
1.23      wiz      4873: <div class="sect1" title="12.2. Makefile variables">
1.1       dsieger  4874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4875: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4876: <p><code class="filename">Makefile</code> variables contain strings that
                   4877:     can be processed using the five operators ``='', ``+='', ``?='',
1.29      dholland 4878:     ``:='', 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  4879:     page.</p>
                   4880: <p>When a variable's value is parsed from a
                   4881:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4882:     backslash character ``\'' are handled specially. If a backslash is
                   4883:     followed by a newline, any whitespace immediately in front of the
                   4884:     backslash, the backslash, the newline, and any whitespace
                   4885:     immediately behind the newline are replaced with a single space. A
                   4886:     backslash character and an immediately following hash character are
                   4887:     replaced with a single hash character. Otherwise, the backslash is
                   4888:     passed as is. In a variable assignment, any hash character that is
                   4889:     not preceded by a backslash starts a comment that continues upto the
                   4890:     end of the logical line.</p>
                   4891: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4892:     the only way to create a variable consisting of a single backslash
                   4893:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4894: <p>So far for defining variables. The other thing you can do with
                   4895:     variables is evaluating them. A variable is evaluated when it is
                   4896:     part of the right side of the ``:='' or the ``!='' operator, or
                   4897:     directly before executing a shell command which the variable is part
1.29      dholland 4898:     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  4899:     is, variables are not evaluated until there's no other way. The
                   4900:     ``modifiers'' mentioned in the man page also evaluate the
                   4901:     variable.</p>
                   4902: <p>Some of the modifiers split the string into words and then
                   4903:     operate on the words, others operate on the string as a whole. When
                   4904:     a string is split into words, it is split as you would expect
1.29      dholland 4905:     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 4906: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.1       dsieger  4907:     loop does not follow the shell quoting rules but splits at sequences
                   4908:     of whitespace.</p>
                   4909: <p>There are several types of variables that should be handled
                   4910:     differently. Strings and two types of lists.</p>
1.23      wiz      4911: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4912: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1       dsieger  4913:       characters. Nevertheless, you should restrict yourself to only
                   4914:       using printable characters. Examples are
                   4915:       <code class="varname">PREFIX</code> and
                   4916:       <code class="varname">COMMENT</code>.</p></li>
1.23      wiz      4917: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1       dsieger  4918:       are never exported to any shell command. Their elements are
                   4919:       separated by whitespace. Therefore, the elements themselves cannot
                   4920:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4921:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4922:       Examples are <code class="varname">DEPENDS</code> and
                   4923:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23      wiz      4924: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1       dsieger  4925:       may be exported to a shell command. Their elements can contain any
                   4926:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4927:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4928:       <code class="varname">DISTFILES</code> and
                   4929:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4930: </ul></div>
1.23      wiz      4931: <div class="sect2" title="12.2.1. Naming conventions">
1.1       dsieger  4932: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4933: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.23      wiz      4934: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   4935: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4936:        are reserved for use by the pkgsrc infrastructure. They shall
                   4937:        not be used by package
                   4938:        <code class="filename">Makefile</code>s.</p></li>
1.23      wiz      4939: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4940:        lowercase variable names for the iteration
                   4941:        variables.</p></li>
1.23      wiz      4942: <li class="listitem"><p>All list variables should have a ``plural''
1.1       dsieger  4943:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4944:        <code class="varname">DISTFILES</code>.</p></li>
                   4945: </ul></div>
                   4946: </div>
                   4947: </div>
1.23      wiz      4948: <div class="sect1" title="12.3. Code snippets">
1.1       dsieger  4949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4950: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  4951: <p>This section presents you with some code snippets you should
                   4952:     use in your own code. If you don't find anything appropriate here,
                   4953:     you should test your code and add it here.</p>
1.23      wiz      4954: <div class="sect2" title="12.3.1. Adding things to a list">
1.1       dsieger  4955: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4956: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  4957: <pre class="programlisting">
                   4958: STRING=                 foo * bar `date`
                   4959: INT_LIST=               # empty
                   4960: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4961: EXT_LIST=               # empty
                   4962: ANOTHER_EXT_LIST=       a=b c=d
                   4963: 
                   4964: INT_LIST+=              ${STRING}               # 1
                   4965: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4966: EXT_LIST+=              ${STRING:Q}             # 3
                   4967: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   4968: </pre>
                   4969: <p>When you add a string to an external list (example 3), it
                   4970:       must be quoted. In all other cases, you must not add a quoting
                   4971:       level. You must not merge internal and external lists, unless you
                   4972:       are sure that all entries are correctly interpreted in both
                   4973:       lists.</p>
                   4974: </div>
1.23      wiz      4975: <div class="sect2" title="12.3.2. Converting an internal list into an external list">
1.1       dsieger  4976: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4977: <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  4978: <pre class="programlisting">
                   4979: EXT_LIST=       # empty
                   4980: .for i in ${INT_LIST}
                   4981: EXT_LIST+=      ${i:Q}""
                   4982: .endfor
                   4983: </pre>
                   4984: <p>This code converts the internal list
                   4985:       <code class="varname">INT_LIST</code> into the external list
                   4986:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   4987:       are unquoted they must be quoted here. The reason for appending
                   4988:       <code class="varname">""</code> is explained below.</p>
                   4989: </div>
1.23      wiz      4990: <div class="sect2" title="12.3.3. Passing variables to a shell command">
1.1       dsieger  4991: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4992: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  4993: <p>Sometimes you may want to print an arbitrary string. There
                   4994:        are many ways to get it wrong and only few that can handle every
                   4995:        nastiness.</p>
                   4996: <pre class="programlisting">
                   4997: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   4998: EXT_LIST=       string=${STRING:Q} x=second\ item
                   4999: 
                   5000: all:
                   5001:         echo ${STRING}                  # 1
                   5002:         echo "${STRING}"                # 2
                   5003:         echo "${STRING:Q}"              # 3
                   5004:         echo ${STRING:Q}                # 4
                   5005:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5006:         printf "%s\\n" ${STRING:Q}""    # 6
                   5007:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   5008: </pre>
                   5009: <p>Example 1 leads to a syntax error in the shell, as the
                   5010:       characters are just copied.</p>
                   5011: <p>Example 2 leads to a syntax error too, and if you leave out
                   5012:       the last " character from <code class="varname">${STRING}</code>,
1.29      dholland 5013:       <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  5014:       variable would be evaluated, too.</p>
                   5015: <p>Example 3 outputs each space character preceded by a
                   5016:       backslash (or not), depending on the implementation of the
1.29      dholland 5017:       <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  5018: <p>Example 4 handles correctly every string that does not start
                   5019:       with a dash. In that case, the result depends on the
1.29      dholland 5020:       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  5021:       guarantee that your input does not start with a dash, this form is
                   5022:       appropriate.</p>
                   5023: <p>Example 5 handles even the case of a leading dash
                   5024:       correctly.</p>
                   5025: <p>Example 6 also works with every string and is the
                   5026:       light-weight solution, since it does not involve a pipe, which has
                   5027:       its own problems.</p>
                   5028: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5029:       because the quoting has already been done when adding elements to
                   5030:       the list.</p>
                   5031: <p>As internal lists shall not be passed to the shell, there is
                   5032:       no example for it.</p>
                   5033: </div>
1.23      wiz      5034: <div class="sect2" title="12.3.4. Quoting guideline">
1.1       dsieger  5035: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5036: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  5037: <p>There are many possible sources of wrongly quoted variables.
                   5038:       This section lists some of the commonly known ones.</p>
1.23      wiz      5039: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5040: <li class="listitem">
1.1       dsieger  5041: <p>Whenever you use the value of a list, think
                   5042:        about what happens to leading or trailing whitespace. If the
                   5043:        list is a well-formed shell expression, you can apply the
                   5044:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5045:        whitespace from each word. The <code class="varname">:M</code> operator
                   5046:        first splits its argument according to the rules of the shell,
                   5047:        and then creates a new list consisting of all words that match
                   5048:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5049:        One class of situations where this is needed is when adding a
                   5050:        variable like <code class="varname">CPPFLAGS</code> to
                   5051:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5052:        invokes other configure scripts, it strips the leading and
                   5053:        trailing whitespace from the variable and then passes it to the
                   5054:        other configure scripts. But these configure scripts expect the
                   5055:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5056:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5057:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5058:        here is how we do it:</p>
                   5059: <pre class="programlisting">
                   5060: CPPFLAGS=               # empty
                   5061: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5062: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5063: 
                   5064: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5065: 
                   5066: all:
                   5067:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5068:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   5069: </pre>
                   5070: </li>
1.23      wiz      5071: <li class="listitem"><p>The example above contains one bug: The
1.1       dsieger  5072:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5073:        expression, but there is the C compiler after it, which also
                   5074:        expects a properly quoted string (this time in C syntax). The
                   5075:        version above is therefore only correct if
                   5076:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5077:        or double quotes. If you want to allow these, you have to add
                   5078:        another layer of quoting to each variable that is used as a C
                   5079:        string literal. You cannot use the <code class="varname">:Q</code>
                   5080:        operator for it, as this operator only works for the
                   5081:        shell.</p></li>
1.23      wiz      5082: <li class="listitem">
1.1       dsieger  5083: <p>Whenever a variable can be empty, the
                   5084:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5085:        are two completely different cases which can be solved with the
                   5086:        same trick.</p>
                   5087: <pre class="programlisting">
                   5088: EMPTY=                  # empty
                   5089: empty_test:
                   5090:         for i in a ${EMPTY:Q} c; do \
                   5091:             echo "$$i"; \
                   5092:         done
                   5093: 
                   5094: for_test:
                   5095: .for i in a:\ a:\test.txt
                   5096:         echo ${i:Q}
                   5097:         echo "foo"
                   5098: .endfor
                   5099: </pre>
                   5100: <p>The first example will only print two of the three lines
                   5101:        we might have expected. This is because
                   5102:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5103:        the shell cannot see. The workaround is to write
                   5104:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5105:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5106:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5107: <p>The second example will only print three lines instead of
                   5108:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5109:        This is because the backslash of the value
                   5110:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29      dholland 5111:        <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
                   5112:        <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  5113:        <code class="varname">${i:Q}""</code>.</p>
                   5114: </li>
                   5115: </ul></div>
                   5116: </div>
1.23      wiz      5117: <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
1.1       dsieger  5118: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5119: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5120: <p>The pkgsrc bmake program does not handle the following
                   5121:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5122:       contains a ``-'' character, one of the closing braces is included
                   5123:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5124: <pre class="programlisting">
                   5125: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5126: </pre>
                   5127: <p>For a more complex code snippet and a workaround, see the
                   5128:       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
                   5129:       <code class="varname">bug1</code>.</p>
                   5130: </div>
                   5131: </div>
                   5132: </div>
1.23      wiz      5133: <div class="chapter" title="Chapter 13. PLIST issues">
1.1       dsieger  5134: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5135: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5136: <div class="toc">
                   5137: <p><b>Table of Contents</b></p>
                   5138: <dl>
1.6       rillig   5139: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      5140: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   5141: <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   5142: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5143: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      5144: <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   5145: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5146: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5147: </dl>
                   5148: </div>
                   5149: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      5150:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  5151:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5152:   directory it's been installed in) plus some additional statements
1.29      dholland 5153:   - 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  5154:   This chapter addresses some issues that need attention when
                   5155:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5156:   below!).</p>
1.23      wiz      5157: <div class="sect1" title="13.1. RCS ID">
1.1       dsieger  5158: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5159: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5160: <p>Be sure to add a RCS ID line as the first thing in any
                   5161:     <code class="filename">PLIST</code> file you write:</p>
                   5162: <pre class="programlisting">
                   5163: @comment $NetBSD$
                   5164:     </pre>
                   5165: </div>
1.23      wiz      5166: <div class="sect1" title="13.2. Semi-automatic PLIST generation">
1.1       dsieger  5167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5168: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  5169: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  5170:     to output a PLIST that matches any new files since the package
1.10      hubertf  5171:     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  5172:     more information on this target.</p>
                   5173: </div>
1.23      wiz      5174: <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
1.1       dsieger  5175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  5176: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  5177: </h2></div></div></div>
                   5178: <p>If you have used any of the *-dirs packages, as explained in
1.10      hubertf  5179:     <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
                   5180:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1       dsieger  5181:     <code class="varname">@comment</code>s instead of real
                   5182:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5183:     specific directories and files, so that the results of that
                   5184:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5185:     lot</em></span> during the update of packages.</p>
                   5186: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5187:     of AWK patterns and actions that are used to filter the output of
                   5188:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5189:     scripting you like to it, but be careful with quoting.</p>
                   5190: <p>For example, to get all files inside the
                   5191:     <code class="filename">libdata/foo</code> directory removed from the
                   5192:     resulting PLIST:</p>
                   5193: <pre class="programlisting">
                   5194: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5195:     </pre>
                   5196: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5197:     to a specific (shared) directory converted to
                   5198:     <code class="varname">@comment</code>s:</p>
                   5199: <pre class="programlisting">
                   5200: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5201:     </pre>
                   5202: </div>
1.23      wiz      5203: <div class="sect1" title="13.4. Variable substitution in PLIST">
1.1       dsieger  5204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5205: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5206: <p>A number of variables are substituted automatically in
                   5207:     PLISTs when a package is installed on a system. This includes the
                   5208:     following variables:</p>
                   5209: <div class="variablelist"><dl>
                   5210: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5211: <dd>
                   5212: <p>Some packages like emacs and perl embed information
                   5213:          about which architecture they were built on into the
                   5214:          pathnames where they install their files. To handle this
                   5215:          case, PLIST will be preprocessed before actually used, and
                   5216:          the symbol
1.23      wiz      5217:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  5218:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  5219:          same is done if the string
                   5220:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5221:          PLIST somewhere - use this on packages that have GNU
                   5222:          autoconf-created configure scripts.</p>
1.23      wiz      5223: <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  5224: <h3 class="title">Legacy note</h3>
                   5225: <p>There used to be a symbol
1.23      wiz      5226:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  5227:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  5228:            -m</strong></span>, but that's no longer supported and has
                   5229:            been removed.</p>
                   5230: </div>
                   5231: </dd>
                   5232: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5233: <dd>
                   5234: <p>Some packages want to embed the OS name and version
                   5235:          into some paths.  To do this, use these variables in the
                   5236:          <code class="filename">PLIST</code>:
                   5237:          </p>
1.23      wiz      5238: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5239: <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>
                   5240: <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>
                   5241: <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  5242: </ul></div>
                   5243: </dd>
                   5244: </dl></div>
                   5245: <p>For a complete list of values which are replaced by
                   5246:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5247:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5248: <p>If you want to change other variables not listed above, you
                   5249:     can add variables and their expansions to this variable in the
1.10      hubertf  5250:     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  5251: <pre class="programlisting">
                   5252: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5253:     </pre>
1.23      wiz      5254: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  5255:     in the <code class="filename">PLIST</code> with
1.23      wiz      5256:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      5257: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   5258:     the common case of conditionally including some
                   5259:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5260:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   5261:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5262:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      5263:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      5264:     in the <code class="filename">PLIST</code> with either
1.23      wiz      5265:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   5266:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      5267:     For example, in <code class="filename">Makefile</code>:</p>
                   5268: <pre class="programlisting">
                   5269: PLIST_VARS+=   foo
                   5270: .if <em class="replaceable"><code>condition</code></em>
                   5271: PLIST.foo=     yes
                   5272: .else
                   5273:     </pre>
                   5274: <p>And then in <code class="filename">PLIST</code>:</p>
                   5275: <pre class="programlisting">
                   5276: @comment $NetBSD$
                   5277: bin/bar
                   5278: man/man1/bar.1
                   5279: ${PLIST.foo}bin/foo
                   5280: ${PLIST.foo}man/man1/foo.1
                   5281: ${PLIST.foo}share/bar/foo.data
                   5282: ${PLIST.foo}@dirrm share/bar
                   5283:     </pre>
1.1       dsieger  5284: </div>
1.23      wiz      5285: <div class="sect1" title="13.5. Man page compression">
1.1       dsieger  5286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5287: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5288: <p>Man pages should be installed in compressed form if
                   5289:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5290:     and uncompressed otherwise. To handle this in the
1.23      wiz      5291:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  5292:     appended/removed automatically for man pages according to
                   5293:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5294:     or not, see above for details. This modification of the
                   5295:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5296:     <code class="filename">PLIST</code> itself.</p>
                   5297: </div>
1.23      wiz      5298: <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
1.1       dsieger  5299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5300: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5301: </h2></div></div></div>
                   5302: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5303:     in generating the binary package, set the variable
                   5304:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29      dholland 5305:     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  5306:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5307:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5308: </div>
1.23      wiz      5309: <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
1.1       dsieger  5310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5311: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5312: <p>Some packages decide to install a different set of files based on
                   5313:     the operating system being used. These differences can be
                   5314:     automatically handled by using the following files:</p>
1.23      wiz      5315: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5316: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   5317: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5318: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5319: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5320: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  5321: </ul></div>
                   5322: </div>
1.23      wiz      5323: <div class="sect1" title="13.8. Sharing directories between packages">
1.1       dsieger  5324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5325: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23      wiz      5326: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  5327:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 5328:     directories were problematic because you had to add special
                   5329:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  5330:     centralized package handle them.</p>
1.22      jakllsch 5331: <p>In pkgsrc, it is now easy: Each package should create
                   5332:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   5333:     will remove any directories left empty after uninstalling a
                   5334:     package.</p>
                   5335: <p>If a package needs an empty directory to work, create
                   5336:     the directory during installation as usual, and also add an
                   5337:     entry to the PLIST:
                   5338:     </p>
1.1       dsieger  5339: <pre class="programlisting">
1.22      jakllsch 5340: @pkgdir path/to/empty/directory
1.1       dsieger  5341:     </pre>
1.22      jakllsch 5342: <p>
                   5343:     </p>
1.1       dsieger  5344: </div>
                   5345: </div>
1.23      wiz      5346: <div class="chapter" title="Chapter 14. Buildlink methodology">
1.1       dsieger  5347: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5348: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5349: <div class="toc">
                   5350: <p><b>Table of Contents</b></p>
                   5351: <dl>
1.6       rillig   5352: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      5353: <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  5354: <dd><dl>
1.6       rillig   5355: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      5356: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5357:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5358:       and
                   5359:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5360:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  5361: </dl></dd>
1.23      wiz      5362: <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  5363: <dd><dl>
1.23      wiz      5364: <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   5365: <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  5366: </dl></dd>
                   5367: </dl>
                   5368: </div>
                   5369: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5370:   are seen by a package's configure and build processes.  This is implemented
                   5371:   in a two step process:</p>
1.23      wiz      5372: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5373: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  5374:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5375:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      5376: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  5377:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5378:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5379:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5380:       native compiler on some operating systems look like GCC, so that
                   5381:       packages that expect GCC won't require modifications to build with
                   5382:       those native compilers.</p></li>
                   5383: </ol></div>
                   5384: <p>This normalizes the environment in which a package is built so that the
                   5385:   package may be built consistently despite what other software may be
                   5386:   installed. Please note that the normal system header and library paths,
                   5387:   e.g. <code class="filename">/usr/include</code>,
                   5388:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5389:   designed to insulate the package build from non-system-supplied
                   5390:   software.</p>
1.23      wiz      5391: <div class="sect1" title="14.1. Converting packages to use buildlink3">
1.1       dsieger  5392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5393: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5394: <p>The process of converting packages to use the buildlink3
1.23      wiz      5395:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  5396:     The things to keep in mind are:</p>
1.23      wiz      5397: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5398: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  5399:        instead of the actual toolchain.  Some packages are tricky,
                   5400:        and the only way to know for sure is the check
                   5401:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5402:        wrappers are being invoked.</p></li>
1.23      wiz      5403: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  5404:        the package Makefile, e.g. Java VMs, standalone shells,
                   5405:        etc., because the code to symlink files into
                   5406:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      5407:        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  5408:        </p></li>
1.23      wiz      5409: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  5410:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5411:        package's Makefile are added as dependencies for that package.
                   5412:        </p></li>
                   5413: </ol></div>
                   5414: <p>If a dependency on a particular package is required for its libraries and
                   5415:     headers, then we replace:</p>
                   5416: <pre class="programlisting">
                   5417: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5418: </pre>
                   5419: <p>with</p>
                   5420: <pre class="programlisting">
                   5421: .include "../../category/foo/buildlink3.mk"
                   5422: </pre>
                   5423: <p>The buildlink3.mk files usually define the required dependencies.
                   5424:     If you need a newer version of the dependency when using buildlink3.mk
                   5425:     files, then you can define it in your Makefile; for example:</p>
                   5426: <pre class="programlisting">
                   5427: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5428: .include "../../category/foo/buildlink3.mk"
                   5429: </pre>
                   5430: <p>There are several <code class="filename">buildlink3.mk</code>
                   5431:     files in <code class="filename">pkgsrc/mk</code>
                   5432:     that handle special package issues:</p>
1.23      wiz      5433: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5434: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  5435:        the native or a pkgsrc Berkeley DB implementation based on
                   5436:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5437:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      5438: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  5439:        comes with neither Curses nor NCurses, this will take care
                   5440:        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      5441: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  5442:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5443:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5444:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      5445: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  5446:        system-provided Motif installation or adds a dependency on
                   5447:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.23      wiz      5448:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   5449:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, or <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.1       dsieger  5450:        which Motif version will be used.</p></li>
1.23      wiz      5451: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  5452:        variables that may be used by packages that use the
                   5453:        Open Sound System (OSS) API.</p></li>
1.23      wiz      5454: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.1       dsieger  5455:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
                   5456:        the file for more information.</p></li>
1.23      wiz      5457: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  5458:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5459:        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      5460: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  5461:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5462:        library.</p></li>
                   5463: </ul></div>
                   5464: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5465:     files provide a more complete
                   5466:     description of how to use them properly.</p>
                   5467: </div>
1.23      wiz      5468: <div class="sect1" title="14.2. Writing buildlink3.mk files">
1.1       dsieger  5469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5470: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5471: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5472:     included by Makefiles to indicate the need to compile and link
                   5473:     against header files and libraries provided by the package.  A
                   5474:     <code class="filename">buildlink3.mk</code> file should always provide
                   5475:     enough information to add the correct type of dependency
                   5476:     relationship and include any other
                   5477:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5478:     headers and libraries that it needs in turn.</p>
                   5479: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5480:     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>
                   5481:     package is highly recommended.  For most packages, the following
                   5482:     command will generate a good starting point for
                   5483:     <code class="filename">buildlink3.mk</code> files:</p>
                   5484: <pre class="screen">
                   5485: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5486: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5487:     </pre>
1.23      wiz      5488: <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
1.1       dsieger  5489: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5490: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5491: <p>The following real-life example
                   5492:       <code class="filename">buildlink3.mk</code> is taken
                   5493:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5494: <pre class="programlisting">
1.18      snj      5495: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  5496: 
1.18      snj      5497: BUILDLINK_TREE+=       tiff
1.1       dsieger  5498: 
1.18      snj      5499: .if !defined(TIFF_BUILDLINK3_MK)
                   5500: TIFF_BUILDLINK3_MK:=
1.1       dsieger  5501: 
1.18      snj      5502: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5503: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5504: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.1       dsieger  5505: 
                   5506: .include "../../devel/zlib/buildlink3.mk"
                   5507: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      5508: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  5509: 
1.18      snj      5510: BUILDLINK_TREE+=       -tiff
1.1       dsieger  5511: </pre>
                   5512: <p>The header and footer manipulate
1.18      snj      5513:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  5514:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      5515:       the dependency tree.</p>
                   5516: <p>The main section is protected from multiple inclusion
1.1       dsieger  5517:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5518:       added.  Several important variables are set in the section:</p>
1.23      wiz      5519: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5520: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5521:          is the actual dependency recorded in the installed
                   5522:          package; this should always be set using
1.10      hubertf  5523:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  5524:          we're appending to any pre-existing list of values.  This
                   5525:          variable should be set to the first version of the
1.26      wiz      5526:          package that had an backwards-incompatible API change.
1.1       dsieger  5527:          </p></li>
1.23      wiz      5528: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5529:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5530:          pkgsrc directory.</p></li>
1.23      wiz      5531: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5532:          (not shown above) controls whether we use
                   5533:          <code class="varname">BUILD_DEPENDS</code> or
                   5534:          <code class="varname">DEPENDS</code> to add the dependency on
                   5535:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5536:          selected by setting
                   5537:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5538:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  5539:          used.</p></li>
1.23      wiz      5540: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5541:            and
                   5542:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5543:            (not shown above) are lists of subdirectories of
                   5544:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5545:            to add to the header and library search paths.  These
1.23      wiz      5546:            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  5547:          respectively.</p></li>
1.23      wiz      5548: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5549:            (not shown above) is the list of preprocessor flags to add
                   5550:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      5551:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  5552:            should be avoided and instead be handled using
                   5553:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5554:          above.</p></li>
                   5555: </ul></div>
                   5556: <p>The following variables are all optionally defined within
                   5557:       this second section (protected against multiple inclusion) and
                   5558:       control which package files are symlinked into
                   5559:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5560:       transformed during the symlinking:</p>
1.23      wiz      5561: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5562: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5563:            (not shown above) is a shell glob pattern relative to
                   5564:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5565:            to be symlinked into
                   5566:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5567:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      5568: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5569:            (not shown above) is a shell pipeline that
                   5570:            outputs to stdout a list of files relative to
                   5571:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5572:            The resulting files are to be symlinked
                   5573:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5574:            this takes the <code class="filename">+CONTENTS</code> of a
                   5575:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5576:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      5577: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5578:            (not shown above) is a filter command that filters
                   5579:            <code class="filename">+CONTENTS</code> input into a list of files
                   5580:            relative to
                   5581:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5582:            on stdout.  By default for overwrite packages,
                   5583:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5584:            outputs the contents of the <code class="filename">include</code>
                   5585:            and <code class="filename">lib</code> directories in the package
                   5586:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5587:            it outputs any libtool archives in
                   5588:            <code class="filename">lib</code> directories.</p></li>
1.23      wiz      5589: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  5590:            (not shown above) is a list of sed arguments used to
                   5591:            transform the name of the source filename into a
1.10      hubertf  5592:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  5593:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5594: </ul></div>
1.18      snj      5595: <p>This section can additionally include any
1.1       dsieger  5596:       <code class="filename">buildlink3.mk</code> needed for
                   5597:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5598:       Including these <code class="filename">buildlink3.mk</code> files
                   5599:       means that the headers and libraries for these
                   5600:       dependencies are also symlinked into
                   5601:       <code class="filename">${BUILDLINK_DIR}</code>
                   5602:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5603:       <code class="filename">buildlink3.mk</code>
1.18      snj      5604:       file is included. Dependencies are only added for directly
                   5605:       include <code class="filename">buildlink3.mk</code> files.</p>
1.1       dsieger  5606: </div>
1.26      wiz      5607: <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files">
1.1       dsieger  5608: <div class="titlepage"><div><div><h3 class="title">
1.26      wiz      5609: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1       dsieger  5610:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5611:       and
                   5612:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5613:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5614: <p>These two variables differ in that one describes source
                   5615:       compatibility (API) and the other binary compatibility (ABI).
                   5616:       The difference is that a change in the API breaks compilation of
                   5617:       programs while changes in the ABI stop compiled programs from
                   5618:       running.</p>
                   5619: <p>Changes to the
1.27      wiz      5620:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      5621:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5622:       very rarely. One possible reason is that all packages depending
                   5623:       on this already need a newer version. In case it is bumped see
                   5624:       the description below.</p>
                   5625: <p>The most common example of an ABI change is that the major
                   5626:       version of a shared library is increased. In this case,
                   5627:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5628:       should be adjusted to require at least the new package version.
                   5629:       Then the packages that depend on this package need their
                   5630:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5631:       <code class="filename">buildlink3.mk</code> files, their
                   5632:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5633:       adjusted, too. This is needed so pkgsrc will require the correct
                   5634:       package dependency and not settle for an older one when building
                   5635:       the source.</p>
1.10      hubertf  5636: <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      5637:       more information about dependencies on other packages,
                   5638:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  5639:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5640: <p>Please take careful consideration before adjusting
                   5641:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5642:       or
                   5643:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5644:       as we don't want to cause unneeded package deletions and
                   5645:       rebuilds.  In many cases, new versions of packages work just
                   5646:       fine with older dependencies.</p>
                   5647: <p>Also it is not needed to set
1.26      wiz      5648:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5649:       when it is identical to
1.1       dsieger  5650:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5651: </div>
                   5652: </div>
1.23      wiz      5653: <div class="sect1" title="14.3. Writing builtin.mk files">
1.1       dsieger  5654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5655: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5656: <p>Some packages in pkgsrc install headers and libraries that
                   5657:       coincide with headers and libraries present in the base system.
                   5658:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5659:       packages should also include a <code class="filename">builtin.mk</code>
                   5660:       file that includes the necessary checks to decide whether using
                   5661:       the built-in software or the pkgsrc software is
                   5662:     appropriate.</p>
                   5663: <p>The only requirements of a builtin.mk file for
                   5664:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      5665: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5666: <li class="listitem"><p>It should set
1.1       dsieger  5667:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5668:        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  5669:        after it is included.</p></li>
1.23      wiz      5670: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  5671:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5672:        which is already set before the
                   5673:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      5674: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  5675:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5676:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5677: </ol></div>
1.23      wiz      5678: <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
1.1       dsieger  5679: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5680: <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  5681: <p>The following is the recommended template for builtin.mk
                   5682:       files:</p>
                   5683: <pre class="programlisting">
                   5684: .if !defined(IS_BUILTIN.foo)
                   5685: #
                   5686: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5687: # genuinely exists in the system or not.
                   5688: #
                   5689: IS_BUILTIN.foo?=        no
                   5690: 
                   5691: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5692: # version can be determined.
                   5693: #
                   5694: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5695: BUILTIN_PKG.foo?=       foo-1.0
                   5696: .  endif
                   5697: .endif  # IS_BUILTIN.foo
                   5698: 
                   5699: .if !defined(USE_BUILTIN.foo)
                   5700: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5701: .  if defined(BUILTIN_PKG.foo)
                   5702: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5703: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5704: USE_BUILTIN.foo!=                                                       \
                   5705:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5706:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5707: .      endif
                   5708: .    endfor
                   5709: .  endif
                   5710: .endif  # USE_BUILTIN.foo
                   5711: 
                   5712: CHECK_BUILTIN.foo?=     no
                   5713: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5714: #
                   5715: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5716: # "yes" or "no".
                   5717: #
                   5718: .endif  # CHECK_BUILTIN.foo
                   5719: </pre>
                   5720: <p>The first section sets
                   5721:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5722:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5723:       in the base system.  This should not be a base system software
                   5724:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      5725:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  5726:       included as part of the base system.  This variable is only
                   5727:       used internally within the <code class="filename">builtin.mk</code>
                   5728:       file.</p>
                   5729: <p>The second section sets
                   5730:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5731:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5732:       system if it exists (if
                   5733:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5734:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  5735:       within the <code class="filename">builtin.mk</code> file.</p>
                   5736: <p>The third section sets
                   5737:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5738:       and is <span class="emphasis"><em>required</em></span> in all
                   5739:       <code class="filename">builtin.mk</code> files.  The code in this
                   5740:       section must make the determination whether the built-in
                   5741:       software is adequate to satisfy the dependencies listed in
                   5742:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5743:       This is typically done by comparing
                   5744:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5745:       against each of the dependencies in
                   5746:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5747:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5748:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5749:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5750:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5751:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5752:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5753:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5754:       that the built-in version of the software is similar enough to
                   5755:       be used as a replacement.</p>
                   5756: <p>The last section is guarded by
                   5757:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5758:       and includes code that uses the value of
                   5759:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5760:       set in the previous section.  This typically includes, e.g.,
                   5761:       adding additional dependency restrictions and listing additional
                   5762:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5763:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5764: </div>
1.23      wiz      5765: <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
1.1       dsieger  5766: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5767: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5768: <p>When building packages, it's possible to choose whether to set
                   5769:        a global preference for using either the built-in (native)
                   5770:        version or the pkgsrc version of software to satisfy a
                   5771:        dependency.  This is controlled by setting
                   5772:        <code class="varname">PREFER_PKGSRC</code> and
                   5773:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5774:        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  5775:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5776:        use the pkgsrc versions of software, while
                   5777:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5778:        built-in versions.  Preferences are determined by the most
                   5779:        specific instance of the package in either
                   5780:        <code class="varname">PREFER_PKGSRC</code> or
                   5781:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5782:        in neither or in both variables, then
                   5783:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5784:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5785:        using pkgsrc versions of software for all but the most basic
                   5786:       bits on a NetBSD system, you can set:</p>
                   5787: <pre class="programlisting">
                   5788: PREFER_PKGSRC=  yes
                   5789: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5790: </pre>
                   5791: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5792:       <code class="filename">builtin.mk</code>
                   5793:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5794:       otherwise it is simply ignored in that list.</p>
                   5795: </div>
                   5796: </div>
                   5797: </div>
1.23      wiz      5798: <div class="chapter" title="Chapter 15. The pkginstall framework">
1.1       dsieger  5799: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5800: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5801: <div class="toc">
                   5802: <p><b>Table of Contents</b></p>
                   5803: <dl>
1.6       rillig   5804: <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  5805: <dd><dl>
1.6       rillig   5806: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5807: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5808: </dl></dd>
1.6       rillig   5809: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5810: <dd><dl>
1.23      wiz      5811: <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   5812: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5813: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5814: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5815: </dl></dd>
                   5816: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5817: <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>
                   5818: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5819: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5820: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5821: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5822: <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  5823: </dl>
                   5824: </div>
                   5825: <p>This chapter describes the framework known as
                   5826: <code class="literal">pkginstall</code>, whose key features are:</p>
1.23      wiz      5827: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5828: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5829:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5830: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5831:     provided that packages are correctly designed.</p></li>
1.23      wiz      5832: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5833: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5834: <li class="listitem"><p>Registration of system shells.</p></li>
                   5835: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5836: </ul></div>
                   5837: <p>The following sections inspect each of the above points in detail.</p>
                   5838: <p>You may be thinking that many of the things described here could be
                   5839: easily done with simple code in the package's post-installation target
                   5840: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5841: as the code in them is only executed when building from source.  Machines
                   5842: using binary packages could not benefit from it at all (as the code itself
                   5843: could be unavailable).  Therefore, the only way to achieve any of the items
                   5844: described above is by means of the installation scripts, which are
                   5845: automatically generated by pkginstall.</p>
1.23      wiz      5846: <div class="sect1" title="15.1. Files and directories outside the installation prefix">
1.1       dsieger  5847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5848: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5849: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5850: of files and directories that belong to a package.  The names used in it
                   5851: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5852: which means that it cannot register files outside this directory (absolute
                   5853: path names are not allowed).  Despite this restriction, some packages need
                   5854: to install files outside this location; e.g., under
                   5855: <code class="filename">${VARBASE}</code> or
                   5856: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5857: is to create such files during installation time by using
                   5858: installation scripts.</p>
                   5859: <p>The generic installation scripts are shell scripts that can
                   5860: contain arbitrary code.  The list of scripts to execute is taken from
                   5861: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5862: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5863: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5864: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5865: commands, so they have the potential to create and manage files
                   5866: anywhere in the file system.</p>
                   5867: <p>Using these general installation files is not recommended, but
                   5868: may be needed in some special cases.  One reason for avoiding them is
                   5869: that the user has to trust the packager that there is no unwanted or
                   5870: simply erroneous code included in the installation script. Also,
                   5871: previously there were many similar scripts for the same functionality,
                   5872: and fixing a common error involved finding and changing all of
                   5873: them.</p>
                   5874: <p>The pkginstall framework offers another, standardized way.  It
                   5875: provides generic scripts to abstract the manipulation of such files
                   5876: and directories based on variables set in the package's
                   5877: <code class="filename">Makefile</code>.  The rest of this section describes
                   5878: these variables.</p>
1.23      wiz      5879: <div class="sect2" title="15.1.1. Directory manipulation">
1.1       dsieger  5880: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5881: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5882: <p>The following variables can be set to request the creation of
                   5883: directories anywhere in the file system:</p>
1.23      wiz      5884: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5885: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5886:     contain a list of directories that should be created and should attempt
                   5887:     to be destroyed by the installation scripts.  The difference between
                   5888:     the two is that the latter prompts the administrator to remove any
                   5889:     directories that may be left after deinstallation (because they were
                   5890:     not empty), while the former does not.</p></li>
1.23      wiz      5891: <li class="listitem">
1.1       dsieger  5892: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5893:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5894:     which directories should be created and should attempt to be destroyed
                   5895:     by the installation scripts.  Each tuple holds the following values,
                   5896:     separated by spaces: the directory name, its owner, its group and its
                   5897:     numerical mode.  For example:</p>
                   5898: <pre class="programlisting">
                   5899: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5900: </pre>
                   5901: <p>The difference between the two is exactly the same as their
                   5902:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5903: </li>
                   5904: </ul></div>
                   5905: </div>
1.23      wiz      5906: <div class="sect2" title="15.1.2. File manipulation">
1.1       dsieger  5907: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5908: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5909: <p>Creating non-empty files outside the installation prefix is tricky
                   5910: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5911: To overcome this problem, the only solution is to extract the file in the
                   5912: known place (i.e., inside the installation prefix) and copy it to the
                   5913: appropriate location during installation (done by the installation scripts
                   5914: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5915: file</em></span> in the following paragraphs, which describe the variables
                   5916: that can be used to automatically and consistently handle files outside the
                   5917: installation prefix:</p>
1.23      wiz      5918: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5919: <li class="listitem">
1.1       dsieger  5920: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      5921:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5922:     During installation time, the master file is copied to the target one
                   5923:     if and only if the latter does not exist.  Upon deinstallation, the
                   5924:     target file is removed provided that it was not modified by the
                   5925:     installation.</p>
                   5926: <p>The difference between the two is that the latter prompts the
                   5927:     administrator to remove any files that may be left after
                   5928:     deinstallation (because they were not empty), while the former does
                   5929:     not.</p>
                   5930: </li>
1.23      wiz      5931: <li class="listitem">
1.1       dsieger  5932: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      5933:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5934:     files as well as their target locations.  For each of them, it also
                   5935:     specifies their owner, their group and their numeric permissions, in
                   5936:     this order.  For example:</p>
                   5937: <pre class="programlisting">
1.30      wiz      5938: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       dsieger  5939: </pre>
                   5940: <p>The difference between the two is exactly the same as their
                   5941:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5942: </li>
                   5943: </ul></div>
                   5944: </div>
                   5945: </div>
1.23      wiz      5946: <div class="sect1" title="15.2. Configuration files">
1.1       dsieger  5947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5948: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  5949: <p>Configuration files are special in the sense that they are installed
                   5950: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5951: need special treatment during installation (most of which is automated by
                   5952: pkginstall).  The main concept you must bear in mind is that files marked
                   5953: as configuration files are automatically copied to the right place (somewhere
                   5954: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5955: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5956: be removed if they have local modifications.  This ensures that
                   5957: administrators never lose any custom changes they may have made.</p>
1.23      wiz      5958: <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
1.1       dsieger  5959: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5960: <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  5961: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5962: specifies where configuration files shall be installed.  Its contents are
                   5963: set based upon the following variables:</p>
1.23      wiz      5964: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   5965: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5966:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5967:     be overridden by the user to point to his preferred location (e.g.,
                   5968:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5969:     Packages must not use it directly.</p></li>
1.23      wiz      5970: <li class="listitem">
1.1       dsieger  5971: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5972:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5973:     for the package being built shall be installed.  The definition of this
                   5974:     variable only makes sense in the package's
                   5975:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5976: <p>As an example, consider the Apache package,
                   5977:     <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
                   5978:     configuration files under the
                   5979:     <code class="filename">httpd/</code> subdirectory of
                   5980:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5981:     Makefile.</p>
                   5982: </li>
1.23      wiz      5983: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5984:     variable that holds this package's configuration directory (if
                   5985:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5986:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5987:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5988: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5989:     directory where the configuration files for the package identified by
                   5990:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5991: </ul></div>
                   5992: <p>Based on the above variables, pkginstall determines the value of
                   5993: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5994: variable that can be used within a package to refer to its configuration
                   5995: directory.  The algorithm used to set its value is basically the
                   5996: following:</p>
1.23      wiz      5997: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5998: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  5999:     its value is used.</p></li>
1.23      wiz      6000: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  6001:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6002:     <code class="filename">Makefile</code>, the resulting value is
                   6003:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      6004: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  6005:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6006: </ol></div>
                   6007: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  6008: 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
                   6009: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6010: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  6011: </div>
1.23      wiz      6012: <div class="sect2" title="15.2.2. Telling the software where configuration files are">
1.1       dsieger  6013: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6014: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  6015: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6016: known place, you need to teach each package where it shall install its
                   6017: files.  In some cases you will have to patch the package Makefiles to
                   6018: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6019: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6020: generated files:</p>
                   6021: <pre class="programlisting">
                   6022: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   6023: </pre>
                   6024: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6025: for</em></span> its configuration files, not where they will be originally
                   6026: installed (although the difference is never explicit,
                   6027: unfortunately).</p>
                   6028: </div>
1.23      wiz      6029: <div class="sect2" title="15.2.3. Patching installations">
1.1       dsieger  6030: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6031: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  6032: <p>As said before, pkginstall automatically handles configuration files.
                   6033: This means that <span class="strong"><strong>the packages themselves must not
                   6034: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   6035: directly</strong></span>.  Bad news is that many software installation scripts
                   6036: will, out of the box, mess with the contents of that directory.  So what is
                   6037: the correct procedure to fix this issue?</p>
                   6038: <p>You must teach the package (usually by manually patching it) to
                   6039: install any configuration files under the examples hierarchy,
                   6040: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6041: <code class="filename">PLIST</code> registers them and the administrator always
                   6042: has the original copies available.</p>
                   6043: <p>Once the required configuration files are in place (i.e., under the
                   6044: examples hierarchy), the pkginstall framework can use them as master copies
                   6045: during the package installation to update what is in
                   6046: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   6047: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  6048: 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  6049: about their syntax and their purpose.  Here is an example, taken from the
                   6050: <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>
                   6051: <pre class="programlisting">
                   6052: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6053: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   6054: </pre>
                   6055: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6056: package and has no meaning outside it.</p>
                   6057: </div>
1.23      wiz      6058: <div class="sect2" title="15.2.4. Disabling handling of configuration files">
1.1       dsieger  6059: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6060: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  6061: <p>The automatic copying of config files can be toggled by setting the
                   6062: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6063: installation.</p>
                   6064: </div>
                   6065: </div>
1.23      wiz      6066: <div class="sect1" title="15.3. System startup scripts">
1.1       dsieger  6067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6068: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  6069: <p>System startup scripts are special files because they must be
                   6070: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  6071: 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  6072: can be used.  However, pkginstall provides a special mechanism to handle
                   6073: these files.</p>
                   6074: <p>In order to provide system startup scripts, the package has
                   6075: to:</p>
1.23      wiz      6076: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6077: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  6078:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   6079:     <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
                   6080:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      6081: <li class="listitem">
1.1       dsieger  6082: <p>Tell pkginstall to handle it, appending the name of the script,
                   6083:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6084:     Continuing the previous example:</p>
                   6085: <pre class="programlisting">
                   6086: RCD_SCRIPTS+=   cupsd
                   6087: </pre>
                   6088: </li>
                   6089: </ol></div>
                   6090: <p>Once this is done, pkginstall will do the following steps for each
                   6091: script in an automated fashion:</p>
1.23      wiz      6092: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6093: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  6094:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6095:     variable.</p></li>
1.23      wiz      6096: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  6097:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6098:     that this master file must be explicitly registered in the
                   6099:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      6100: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  6101:     from the examples hierarchy into the system-wide startup scripts
                   6102:     directory.</p></li>
                   6103: </ol></div>
1.23      wiz      6104: <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
1.1       dsieger  6105: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6106: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6107: <p>The automatic copying of config files can be toggled by setting the
                   6108: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6109: installation.  Note that the scripts will be always copied inside the
                   6110: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6111: matter what the value of this variable is.</p>
                   6112: </div>
                   6113: </div>
1.23      wiz      6114: <div class="sect1" title="15.4. System users and groups">
1.1       dsieger  6115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6116: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6117: <p>If a package needs to create special users and/or groups during
                   6118: installation, it can do so by using the pkginstall framework.</p>
                   6119: <p>Users can be created by adding entries to the
                   6120: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6121: syntax:</p>
                   6122: <pre class="programlisting">
                   6123: user:group
                   6124: </pre>
                   6125: <p>Further specification of user details may be done by setting
                   6126: per-user variables.
                   6127: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6128: numeric UID for the user.
                   6129: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6130: user's description or comment.
                   6131: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6132: user's home directory, and defaults to
                   6133: <code class="filename">/nonexistent</code> if not specified.
                   6134: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6135: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6136: not specified.</p>
                   6137: <p>Similarly, groups can be created by adding entries to the
                   6138: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6139: <pre class="programlisting">
                   6140: group
                   6141: </pre>
                   6142: <p>The numeric GID of the group may be set by defining
                   6143: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6144: <p>If a package needs to create the users and groups at an earlier
                   6145: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6146: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6147: indicate the phase before which the users and groups are created.  In
                   6148: this case, the numeric UIDs and GIDs of the created users and groups
                   6149: are automatically hardcoded into the final installation scripts.</p>
                   6150: </div>
1.23      wiz      6151: <div class="sect1" title="15.5. System shells">
1.1       dsieger  6152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6153: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6154: <p>Packages that install system shells should register them in the shell
                   6155: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6156: administrator.  This must be done from the installation scripts to keep
                   6157: binary packages working on any system.  pkginstall provides an easy way to
                   6158: accomplish this task.</p>
                   6159: <p>When a package provides a shell interpreter, it has to set the
                   6160: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6161: add some hooks to the installation scripts to handle it.  Consider the
                   6162: 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>
                   6163: <pre class="programlisting">
                   6164: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6165: </pre>
1.23      wiz      6166: <div class="sect2" title="15.5.1. Disabling shell registration">
1.1       dsieger  6167: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6168: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6169: <p>The automatic registration of shell interpreters can be disabled by
                   6170: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6171: environment variable to <code class="literal">NO</code>.</p>
                   6172: </div>
                   6173: </div>
1.23      wiz      6174: <div class="sect1" title="15.6. Fonts">
1.1       dsieger  6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6176: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6177: <p>Packages that install X11 fonts should update the database files
                   6178: that index the fonts within each fonts directory.  This can easily be
                   6179: accomplished within the pkginstall framework.</p>
                   6180: <p>When a package installs X11 fonts, it must list the directories in
                   6181: which fonts are installed in the
                   6182: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      6183: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   6184: <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  6185: installation scripts to run the appropriate commands to update the fonts
                   6186: database files within each of those directories.  For convenience, if the
                   6187: directory path is relative, it is taken to be relative to the package's
                   6188: 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>
                   6189: <pre class="programlisting">
                   6190: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6191: </pre>
1.23      wiz      6192: <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
1.1       dsieger  6193: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6194: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6195: <p>The automatic update of fonts databases can be disabled by
                   6196: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6197: environment variable to <code class="literal">NO</code>.</p>
                   6198: </div>
                   6199: </div>
                   6200: </div>
1.23      wiz      6201: <div class="chapter" title="Chapter 16. Options handling">
1.1       dsieger  6202: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6203: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6204: <div class="toc">
                   6205: <p><b>Table of Contents</b></p>
                   6206: <dl>
1.6       rillig   6207: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      6208: <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   6209: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6210: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6211: </dl>
                   6212: </div>
                   6213: <p>Many packages have the ability to be built to support different
                   6214: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6215: in pkgsrc that provides generic handling of those options that
                   6216: determine different ways in which the packages can be built.  It's
                   6217: possible for the user to specify exactly which sets of options will be
                   6218: built into a package or to allow a set of global default options
                   6219: apply.</p>
1.7       rillig   6220: <p>There are two broad classes of behaviors that one might want to
                   6221: control via options.  One is whether some particular feature is
                   6222: enabled in a program that will be built anyway, often by including or
                   6223: not including a dependency on some other package.  The other is
                   6224: whether or not an additional program will be built as part of the
                   6225: package.  Generally, it is better to make a split package for such
                   6226: additional programs instead of using options, because it enables
                   6227: binary packages to be built which can then be added separately.  For
                   6228: example, the foo package might have minimal dependencies (those
                   6229: packages without which foo doesn't make sense), and then the foo-gfoo
                   6230: package might include the GTK frontend program gfoo.  This is better
                   6231: than including a gtk option to foo that adds gfoo, because either that
                   6232: option is default, in which case binary users can't get foo without
                   6233: gfoo, or not default, in which case they can't get gfoo.  With split
                   6234: packages, they can install foo without having GTK, and later decide to
                   6235: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6236: source users too, avoiding the need for rebuilds.</p>
                   6237: <p>Plugins with widely varying dependencies should usually be split
                   6238: instead of options.</p>
                   6239: <p>It is often more work to maintain split packages, especially if
                   6240: the upstream package does not support this.  The decision of split
                   6241: vs. option should be made based on the likelihood that users will want
                   6242: or object to the various pieces, the size of the dependencies that are
                   6243: included, and the amount of work.</p>
                   6244: <p>A further consideration is licensing.  Non-free parts, or parts
                   6245: that depend on non-free dependencies (especially plugins) should
                   6246: almost always be split if feasible.</p>
1.23      wiz      6247: <div class="sect1" title="16.1. Global default options">
1.1       dsieger  6248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6249: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6250: <p>Global default options are listed in
                   6251: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6252: that should be built into every package if that option is supported.
1.10      hubertf  6253: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6254: </div>
1.23      wiz      6255: <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
1.1       dsieger  6256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6257: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6258: </h2></div></div></div>
                   6259: <p>The following example shows how
                   6260: <code class="filename">bsd.options.mk</code> should be used
                   6261: by the hypothetical ``wibble'' package, either in the package
                   6262: <code class="filename">Makefile</code>, or in a file,
                   6263: e.g. <code class="filename">options.mk</code>, that is included by the
                   6264: main package <code class="filename">Makefile</code>.</p>
                   6265: <pre class="programlisting">
                   6266: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6267: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6268: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6269: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6270: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6271: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6272: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6273: 
                   6274: .include "../../mk/bsd.prefs.mk"
                   6275: 
                   6276: # this package was previously named wibble2
                   6277: .if defined(PKG_OPTIONS.wibble2)
                   6278: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6279: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6280:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6281: .endif
                   6282: 
                   6283: .include "../../mk/bsd.options.mk"
                   6284: 
                   6285: # Package-specific option-handling
                   6286: 
                   6287: ###
                   6288: ### FOO support
                   6289: ###
                   6290: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6291: CONFIGURE_ARGS+=    --enable-foo
                   6292: .endif
                   6293: 
                   6294: ###
                   6295: ### LDAP support
                   6296: ###
                   6297: .if !empty(PKG_OPTIONS:Mldap)
                   6298: .  include "../../databases/openldap-client/buildlink3.mk"
                   6299: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6300: .endif
                   6301: 
                   6302: ###
                   6303: ### database support
                   6304: ###
                   6305: .if !empty(PKG_OPTIONS:Mmysql)
                   6306: .  include "../../mk/mysql.buildlink3.mk"
                   6307: .endif
                   6308: .if !empty(PKG_OPTIONS:Mpgsql)
                   6309: .  include "../../mk/pgsql.buildlink3.mk"
                   6310: .endif
                   6311: </pre>
                   6312: <p>The first section contains the information about which build
                   6313: options are supported by the package, and any default options settings
                   6314: if needed.</p>
1.23      wiz      6315: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6316: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29      dholland 6317: <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  6318: options.  It should be set to
                   6319: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6320: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6321: at the point where the options are processed.</p></li>
1.23      wiz      6322: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  6323: build options supported by the package.</p></li>
1.23      wiz      6324: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  6325: list of names of groups of mutually exclusive options.  The options in
                   6326: each group are listed in
                   6327: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6328: The most specific setting of any option from the group takes
                   6329: precedence over all other options in the group.  Options from the
                   6330: groups will be automatically added to
                   6331: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      6332: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  6333: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6334: packages will fail if no option from the group is
                   6335: selected.</p></li>
1.23      wiz      6336: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  6337: of names of sets of options.  At least one option from each set must
                   6338: be selected.  The options in each set are listed in
                   6339: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6340: Options from the sets will be automatically added to
                   6341: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6342: fail if no option from the set is selected.</p></li>
1.23      wiz      6343: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  6344: build options which are enabled by default.</p></li>
1.23      wiz      6345: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  6346: of
1.23      wiz      6347: <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  6348: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6349: their option counterparts.  Pairs should be added with
1.23      wiz      6350: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  6351: warning will be issued if the user uses a legacy
                   6352: variable.</p></li>
1.23      wiz      6353: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  6354: of
1.23      wiz      6355: <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  6356: pairs that map options that have been renamed to their new
1.23      wiz      6357: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  6358: the listing of global legacy options.  A warning will be issued if
                   6359: the user uses a legacy option.</p></li>
1.23      wiz      6360: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  6361: options implied by deprecated variables used.  This can be used for
                   6362: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6363: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6364: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      6365: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  6366: a list of warnings about deprecated variables or options used, and
                   6367: what to use instead.</p></li>
                   6368: </ol></div>
                   6369: <p>A package should never modify
                   6370: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6371: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6372: To suggest a default set of options, use
                   6373: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6374: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6375: including <code class="filename">bsd.options.mk</code>.  If none of
                   6376: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6377: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6378: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6379: happen with platform-specific options if none of them is supported on
                   6380: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6381: empty list and the package is otherwise treated as not using the
                   6382: options framework.</p>
                   6383: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6384: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6385: build options, properly filtered to remove unsupported and duplicate
                   6386: options.</p>
                   6387: <p>The remaining sections contain the logic that is specific to
                   6388: each option.  The correct way to check for an option is to check
                   6389: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6390: <pre class="programlisting">
                   6391: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6392: </pre>
                   6393: </div>
1.23      wiz      6394: <div class="sect1" title="16.3. Option Names">
1.1       dsieger  6395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6396: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6397: <p>Options that enable similar features in different packages (like
                   6398: optional support for a library) should use a common name in all
                   6399: packages that support it (like the name of the library).  If another
                   6400: package already has an option with the same meaning, use the same
                   6401: name.</p>
                   6402: <p>Options that enable features specific to one package, where it's
                   6403: unlikely that another (unrelated) package has the same (or a similar)
                   6404: optional feature, should use a name prefixed with
                   6405: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6406: <p>If a group of related packages share an optional feature
                   6407: specific to that group, prefix it with the name of the
1.23      wiz      6408: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  6409: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6410: <p>For new options, add a line to
                   6411: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6412: fields, separated by tab.  The first field is the option name, the
                   6413: second its description.  The description should be a whole sentence
                   6414: (starting with an uppercase letter and ending with a period) that
1.23      wiz      6415: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6416: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  6417: </div>
1.23      wiz      6418: <div class="sect1" title="16.4. Determining the options of dependencies">
1.7       rillig   6419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6420: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  6421: <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   6422: different dependencies based on the options with which the package was
                   6423: built. For querying these options, the file
                   6424: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6425: typical example looks like this:</p>
                   6426: <pre class="programlisting">
                   6427: pkgbase := libpurple
                   6428: .include "../../mk/pkg-build-options.mk"
                   6429: 
                   6430: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6431: ...
                   6432: .endif
                   6433: </pre>
                   6434: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6435: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6436: options of the libpurple package, which can then be queried like
                   6437: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6438: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6439: details.</p>
                   6440: </div>
1.1       dsieger  6441: </div>
1.23      wiz      6442: <div class="chapter" title="Chapter 17. The build process">
1.1       dsieger  6443: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6444: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6445: <div class="toc">
                   6446: <p><b>Table of Contents</b></p>
                   6447: <dl>
1.6       rillig   6448: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6449: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6450: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6451: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      6452: <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   6453: <dd><dl>
                   6454: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6455: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6456: </dl></dd>
1.23      wiz      6457: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6458: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6459: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6460: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6461: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6462: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6463: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6464: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6465: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6466: <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   6467: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6468: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6469: </dl>
                   6470: </div>
1.23      wiz      6471: <div class="sect1" title="17.1. Introduction">
1.1       dsieger  6472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6473: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6474: <p>This chapter gives a detailed description on how a package is
                   6475:     built. Building a package is separated into different
                   6476:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6477:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      6478:     described in the following sections. Each phase is split into
1.1       dsieger  6479:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6480:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6481:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6482:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6483:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6484: <p>Never override the regular targets (like
                   6485:     <code class="varname">fetch</code>), if you have to, override the
                   6486:     <code class="varname">do-*</code> ones instead.</p>
                   6487: <p>The basic steps for building a program are always the same.  First
                   6488:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6489:     the local system and then extracted. After any pkgsrc-specific patches
                   6490:     to compile properly are applied, the software can be configured, then
                   6491:     built (usually by compiling), and finally the generated binaries, etc.
                   6492:     can be put into place on the system.</p>
                   6493: <p>To get more details about what is happening at each step,
                   6494:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6495:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6496:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6497: </div>
1.23      wiz      6498: <div class="sect1" title="17.2. Program location">
1.1       dsieger  6499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6500: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6501: <p>Before outlining the process performed by the NetBSD package system in
                   6502:     the next section, here's a brief discussion on where programs are
                   6503:     installed, and which variables influence this.</p>
                   6504: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6505:     where all files of the final program shall be installed. It is
                   6506:     usually set to <code class="varname">LOCALBASE</code>
                   6507:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6508:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6509:     <code class="varname">PREFIX</code> needs to be put
                   6510:     into the various places in the program's source where paths to
1.10      hubertf  6511:     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  6512: <p>When choosing which of these variables to use,
                   6513:     follow the following rules:</p>
1.23      wiz      6514: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   6515: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  6516:        where the current pkg will be installed.  When referring to a
                   6517:        pkg's own installation path, use
1.23      wiz      6518:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6519: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  6520:        are installed.  If you need to construct a -I or -L argument
                   6521:        to the compiler to find includes and libraries installed by
1.23      wiz      6522:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  6523:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6524:        installed all packages in <code class="filename">/usr/local</code>. As
                   6525:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6526:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      6527: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  6528:        distribution (from xsrc, etc.) is installed. When looking for
                   6529:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      6530:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   6531: <li class="listitem">
1.1       dsieger  6532: <p>X11-based packages are special in that they may be
                   6533:        installed in either <code class="varname">X11BASE</code> or
                   6534:        <code class="varname">LOCALBASE</code>.</p>
                   6535: <p>Usually, X11 packages should be installed under
                   6536:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6537:        will need to include
                   6538:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6539:        request the presence of X11 and to get the right compilation
                   6540:        flags.</p>
                   6541: <p>Even though, there are some packages that cannot be installed
                   6542:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6543:        files. These packages are special and they must be placed under
                   6544:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6545:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6546:        your package.</p>
                   6547: <p>Some notes: If you need
                   6548:        to find includes or libraries installed by a pkg that has
                   6549:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6550:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6551:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6552:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6553:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6554:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6555:        is enabled by default.</p>
                   6556: </li>
1.23      wiz      6557: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1       dsieger  6558:        the installed location of an X11
                   6559:        package. <code class="varname">X11PREFIX</code> will be set to
                   6560:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6561:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6562:        installed.</p></li>
1.23      wiz      6563: <li class="listitem">
1.1       dsieger  6564: <p>If xpkgwedge is installed, it is possible to have some
                   6565:        packages installed in <code class="varname">X11BASE</code> and some in
                   6566:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6567:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6568:        definition can be used. It takes pairs in the format
1.29      dholland 6569:        <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  6570:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6571:        of the installed package &lt;package&gt;, or
1.23      wiz      6572:        <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
1.1       dsieger  6573:        installed.</p>
                   6574: <p>This is best illustrated by example.</p>
                   6575: <p>The following lines are taken from
                   6576:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6577: <pre class="programlisting">
                   6578: EVAL_PREFIX+=           GTKDIR=gtk+
                   6579: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6580: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6581: CONFIGURE_ARGS+=        --enable-multibyte
                   6582: </pre>
                   6583: <p>Specific defaults can be defined for the packages
                   6584:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6585:        definition of the form:</p>
                   6586: <pre class="programlisting">
                   6587: GTKDIR_DEFAULT= ${LOCALBASE}
                   6588: </pre>
                   6589: <p>where <code class="varname">GTKDIR</code> corresponds
                   6590:        to the first definition in
                   6591:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6592: </li>
1.23      wiz      6593: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29      dholland 6594:        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  6595:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6596:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6597: </ul></div>
                   6598: </div>
1.23      wiz      6599: <div class="sect1" title="17.3. Directories used during the build process">
1.1       dsieger  6600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6601: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 6602: <p>When building a package, various directories are used to store
1.1       dsieger  6603:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6604:     directories are explained here.</p>
                   6605: <p>Some of the directory variables contain relative pathnames. There
                   6606:     are two common base directories for these relative directories:
                   6607:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6608:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6609:     inside the package itself.</p>
                   6610: <div class="variablelist"><dl>
                   6611: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6612: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6613:       root directory. Generally, you don't need
                   6614:       it.</p></dd>
                   6615: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6616: <dd><p>This is an absolute pathname that points to the
                   6617:       current package.</p></dd>
                   6618: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6619: <dd><p>This is a pathname relative to
                   6620:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6621:       package.</p></dd>
                   6622: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6623: <dd><p>This is an absolute pathname pointing to the directory
                   6624:       where all work takes place. The distfiles are extracted to this
                   6625:       directory. It also contains temporary directories and log files used by
                   6626:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6627:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6628: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6629: <dd><p>This is an absolute pathname pointing to the directory
                   6630:       where the distfiles are extracted. It is usually a direct subdirectory
                   6631:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6632:       that isn't hidden. This variable may be changed by a package
                   6633:       <code class="filename">Makefile</code>.</p></dd>
                   6634: </dl></div>
1.14      jmcneill 6635: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6636:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   6637:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 6638:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6639:     If users would like to have their pkgsrc trees behave in a
                   6640:     read-only manner, then the value of
                   6641:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6642:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  6643: </div>
1.23      wiz      6644: <div class="sect1" title="17.4. Running a phase">
1.1       dsieger  6645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6646: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  6647: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  6648:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6649:     phase. This will automatically run all phases that are required for this
                   6650:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  6651:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  6652:     the package will be built, but not installed.</p>
                   6653: </div>
1.23      wiz      6654: <div class="sect1" title="17.5. The fetch phase">
1.1       dsieger  6655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6656: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6657: <p>The first step in building a package is to fetch the
                   6658:     distribution files (distfiles) from the sites that are providing
                   6659:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6660:     phase.</p>
1.23      wiz      6661: <div class="sect2" title="17.5.1. What to fetch and where to get it from">
1.1       dsieger  6662: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6663: <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  6664: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6665:       defines all URLs from where the distfile, whose name is
                   6666:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6667:       fetched. The more complicated cases are described
                   6668:       below.</p>
                   6669: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6670:       the list of distfiles that have to be fetched. Its value
                   6671:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6672:       so that most packages don't need to define it at all.
                   6673:       <code class="varname">EXTRACT_SUFX</code> is
                   6674:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6675:       freely. Note that if your package requires additional
                   6676:       distfiles to the default one, you cannot just append the
                   6677:       additional filenames using the <code class="literal">+=</code>
                   6678:       operator, but you have write for example:</p>
                   6679: <pre class="programlisting">
                   6680: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6681: </pre>
                   6682: <p>Each distfile is fetched from a list of sites, usually
                   6683:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6684:       <code class="varname">DISTFILES</code> or multiple
                   6685:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6686:       set
                   6687:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6688:       to the list of URLs where the file
                   6689:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6690:       (including the suffix) can be found.</p>
                   6691: <pre class="programlisting">
                   6692: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6693: DISTFILES+=     foo-file.tar.gz
                   6694: SITES.foo-file.tar.gz= \
                   6695: http://www.somewhere.com/somehow/ \
                   6696: http://www.somewhereelse.com/mirror/somehow/
                   6697: </pre>
                   6698: <p>When actually fetching the distfiles, each item from
                   6699:       <code class="varname">MASTER_SITES</code> or
                   6700:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6701:       appended to it, without an intermediate slash. Therefore,
                   6702:       all site values have to end with a slash or other separator
                   6703:       character. This allows for example to set
                   6704:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6705:       that gets the name of the distfile as a parameter. In this
                   6706:       case, the definition would look like:</p>
                   6707: <pre class="programlisting">
                   6708: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6709: </pre>
1.22      jakllsch 6710: <p> The exception to this rule are URLs starting with a dash.
                   6711:       In that case the URL is taken as is, fetched and the result stored
                   6712:       under the name of the distfile.</p>
1.1       dsieger  6713: <p>There are some predefined values for
                   6714:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6715:       packages.  The names of the variables should speak for
                   6716:       themselves.</p>
                   6717: <pre class="programlisting">
                   6718: ${MASTER_SITE_APACHE}
                   6719: ${MASTER_SITE_BACKUP}
                   6720: ${MASTER_SITE_CYGWIN}
                   6721: ${MASTER_SITE_DEBIAN}
                   6722: ${MASTER_SITE_FREEBSD}
                   6723: ${MASTER_SITE_FREEBSD_LOCAL}
                   6724: ${MASTER_SITE_GENTOO}
                   6725: ${MASTER_SITE_GNOME}
                   6726: ${MASTER_SITE_GNU}
                   6727: ${MASTER_SITE_GNUSTEP}
                   6728: ${MASTER_SITE_IFARCHIVE}
                   6729: ${MASTER_SITE_KDE}
                   6730: ${MASTER_SITE_MOZILLA}
                   6731: ${MASTER_SITE_MYSQL}
                   6732: ${MASTER_SITE_OPENOFFICE}
                   6733: ${MASTER_SITE_PERL_CPAN}
                   6734: ${MASTER_SITE_PGSQL}
                   6735: ${MASTER_SITE_R_CRAN}
                   6736: ${MASTER_SITE_SOURCEFORGE}
                   6737: ${MASTER_SITE_SOURCEFORGE_JP}
                   6738: ${MASTER_SITE_SUNSITE}
                   6739: ${MASTER_SITE_SUSE}
                   6740: ${MASTER_SITE_TEX_CTAN}
                   6741: ${MASTER_SITE_XCONTRIB}
                   6742: ${MASTER_SITE_XEMACS}
                   6743: </pre>
                   6744: <p>Some explanations for the less self-explaining ones:
                   6745:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6746:       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      6747:       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  6748: <p>If you choose one of these predefined sites, you may
                   6749:       want to specify a subdirectory of that site. Since these
                   6750:       macros may expand to more than one actual site, you
                   6751:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6752:       specify a subdirectory:</p>
                   6753: <pre class="programlisting">
                   6754: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6755: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6756: </pre>
                   6757: <p>Note the trailing slash after the subdirectory
                   6758:       name.</p>
                   6759: </div>
1.23      wiz      6760: <div class="sect2" title="17.5.2. How are the files fetched?">
1.1       dsieger  6761: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6762: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6763: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6764:       all the distfiles exist in a local directory
                   6765:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6766:       user). If the files do not exist, they are fetched using
                   6767:       commands of the form</p>
                   6768: <pre class="programlisting">
                   6769: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6770: </pre>
                   6771: <p>where <code class="literal">${site}</code> varies through
                   6772:       several possibilities in turn: first,
                   6773:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6774:       sites specified in either <code class="varname">SITES.file</code> if
                   6775:       defined, else <code class="varname">MASTER_SITES</code> or
                   6776:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6777:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6778:       all except the first and the last can be optionally sorted
                   6779:       by the user, via setting either
                   6780:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6781:       <code class="varname">MASTER_SORT_AWK</code> or
                   6782:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6783: <p> The specific command and arguments used depend on the
                   6784:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6785:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6786: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6787:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6788:       distfiles, if they are freely distributable.  Packages setting
                   6789:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6790:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6791:       mirrored.</p>
                   6792: </div>
                   6793: </div>
1.23      wiz      6794: <div class="sect1" title="17.6. The checksum phase">
1.1       dsieger  6795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6796: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6797: <p>After the distfile(s) are fetched, their checksum is
                   6798:     generated and compared with the checksums stored in the
                   6799:     distinfo file. If the checksums don't match, the build is
                   6800:     aborted. This is to ensure the same distfile is used for
                   6801:     building, and that the distfile wasn't changed, e.g. by some
                   6802:     malign force, deliberately changed distfiles on the master
                   6803:     distribution site or network lossage.</p>
                   6804: </div>
1.23      wiz      6805: <div class="sect1" title="17.7. The extract phase">
1.1       dsieger  6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6807: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6808: <p>When the distfiles are present on the local system, they
                   6809:     need to be extracted, as they usually come in the form of some
                   6810:     compressed archive format.</p>
                   6811: <p>By default, all <code class="varname">DISTFILES</code> are
                   6812:     extracted. If you only need some of them, you can set the
                   6813:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6814:     files.</p>
                   6815: <p>Extracting the files is usually done by a little
                   6816:     program, <code class="filename">mk/extract/extract</code>, which
                   6817:     already knows how to extract various archive formats, so most
                   6818:     likely you will not need to change anything here. But if you
                   6819:     need, the following variables may help you:</p>
                   6820: <div class="variablelist"><dl>
                   6821: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6822: <dd><p>Use these variables to override the default
                   6823:       options for an extract command, which are defined in
                   6824:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6825: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6826: <dd><p>This variable can be set to
1.14      jmcneill 6827:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6828:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6829:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6830:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6831:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6832: </dl></div>
                   6833: <p>If the <code class="filename">extract</code> program doesn't
                   6834:     serve your needs, you can also override the
                   6835:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6836:     command used for extracting the files. This command is
                   6837:     executed in the <code class="filename">${WRKSRC}</code>
                   6838:     directory. During execution of this command, the shell
                   6839:     variable <code class="varname">extract_file</code> holds the absolute
                   6840:     pathname of the file that is going to be extracted.</p>
                   6841: <p>And if that still does not suffice, you can override the
                   6842:     <code class="varname">do-extract</code> target in the package
                   6843:     Makefile.</p>
                   6844: </div>
1.23      wiz      6845: <div class="sect1" title="17.8. The patch phase">
1.1       dsieger  6846: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6847: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6848: <p>After extraction, all the patches named by the
                   6849:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6850:     subdirectory of the package as well as in
                   6851:     $LOCALPATCHES/$PKGPATH (e.g.
                   6852:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6853:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6854:     <code class="filename">.gz</code> are uncompressed before they are
                   6855:     applied, files ending in <code class="filename">.orig</code> or
                   6856:     <code class="filename">.rej</code> are ignored. Any special options to
1.29      dholland 6857:     <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  6858:     <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 6859: <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  6860:     it fail if the patches apply with some lines of fuzz. Please
                   6861:     fix (regen) the patches so that they apply cleanly. The
                   6862:     rationale behind this is that patches that don't apply cleanly
                   6863:     may end up being applied in the wrong place, and cause severe
                   6864:     harm there.</p>
                   6865: </div>
1.23      wiz      6866: <div class="sect1" title="17.9. The tools phase">
1.1       dsieger  6867: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6868: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6869: <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  6870:     </p>
                   6871: </div>
1.23      wiz      6872: <div class="sect1" title="17.10. The wrapper phase">
1.1       dsieger  6873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6874: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6875: <p>This phase creates wrapper programs for the compilers and
                   6876:     linkers. The following variables can be used to tweak the
                   6877:     wrappers.</p>
                   6878: <div class="variablelist"><dl>
                   6879: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6880: <dd><p>The command used to print progress
                   6881:       messages. Does nothing by default. Set to
                   6882:       <code class="literal">${ECHO}</code> to see the progress
                   6883:       messages.</p></dd>
                   6884: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6885: <dd><p>This variable can be set to
                   6886:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6887:       depending on whether you want additional information in the
                   6888:       wrapper log file.</p></dd>
                   6889: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6890: <dd><p>This variable can be set to
                   6891:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6892:       on whether the wrapper should use its cache, which will
                   6893:       improve the speed. The default value is
                   6894:       <code class="literal">yes</code>, but is forced to
                   6895:       <code class="literal">no</code> if the platform does not support
                   6896:       it.</p></dd>
                   6897: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6898: <dd><p>A list of reordering commands. A reordering
                   6899:       command has the form
                   6900:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6901:       It ensures that that
                   6902:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6903:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6904:       </p></dd>
                   6905: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6906: <dd><p>A list of transformation commands. [TODO:
                   6907:       investigate further]</p></dd>
                   6908: </dl></div>
                   6909: </div>
1.23      wiz      6910: <div class="sect1" title="17.11. The configure phase">
1.1       dsieger  6911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6912: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6913: <p>Most pieces of software need information on the header
                   6914:     files, system calls, and library routines which are available
                   6915:     on the platform they run on. The process of determining this
                   6916:     information is known as configuration, and is usually
                   6917:     automated. In most cases, a script is supplied with the
                   6918:     distfiles, and its invocation results in generation of header
                   6919:     files, Makefiles, etc.</p>
                   6920: <p>If the package contains a configure script, this can be
                   6921:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6922:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6923:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6924:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6925:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6926: <pre class="programlisting">
                   6927: .for d in ${CONFIGURE_DIRS}
                   6928:         cd ${WRKSRC} \
                   6929:         &amp;&amp; cd ${d} \
                   6930:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6931: .endfor
                   6932: </pre>
                   6933: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6934:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6935:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6936:     configure script is run with the environment
                   6937:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6938:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6939:     <code class="varname">CONFIGURE_ENV</code>,
                   6940:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6941:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6942:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6943:     package.</p>
                   6944: <p>If the program uses an <code class="filename">Imakefile</code>
                   6945:     for configuration, the appropriate steps can be invoked by
                   6946:     setting <code class="varname">USE_IMAKE</code> to
1.23      wiz      6947:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
1.1       dsieger  6948:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   6949:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   6950:     xmkmf's environment by adding them to the
                   6951:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6952: <p>If the program uses <code class="filename">cmake</code>
                   6953:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6954:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6955:     You can add variables to cmake's environment by adding them to the
                   6956:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6957:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6958:     The top directory argument is given by the
                   6959:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6960:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6961: <p>If there is no configure step at all, set
1.23      wiz      6962:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6963: </div>
1.23      wiz      6964: <div class="sect1" title="17.12. The build phase">
1.1       dsieger  6965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6966: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6967: <p>For building a package, a rough equivalent of the
                   6968:     following code is executed.</p>
                   6969: <pre class="programlisting">
                   6970: .for d in ${BUILD_DIRS}
                   6971:         cd ${WRKSRC} \
                   6972:         &amp;&amp; cd ${d} \
                   6973:         &amp;&amp; env ${MAKE_ENV} \
                   6974:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6975:                 -f ${MAKE_FILE} \
                   6976:                 ${BUILD_TARGET}
                   6977: .endfor
                   6978: </pre>
                   6979: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6980:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6981:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6982:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6983:     <code class="varname">MAKE_ENV</code> and arguments
                   6984:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6985:     <code class="varname">MAKE_ENV</code>,
                   6986:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6987:     <code class="varname">MAKE_FILE</code> and
                   6988:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6989:     package.</p>
                   6990: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      6991:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6992:     <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  6993:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      6994:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6995:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  6996: <p>If there is no build step at all, set
1.23      wiz      6997:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6998: </div>
1.23      wiz      6999: <div class="sect1" title="17.13. The test phase">
1.1       dsieger  7000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7001: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  7002: <p>[TODO]</p>
                   7003: </div>
1.23      wiz      7004: <div class="sect1" title="17.14. The install phase">
1.1       dsieger  7005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7006: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  7007: <p>Once the build stage has completed, the final step is to
                   7008:     install the software in public directories, so users can
                   7009:     access the programs and files.</p>
                   7010: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   7011:     equivalent of the following code is executed. Additionally,
                   7012:     before and after this code, much magic is performed to do
                   7013:     consistency checks, registering the package, and so on.</p>
                   7014: <pre class="programlisting">
                   7015: .for d in ${INSTALL_DIRS}
                   7016:         cd ${WRKSRC} \
                   7017:         &amp;&amp; cd ${d} \
                   7018:         &amp;&amp; env ${MAKE_ENV} \
                   7019:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7020:                 -f ${MAKE_FILE} \
                   7021:                 ${INSTALL_TARGET}
                   7022: .endfor
                   7023: </pre>
                   7024: <p>The variable's meanings are analogous to the ones in the
                   7025:     <span class="emphasis"><em>build</em></span> phase.
                   7026:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7027:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      7028:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   7029:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  7030:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7031:     defined.</p>
                   7032: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   7033:     variables are useful. They are all variations of the
1.29      dholland 7034:     <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  7035:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7036:     install command. The specialized variants, together with their
                   7037:     intended use, are:</p>
                   7038: <div class="variablelist"><dl>
                   7039: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   7040: <dd><p>directories that contain
                   7041:       binaries</p></dd>
                   7042: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   7043: <dd><p>directories that contain
                   7044:       scripts</p></dd>
                   7045: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   7046: <dd><p>directories that contain shared and static
                   7047:       libraries</p></dd>
                   7048: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   7049: <dd><p>directories that contain data
                   7050:       files</p></dd>
                   7051: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   7052: <dd><p>directories that contain man
                   7053:       pages</p></dd>
                   7054: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   7055: <dd><p>binaries that can be stripped from debugging
                   7056:       symbols</p></dd>
                   7057: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   7058: <dd><p>binaries that cannot be
                   7059:       stripped</p></dd>
                   7060: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   7061: <dd><p>game
                   7062:       binaries</p></dd>
                   7063: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   7064: <dd><p>shared and static
                   7065:       libraries</p></dd>
                   7066: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7067: <dd><p>data files</p></dd>
                   7068: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   7069: <dd><p>data files for
                   7070:       games</p></dd>
                   7071: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7072: <dd><p>man pages</p></dd>
                   7073: </dl></div>
                   7074: <p>Some other variables are:</p>
                   7075: <div class="variablelist"><dl>
                   7076: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7077: <dd><p>A list of directories relative to
                   7078:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   7079:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7080:       The package is supposed to create all needed directories itself
                   7081:       before installing files to it and list all other directories here.
                   7082:       </p></dd>
                   7083: </dl></div>
                   7084: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      7085:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  7086:     mostly relevant for packages in the <code class="filename">regress</code>
                   7087:     category.</p>
                   7088: </div>
1.23      wiz      7089: <div class="sect1" title="17.15. The package phase">
1.1       dsieger  7090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7091: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  7092: <p>Once the install stage has completed, a binary package of
                   7093:     the installed files can be built.  These binary packages can be
                   7094:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  7095:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7096:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  7097: <p>By default, the binary packages are created in
                   7098:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7099:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7100:     one for each category in the <code class="varname">CATEGORIES</code>
                   7101:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7102:     <code class="filename">pkgsrc/packages</code>.</p>
                   7103: </div>
1.23      wiz      7104: <div class="sect1" title="17.16. Cleaning up">
1.1       dsieger  7105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7106: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  7107: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  7108:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  7109:     to clean the work directories of all dependencies too, use
1.10      hubertf  7110:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  7111: </div>
1.23      wiz      7112: <div class="sect1" title="17.17. Other helpful targets">
1.1       dsieger  7113: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7114: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1       dsieger  7115: <div class="variablelist"><dl>
                   7116: <dt><span class="term">pre/post-*</span></dt>
                   7117: <dd><p>For any of the main targets described in the
                   7118:          previous section, two auxiliary targets exist with
1.23      wiz      7119:          <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  7120:          prefix for the main target's name.  These targets are
                   7121:          invoked before and after the main target is called,
                   7122:          allowing extra configuration or installation steps be
                   7123:          performed from a package's Makefile, for example, which
                   7124:          a program's configure script or install target
                   7125:          omitted.</p></dd>
                   7126: <dt><span class="term">do-*</span></dt>
                   7127: <dd><p>Should one of the main targets do the wrong thing,
                   7128:          and should there be no variable to fix this, you can
                   7129:          redefine it with the do-* target.  (Note that redefining
                   7130:          the target itself instead of the do-* target is a bad
                   7131:          idea, as the pre-* and post-* targets won't be called
                   7132:          anymore, etc.) You will not usually need to do
                   7133:          this.</p></dd>
                   7134: <dt><span class="term">reinstall</span></dt>
                   7135: <dd>
1.10      hubertf  7136: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  7137:          you noticed some file was not installed properly, you
                   7138:          can repeat the installation with this target, which will
1.23      wiz      7139:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  7140: <p>This is the default value of
                   7141:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  7142:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  7143:          package</strong></span>, where the defaults are
1.23      wiz      7144:          <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  7145:          respectively.</p>
                   7146: </dd>
                   7147: <dt><span class="term">deinstall</span></dt>
                   7148: <dd>
1.29      dholland 7149: <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  7150:          current directory, effectively de-installing the
                   7151:          package. The following variables can be used to tune the
                   7152:          behaviour:</p>
                   7153: <div class="variablelist"><dl>
                   7154: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29      dholland 7155: <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  7156: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7157: <dd><p>Remove all packages that require (depend on)
                   7158:                the given package.  This can be used to remove any
                   7159:                packages that may have been pulled in by a given
1.10      hubertf  7160:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  7161:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7162:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7163:                likely to remove whole KDE. Works by adding
1.29      dholland 7164:                <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  7165:                command line.</p></dd>
                   7166: </dl></div>
                   7167: </dd>
                   7168: <dt><span class="term">bin-install</span></dt>
                   7169: <dd><p>Install a binary package from local disk and via FTP
                   7170:          from a list of sites (see the
                   7171:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  7172:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  7173:          available anywhere.  The arguments given to
1.10      hubertf  7174:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  7175:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7176:          operation, etc.</p></dd>
                   7177: <dt><span class="term">update</span></dt>
                   7178: <dd>
                   7179: <p>This target causes the current package to be
                   7180:          updated to the latest version.  The package and all
                   7181:          depending packages first get de-installed, then current
                   7182:          versions of the corresponding packages get compiled and
                   7183:          installed.  This is similar to manually noting which
                   7184:          packages are currently installed, then performing a
1.10      hubertf  7185:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7186:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  7187:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7188:          packages.</p>
1.23      wiz      7189: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  7190:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  7191:          update</strong></span> was interrupted for some reason.
                   7192:          However, in this case, make sure you don't call
1.10      hubertf  7193:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  7194:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7195:          Otherwise, you lose the ability to automatically update
                   7196:          the current package along with the dependent packages
                   7197:          you have installed.</p>
1.10      hubertf  7198: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  7199:          update</strong></span> will only work as long as the package
                   7200:          tree remains unchanged.  If the source code for one of
                   7201:          the packages to be updated has been changed, resuming
1.10      hubertf  7202:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  7203:          fail!</p>
                   7204: <p>The following variables can be used either on the
1.10      hubertf  7205:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7206:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  7207:          update</strong></span>:</p>
                   7208: <div class="variablelist"><dl>
                   7209: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7210: <dd><p>Install target to recursively use for the
                   7211:                updated package and the dependent packages.
                   7212:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      7213:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  7214:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      7215:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   7216:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   7217:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  7218:                endless loop!</p></dd>
                   7219: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7220: <dd><p>Don't clean up after updating.  Useful if
                   7221:                you want to leave the work sources of the updated
                   7222:                packages around for inspection or other purposes.
                   7223:                Be sure you eventually clean up the source tree
1.23      wiz      7224:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  7225:                or you may run into troubles with old source code
                   7226:                still lying around on your next
1.10      hubertf  7227:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  7228:                update</strong></span>.</p></dd>
                   7229: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7230: <dd><p>Deinstall each package before installing
                   7231:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7232:                may be necessary if the
1.23      wiz      7233:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  7234:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  7235:                update</strong></span>.</p></dd>
                   7236: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7237: <dd><p>Allows you to disable recursion and hardcode
                   7238:                the target for packages.  The default is
1.23      wiz      7239:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  7240:                facilitating a recursive update of prerequisite
                   7241:                packages.  Only set
                   7242:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7243:                disable recursive updates. Use
                   7244:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7245:                set a specific target for each package to be
1.10      hubertf  7246:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  7247:                (see above).</p></dd>
                   7248: </dl></div>
                   7249: </dd>
                   7250: <dt><span class="term">clean-update</span></dt>
                   7251: <dd>
                   7252: <p>Clean the source tree for all packages that would
1.10      hubertf  7253:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  7254:          from the current directory.  This target should not be
                   7255:          used if the current package (or any of its depending
                   7256:          packages) have already been de-installed (e.g., after
1.10      hubertf  7257:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  7258:          some packages you intended to update. As a rule of
                   7259:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  7260:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  7261:          and only if you have a dirty package tree (e.g., if you
                   7262:          used <code class="varname">NOCLEAN</code>).</p>
                   7263: <p>If you are unsure about whether your tree is
1.10      hubertf  7264:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  7265:          clean</strong></span> at the top of the tree, or use the
                   7266:          following sequence of commands from the directory of the
                   7267:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  7268:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  7269:          time, otherwise you lose all the packages you wanted to
                   7270:          update!):</p>
                   7271: <pre class="screen">
                   7272: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7273: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7274: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7275:          </pre>
                   7276: <p>The following variables can be used either on the
1.10      hubertf  7277:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7278:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.1       dsieger  7279: <div class="variablelist"><dl>
                   7280: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  7281: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  7282:                reconstruct the list of directories to update for
1.10      hubertf  7283:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  7284:                update</strong></span> successfully installed all
                   7285:                packages you wanted to update.  Normally, this is
1.10      hubertf  7286:                done automatically on <span class="command"><strong>make
1.1       dsieger  7287:                update</strong></span>, but may have been suppressed by
                   7288:                the <code class="varname">NOCLEAN</code> variable (see
                   7289:                above).</p></dd>
                   7290: </dl></div>
                   7291: </dd>
                   7292: <dt><span class="term">replace</span></dt>
                   7293: <dd>
                   7294: <p>Update the installation of the current package.  This
                   7295:          differs from update in that it does not replace dependent
                   7296:          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
                   7297:          target to work.</p>
                   7298: <p><span class="emphasis"><em>Be careful when using this
                   7299:          target!</em></span> There are no guarantees that dependent
                   7300:          packages will still work, in particular they will most
1.10      hubertf  7301:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  7302:          library package whose shared library major version changed
                   7303:          between your installed version and the new one.  For this
                   7304:          reason, this target is not officially supported and only
                   7305:          recommended for advanced users.</p>
                   7306: </dd>
                   7307: <dt><span class="term">info</span></dt>
1.29      dholland 7308: <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  7309:          package. You can use this to check which version of a
                   7310:          package is installed.</p></dd>
                   7311: <dt><span class="term">index</span></dt>
                   7312: <dd>
                   7313: <p>This is a top-level command, i.e. it should be used in
                   7314:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7315:          database of all packages in the local pkgsrc tree, including
                   7316:          dependencies, comment, maintainer, and some other useful
                   7317:          information.  Individual entries are created by running
1.10      hubertf  7318:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  7319:          directories.  This index file is saved as
                   7320:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  7321:          verbose format by running <span class="command"><strong>make
1.1       dsieger  7322:          print-index</strong></span>.  You can search in it with
1.10      hubertf  7323:          <span class="command"><strong>make search
1.1       dsieger  7324:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7325:          extract a list of all packages that depend on a particular
1.10      hubertf  7326:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  7327:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7328: <p>Running this command takes a very long time, some
                   7329:          hours even on fast machines!</p>
                   7330: </dd>
                   7331: <dt><span class="term">readme</span></dt>
                   7332: <dd>
                   7333: <p>This target generates a
                   7334:          <code class="filename">README.html</code> file, which can be
                   7335:          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
                   7336:          contain references to any packages which are in the
                   7337:          <code class="varname">PACKAGES</code> directory on the local
                   7338:          host. The generated files can be made to refer to URLs
                   7339:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7340:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7341:          wanted to generate <code class="filename">README.html</code>
                   7342:          files which pointed to binary packages on the local
                   7343:          machine, in the directory
                   7344:          <code class="filename">/usr/packages</code>, set
                   7345:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7346:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7347:          <code class="varname">${PACKAGES}</code> directory and its
                   7348:          subdirectories will be searched for all the binary
                   7349:          packages.</p>
                   7350: <p>The target can be run at the toplevel or in category
                   7351:          directories, in which case it descends recursively.</p>
                   7352: </dd>
                   7353: <dt><span class="term">readme-all</span></dt>
                   7354: <dd><p>This is a top-level command, run it in
                   7355:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7356:          file <code class="filename">README-all.html</code> which contains a
                   7357:          list of all packages currently available in the NetBSD
                   7358:          Packages Collection, together with the category they belong
                   7359:          to and a short description. This file is compiled from the
                   7360:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  7361:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  7362:          readme</strong></span>.</p></dd>
                   7363: <dt><span class="term">cdrom-readme</span></dt>
                   7364: <dd><p>This is very much the same as the
1.23      wiz      7365:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  7366:          used when generating a pkgsrc tree to be written to a
                   7367:          CD-ROM.  This target also produces
                   7368:          <code class="filename">README.html</code> files, and can be made
                   7369:          to refer to URLs based on
                   7370:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7371:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7372: <dt><span class="term">show-distfiles</span></dt>
                   7373: <dd><p>This target shows which distfiles and patchfiles
                   7374:          are needed to build the package
                   7375:          (<code class="varname">ALLFILES</code>, which contains all
                   7376:          <code class="varname">DISTFILES</code> and
                   7377:          <code class="varname">PATCHFILES</code>, but not
                   7378:          <code class="filename">patches/*</code>).</p></dd>
                   7379: <dt><span class="term">show-downlevel</span></dt>
                   7380: <dd><p>This target shows nothing if the package is not
                   7381:          installed. If a version of this package is installed,
                   7382:          but is not the version provided in this version of
                   7383:          pkgsrc, then a warning message is displayed. This target
                   7384:          can be used to show which of your installed packages are
                   7385:          downlevel, and so the old versions can be deleted, and
                   7386:          the current ones added.</p></dd>
                   7387: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7388: <dd><p>This target shows the directory in the pkgsrc
                   7389:          hierarchy from which the package can be built and
                   7390:          installed. This may not be the same directory as the one
                   7391:          from which the package was installed. This target is
                   7392:          intended to be used by people who may wish to upgrade
                   7393:          many packages on a single host, and can be invoked from
                   7394:          the top-level pkgsrc Makefile by using the
1.23      wiz      7395:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  7396: <dt><span class="term">show-installed-depends</span></dt>
                   7397: <dd><p>This target shows which installed packages match
                   7398:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7399:          if out of date dependencies are causing build
                   7400:          problems.</p></dd>
                   7401: <dt><span class="term">check-shlibs</span></dt>
                   7402: <dd><p>After a package is installed, check all its
                   7403:          binaries and (on ELF platforms) shared libraries to see
                   7404:          if they find the shared libs they need.  Run by default
1.10      hubertf  7405:          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  7406: <dt><span class="term">print-PLIST</span></dt>
                   7407: <dd>
1.23      wiz      7408: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  7409:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  7410:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  7411:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7412:          to care for shared libs etc., but it is
                   7413:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7414:          result before putting it into
                   7415:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7416:          diff the output of this command against an already
                   7417:          existing <code class="filename">PLIST</code> file.</p>
1.29      dholland 7418: <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  7419:          other methods that don't update file access times, be
                   7420:          sure to add these files manually to your
1.23      wiz      7421:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7422:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  7423:          them!</p>
1.23      wiz      7424: <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  7425:          information on this target.</p>
                   7426: </dd>
                   7427: <dt><span class="term">bulk-package</span></dt>
                   7428: <dd>
                   7429: <p>Used to do bulk builds. If an appropriate binary
                   7430:          package already exists, no action is taken. If not, this
                   7431:          target will compile, install and package it (and its
                   7432:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10      hubertf  7433:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7434:          After creating the binary package, the sources, the
                   7435:          just-installed package and its required packages are
                   7436:          removed, preserving free disk space.</p>
                   7437: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7438:          all packages installed on a system!</em></span></p>
                   7439: </dd>
                   7440: <dt><span class="term">bulk-install</span></dt>
                   7441: <dd>
                   7442: <p>Used during bulk-installs to install required
                   7443:          packages. If an up-to-date binary package is available,
1.29      dholland 7444:          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  7445:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  7446:          but the installed binary won't be removed.</p>
                   7447: <p>A binary package is considered
1.23      wiz      7448:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.29      dholland 7449:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.23      wiz      7450: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7451: <li class="listitem"><p>None of the package's files
1.1       dsieger  7452:              (<code class="filename">Makefile</code>, ...) were modified
                   7453:              since it was built.</p></li>
1.23      wiz      7454: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  7455:              packages were modified since it was built.</p></li>
                   7456: </ul></div>
                   7457: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7458:          all packages installed on a system!</em></span></p>
                   7459: </dd>
                   7460: </dl></div>
                   7461: </div>
                   7462: </div>
1.23      wiz      7463: <div class="chapter" title="Chapter 18. Tools needed for building or running">
1.1       dsieger  7464: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7465: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7466: <div class="toc">
                   7467: <p><b>Table of Contents</b></p>
                   7468: <dl>
1.6       rillig   7469: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7470: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7471: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7472: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7473: </dl>
                   7474: </div>
                   7475: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7476: by pkgsrc and also for individual packages to define what commands
                   7477: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7478: or for later run-time of an installed packaged (such as
                   7479: <code class="varname">DEPENDS</code>).
                   7480: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7481: package will not be used.</p>
                   7482: <p>When building a package, the replacement tools are
                   7483: made available in a directory (as symlinks or wrapper scripts)
                   7484: that is early in the executable search path. Just like the buildlink
                   7485: system, this helps with consistent builds.</p>
                   7486: <p>A tool may be needed to help build a specific package. For example,
                   7487: perl, GNU make (gmake) or yacc may be needed.</p>
                   7488: <p>Also a tool may be needed, for example, because the native system's supplied
                   7489: tool may be inefficient for building a package with pkgsrc.
                   7490: For example, a package may need GNU awk, bison (instead of
                   7491: yacc) or a better sed.</p>
                   7492: <p>The tools used by a package can be listed by running
1.10      hubertf  7493: <span class="command"><strong>make show-tools</strong></span>.</p>
1.23      wiz      7494: <div class="sect1" title="18.1. Tools for pkgsrc builds">
1.1       dsieger  7495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7496: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7497: <p>The default set of tools used by pkgsrc is defined in
                   7498: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  7499: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7500: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  7501: These can be seen by running:
1.10      hubertf  7502: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  7503: <p>If a package needs a specific program to build
                   7504: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7505: to define the tools needed.</p>
                   7506: </div>
1.23      wiz      7507: <div class="sect1" title="18.2. Tools needed by packages">
1.1       dsieger  7508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7509: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      7510: <p>In the following examples, the :run means that it is needed at
                   7511: run-time (and becomes a DEPENDS).
1.1       dsieger  7512: The default is a build dependency which can be set with
                   7513: :build. (So in this example, it is the same as gmake:build
                   7514: and pkg-config:build.)</p>
                   7515: <pre class="programlisting">
                   7516: USE_TOOLS+=     gmake perl:run pkg-config
                   7517: </pre>
                   7518: <p>When using the tools framework, a
                   7519: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7520: which contains the full path to the appropriate tool. For example,
1.23      wiz      7521: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  7522: on Linux systems.</p>
                   7523: <p>If you always need a pkgsrc version of the
                   7524: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7525: </p>
                   7526: </div>
1.23      wiz      7527: <div class="sect1" title="18.3. Tools provided by platforms">
1.1       dsieger  7528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7529: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7530: <p>When improving or porting pkgsrc to a new platform, have a look
                   7531: at (or create) the corresponding platform specific make file fragment under
                   7532: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7533: the name of the common tools. For example:</p>
                   7534: <pre class="programlisting">
                   7535: .if exists(/usr/bin/bzcat)
                   7536: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7537: .elif exists(/usr/bin/bzip2)
                   7538: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7539: .endif
                   7540: 
                   7541: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7542: </pre>
                   7543: </div>
1.23      wiz      7544: <div class="sect1" title="18.4. Questions regarding the tools">
1.1       dsieger  7545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7546: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.23      wiz      7547: <div class="qandaset" title="Frequently Asked Questions">
1.34    ! wiz      7548: <a name="id1168229300016"></a><dl>
1.6       rillig   7549: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7550: </dt>
1.6       rillig   7551: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7552:        tools?</a>
                   7553: </dt>
1.6       rillig   7554: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7555:        package is using while being built? I want to know whether it
                   7556:        uses sed or not.</a>
                   7557: </dt>
                   7558: </dl>
1.23      wiz      7559: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  7560: <col align="left" width="1%">
1.23      wiz      7561: <col>
1.1       dsieger  7562: <tbody>
1.23      wiz      7563: <tr class="question" title="18.4.1.">
1.1       dsieger  7564: <td align="left" valign="top">
1.34    ! wiz      7565: <a name="tools.new"></a><a name="id1168229300020"></a><p><b>18.4.1.</b></p>
1.1       dsieger  7566: </td>
                   7567: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7568: </tr>
                   7569: <tr class="answer">
                   7570: <td align="left" valign="top"></td>
                   7571: <td align="left" valign="top"><p>TODO</p></td>
                   7572: </tr>
1.23      wiz      7573: <tr class="question" title="18.4.2.">
1.1       dsieger  7574: <td align="left" valign="top">
1.34    ! wiz      7575: <a name="tools.listall"></a><a name="id1168229300028"></a><p><b>18.4.2.</b></p>
1.1       dsieger  7576: </td>
                   7577: <td align="left" valign="top"><p>How do I get a list of all available
                   7578:        tools?</p></td>
                   7579: </tr>
                   7580: <tr class="answer">
                   7581: <td align="left" valign="top"></td>
                   7582: <td align="left" valign="top"><p>TODO</p></td>
                   7583: </tr>
1.23      wiz      7584: <tr class="question" title="18.4.3.">
1.1       dsieger  7585: <td align="left" valign="top">
1.34    ! wiz      7586: <a name="tools.used"></a><a name="id1168229300037"></a><p><b>18.4.3.</b></p>
1.1       dsieger  7587: </td>
                   7588: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7589:        package is using while being built? I want to know whether it
                   7590:        uses sed or not.</p></td>
                   7591: </tr>
                   7592: <tr class="answer">
                   7593: <td align="left" valign="top"></td>
                   7594: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7595:        to do it.)</p></td>
                   7596: </tr>
                   7597: </tbody>
                   7598: </table>
                   7599: </div>
                   7600: </div>
                   7601: </div>
1.23      wiz      7602: <div class="chapter" title="Chapter 19. Making your package work">
1.1       dsieger  7603: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7604: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7605: <div class="toc">
                   7606: <p><b>Table of Contents</b></p>
                   7607: <dl>
1.6       rillig   7608: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7609: <dd><dl>
1.6       rillig   7610: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23      wiz      7611: <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   7612: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7613: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7614: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7615: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7616: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7617: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7618: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7619: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7620: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7621: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7622: </dl></dd>
1.23      wiz      7623: <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   7624: <dd><dl>
                   7625: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7626: <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>
                   7627: </dl></dd>
1.23      wiz      7628: <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   7629: <dd><dl>
                   7630: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7631: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7632: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7633: </dl></dd>
                   7634: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7635: <dd><dl>
                   7636: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7637: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7638: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7639: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7640: </dl></dd>
1.23      wiz      7641: <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   7642: <dd><dl>
                   7643: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7644: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      7645: <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   7646: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7647: </dl></dd>
1.23      wiz      7648: <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   7649: <dd><dl>
                   7650: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7651: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7652: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7653: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7654: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7655: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7656: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7657: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7658: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      7659: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   7660: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7661: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7662: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7663: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7664: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7665: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7666: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7667: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7668:     emulation</a></span></dt>
1.6       rillig   7669: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7670: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7671: </dl></dd>
1.6       rillig   7672: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7673: </dl>
                   7674: </div>
1.23      wiz      7675: <div class="sect1" title="19.1. General operation">
1.1       dsieger  7676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7677: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.23      wiz      7678: <div class="sect2" title="19.1.1. Portability of packages">
1.1       dsieger  7679: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7680: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7681: <p>One appealing feature of pkgsrc is that it runs on many
                   7682:     different platforms. As a result, it is important to ensure,
                   7683:     where possible, that packages in pkgsrc are portable. This
                   7684:     chapter mentions some particular details you should pay
                   7685:     attention to while working on pkgsrc.</p>
                   7686: </div>
1.23      wiz      7687: <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
1.1       dsieger  7688: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  7689: <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  7690: </h3></div></div></div>
                   7691: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7692:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7693:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7694:     want to use those variables in the preprocessor directives of
1.29      dholland 7695:     <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  7696:     <code class="literal">.for</code>), you need to include the file
                   7697:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7698:     loads the user preferences.</p>
                   7699: <p>But note that some variables may not be completely defined
                   7700:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7701:     included, as they may contain references to variables that are
                   7702:     not yet defined. In shell commands this is no problem, since
                   7703:     variables are actually macros, which are only expanded when they
                   7704:     are used. But in the preprocessor directives mentioned above and
                   7705:     in dependency lines (of the form <code class="literal">target:
                   7706:     dependencies</code>) the variables are expanded at load
                   7707:     time.</p>
1.23      wiz      7708: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7709: <h3 class="title">Note</h3>
                   7710: <p>Currently there is no exhaustive list of all
                   7711:     variables that tells you whether they can be used at load time
                   7712:     or only at run time, but it is in preparation.</p>
                   7713: </div>
                   7714: </div>
1.23      wiz      7715: <div class="sect2" title="19.1.3. User interaction">
1.1       dsieger  7716: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7717: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7718: <p>Occasionally, packages require interaction from the user,
                   7719:     and this can be in a number of ways:</p>
1.23      wiz      7720: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7721: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7722:        interaction such as entering username/password or accepting a
                   7723:        license on a web page.</p></li>
1.23      wiz      7724: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7725:        passwords.</p></li>
1.23      wiz      7726: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7727: <li class="listitem"><p>help during the build process</p></li>
                   7728: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7729: </ul></div>
                   7730: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7731:     provided to notify the pkgsrc mechanism of an interactive stage
                   7732:     which will be needed, and this should be set in the package's
                   7733:     <code class="filename">Makefile</code>, e.g.:</p>
                   7734: <pre class="programlisting">
                   7735: INTERACTIVE_STAGE=      build
                   7736:     </pre>
                   7737: <p>Multiple interactive stages can be specified:</p>
                   7738: <pre class="programlisting">
                   7739: INTERACTIVE_STAGE=      configure install
                   7740:     </pre>
                   7741: <p>The user can then decide to skip this package by setting the
                   7742:     <code class="varname">BATCH</code> variable.</p>
                   7743: </div>
1.23      wiz      7744: <div class="sect2" title="19.1.4. Handling licenses">
1.1       dsieger  7745: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7746: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7747: <p>Authors of software can choose the licence under which
                   7748:     software can be copied.  This is due to copyright law, and reasons
                   7749:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7750:     system recognizes that there are a number of licenses which some
                   7751:     users may find objectionable or difficult or impossible to comply
                   7752:     with.  The Free Software Foundation has declared some licenses
                   7753:     "Free", and the Open Source Initiative has a definition of "Open
                   7754:     Source".  The pkgsrc system, as a policy choice, does not label
                   7755:     packages which have licenses that are Free or Open Source.
                   7756:     However, packages without a license meeting either of those tests
                   7757:     are labeled with a license tag denoting the license.  Note that a
                   7758:     package with no license to copy trivially does not meet either the
                   7759:     Free or Open Source test.</p>
                   7760: <p>For packages which are not Free or Open Source, pkgsrc will
                   7761:     not build the package unless the user has indicated to pkgsrc that
                   7762:     packages with that particular license may be built.  Note that
                   7763:     this documentation avoids the term "accepted the license".  The
                   7764:     pkgsrc system is merely providing a mechanism to avoid
                   7765:     accidentally building a package with a non-free license;
                   7766:     judgement and responsibility remain with the user.  (Installation
                   7767:     of binary packages are not currently subject to this mechanism;
                   7768:     this is a bug.)</p>
                   7769: <p>One might want to only install packages with a BSD license,
1.19      jnemeth  7770:     or the GPL, and not the other.  The free licenses are added to the 
                   7771:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7772:     user can override the default by setting the
                   7773:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7774:     of "+=".  The licenses accepted by default are:
                   7775:     </p>
                   7776: <pre class="programlisting">
1.32      wiz      7777:         public-domain unlicense
                   7778:         gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7779:         gnu-gpl-v1
                   7780:         gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7781:         gnu-gpl-v3 gnu-lgpl-v3
                   7782:         original-bsd modified-bsd 2-clause-bsd
                   7783:         x11 mit miros
                   7784:         apache-1.1 apache-2.0
                   7785:         artistic artistic-2.0
                   7786:         cddl-1.0
                   7787:         cpl-1.0
                   7788:         open-font-license
                   7789:         mpl-1.0 mpl-1.1 mpl-2.0
                   7790:         php png-license
                   7791:         postgresql-license
                   7792:         zlib
                   7793:         zpl
                   7794:         python-software-foundation
                   7795:         ipafont
                   7796:         ibm-public-license-1.0
                   7797:         isc
                   7798:         boost-license
                   7799:         mplusfont
                   7800:         cc-by-sa-v3.0
                   7801:         lppl-1.3c
                   7802:         lucent
                   7803:         epl-v1.0
                   7804:        info-zip
1.19      jnemeth  7805:     </pre>
                   7806: <p>
                   7807:     </p>
1.1       dsieger  7808: <p>The license tag mechanism is intended to address
                   7809:     copyright-related issues surrounding building, installing and
                   7810:     using a package, and not to address redistribution issues (see
                   7811:     <code class="varname">RESTRICTED</code> and
1.19      jnemeth  7812:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7813:     Packages with redistribution restrictions should set these
                   7814:     tags.</p>
1.1       dsieger  7815: <p>Denoting that a package may be copied according to a
                   7816:     particular license is done by placing the license in
                   7817:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7818:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7819:     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>
                   7820: <pre class="programlisting">
                   7821: LICENSE=        xv-license
                   7822:     </pre>
                   7823: <p>When trying to build, the user will get a notice that the
                   7824:     package is covered by a license which has not been placed in the
                   7825:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7826: <pre class="programlisting">
                   7827: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7828: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7829: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7830: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7831: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7832: *** Error code 1
                   7833:     </pre>
1.10      hubertf  7834: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7835:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7836:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7837:     convey to pkgsrc that it should not in the future fail because of
                   7838:     that license:</p>
                   7839: <pre class="programlisting">
                   7840: ACCEPTABLE_LICENSES+=xv-license
                   7841:     </pre>
                   7842: <p>When adding a package with a new license, the license text
                   7843:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7844:     displaying.  A list of known licenses can be seen in this
                   7845:     directory.</p>
                   7846: <p>When the license changes (in a way other than formatting),
                   7847:     please make sure that the new license has a different name (e.g.,
                   7848:     append the version number if it exists, or the date).  Just
                   7849:     because a user told pkgsrc to build programs under a previous
                   7850:     version of a license does not mean that pkgsrc should build
                   7851:     programs under the new licenses.  The higher-level point is that
                   7852:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7853:     test is a mechanistic test of whether a particular text has been
                   7854:     approved by either of two bodies.</p>
                   7855: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7856:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7857:     is deprecated because it does not crisply refer to a particular
                   7858:     license text.  Another problem with such usage is that it does not
                   7859:     enable a user to tell pkgsrc to proceed for a single package
                   7860:     without also telling pkgsrc to proceed for all packages with that
                   7861:     tag.</p>
                   7862: </div>
1.23      wiz      7863: <div class="sect2" title="19.1.5. Restricted packages">
1.1       dsieger  7864: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7865: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7866: <p>Some licenses restrict how software may be re-distributed.
                   7867:     Because a license tag is required unless the package is Free or
                   7868:     Open Source, all packages with restrictions should have license
                   7869:     tags.  By declaring the restrictions, package tools can
                   7870:     automatically refrain from e.g. placing binary packages on FTP
                   7871:     sites.</p>
                   7872: <p>There are four restrictions that may be encoded, which are
                   7873:     the cross product of sources (distfiles) and binaries not being
                   7874:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7875:     language in any license, and because non-Free licenses tend to be
                   7876:     different from each other, pkgsrc adopts a definition of FTP and
                   7877:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7878:     should not be made available over the Internet at no charge.
                   7879:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7880:     made available on some kind of media, together with other source
                   7881:     and binary packages, and which is sold for a distribution charge.
                   7882:     </p>
                   7883: <p>In order to encode these restrictions, the package system
                   7884:     defines five make variables that can be set to note these
                   7885:     restrictions:</p>
1.23      wiz      7886: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   7887: <li class="listitem">
1.1       dsieger  7888: <p><code class="varname">RESTRICTED</code></p>
                   7889: <p>This variable should be set whenever a restriction
                   7890:        exists (regardless of its kind).  Set this variable to a
                   7891:        string containing the reason for the restriction.  It should
                   7892:        be understood that those wanting to understand the restriction
                   7893:        will have to read the license, and perhaps seek advice of
                   7894:        counsel.</p>
                   7895: </li>
1.23      wiz      7896: <li class="listitem">
1.1       dsieger  7897: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7898: <p>Binaries may not be placed on CD-ROM containing other
                   7899:        binary packages, for which a distribution charge may be made.
                   7900:        In this case, set this variable to
                   7901:        <code class="varname">${RESTRICTED}</code>.</p>
                   7902: </li>
1.23      wiz      7903: <li class="listitem">
1.1       dsieger  7904: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7905: <p>Binaries may not made available on the Internet without
                   7906:        charge.  In this case, set this variable to
                   7907:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7908:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7909: </li>
1.23      wiz      7910: <li class="listitem">
1.1       dsieger  7911: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7912: <p>Distfiles may not be placed on CD-ROM, together with
                   7913:        other distfiles, for which a fee may be charged.  In this
                   7914:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7915:        </p>
                   7916: </li>
1.23      wiz      7917: <li class="listitem">
1.1       dsieger  7918: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7919: <p>Distfiles may not made available via FTP at no charge.
                   7920:        In this case, set this variable to
                   7921:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7922:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7923: </li>
                   7924: </ul></div>
1.32      wiz      7925: <p>Please note that packages will to be removed from pkgsrc
                   7926:     when the distfiles are not distributable and cannot be obtained
                   7927:     for a period of one full quarter branch. Packages with manual /
                   7928:     interactive fetch must have a maintainer and it is his/her
                   7929:     responsibility to ensure this.</p>
1.1       dsieger  7930: </div>
1.23      wiz      7931: <div class="sect2" title="19.1.6. Handling dependencies">
1.1       dsieger  7932: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7933: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  7934: <p>Your package may depend on some other package being present
                   7935:     - and there are various ways of expressing this dependency.
                   7936:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7937:     <code class="varname">DEPENDS</code> definitions, the
                   7938:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7939:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7940:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  7941:     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  7942: <p>The basic difference between the two variables is as
                   7943:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7944:     that pre-requisite in the binary package so it will be pulled in
                   7945:     when the binary package is later installed, whilst the
                   7946:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7947:     dependency that is only needed for building the package.</p>
                   7948: <p>This means that if you only need a package present whilst
                   7949:     you are building, it should be noted as a
                   7950:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7951: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7952:     <code class="varname">DEPENDS</code> definition is:</p>
                   7953: <pre class="programlisting">
                   7954: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7955:     </pre>
1.23      wiz      7956: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7957:     may include any of the wildcard version numbers recognized by
1.29      dholland 7958:     <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      7959: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7960: <li class="listitem">
1.1       dsieger  7961: <p>If your package needs another package's binaries or
                   7962:        libraries to build or run, and if that package has a
                   7963:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7964: <pre class="programlisting">
                   7965: .include "../../graphics/jpeg/buildlink3.mk"
                   7966:        </pre>
                   7967: </li>
1.23      wiz      7968: <li class="listitem">
1.25      spz      7969: <p>If your package needs binaries from another package to build,
                   7970:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1       dsieger  7971: <pre class="programlisting">
1.25      spz      7972: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1       dsieger  7973:        </pre>
                   7974: </li>
1.25      spz      7975: <li class="listitem"><p>If your package needs a library with which to link and
                   7976:        there is no <code class="filename">buildlink3.mk</code> file
                   7977:        available, create one. Using
                   7978:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7979:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7980: <li class="listitem">
1.25      spz      7981: <p>If your package needs some executable to be able to run
                   7982:        correctly and if there's no
                   7983:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7984:        using the <code class="varname">DEPENDS</code> variable. The
                   7985:        <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
                   7986:        be able to execute the latex binary from the teTeX package
                   7987:        when it runs, and that is specified:</p>
1.1       dsieger  7988: <pre class="programlisting">
1.25      spz      7989: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.1       dsieger  7990:        </pre>
1.25      spz      7991: </li>
                   7992: <li class="listitem">
                   7993: <p>You can use wildcards in package dependencies. Note that
                   7994:        such wildcard dependencies are retained when creating binary
                   7995:        packages. The dependency is checked when installing the binary
                   7996:        package and any package which matches the pattern will be
                   7997:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7998: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7999:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   8000:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   8001:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  8002: <p>Wildcards can also be used to specify that a package
                   8003:        will only build against a certain minimum version of a
                   8004:        pre-requisite:</p>
                   8005: <pre class="programlisting">
1.25      spz      8006: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.1       dsieger  8007:        </pre>
1.25      spz      8008: <p>This means that the package will build using version 6.0
                   8009:        of ImageMagick or newer. Such a dependency may be warranted
                   8010:        if, for example, the command line options of an executable
                   8011:        have changed.</p>
                   8012: <p>If you need to depend on minimum versions of libraries,
                   8013:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  8014: <p>For security fixes, please update the package
1.10      hubertf  8015:        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  8016:        information.</p>
                   8017: </li>
                   8018: </ol></div>
                   8019: <p>If your package needs files from another package to build,
                   8020:     add the relevant distribution files to
                   8021:     <code class="varname">DISTFILES</code>, so they will be extracted
                   8022:     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.
                   8023:     (It relies on the jpeg sources being present in source form
                   8024:     during the build.)</p>
                   8025: </div>
1.23      wiz      8026: <div class="sect2" title="19.1.7. Handling conflicts with other packages">
1.1       dsieger  8027: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8028: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  8029: <p>Your package may conflict with other packages a user might
                   8030:     already have installed on his system, e.g. if your package
                   8031:     installs the same set of files as another package in the pkgsrc
                   8032:     tree.</p>
                   8033: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   8034:     space-separated list of packages (including version string) your
                   8035:     package conflicts with.</p>
                   8036: <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>
                   8037:     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>
                   8038:     install the same shared library, thus you set in
                   8039:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8040: <pre class="programlisting">
                   8041: CONFLICTS=      Xaw-Xpm-[0-9]*
                   8042:     </pre>
                   8043: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   8044: <pre class="programlisting">
                   8045: CONFLICTS=      Xaw3d-[0-9]*
                   8046:     </pre>
                   8047: <p>Packages will automatically conflict with other packages
                   8048:     with the name prefix and a different version
1.23      wiz      8049:     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
                   8050:     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
1.1       dsieger  8051: </div>
1.23      wiz      8052: <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
1.1       dsieger  8053: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8054: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  8055: <p>There are several reasons why a package might be
                   8056:     instructed to not build under certain circumstances.  If the
                   8057:     package builds and runs on most platforms, the exceptions
                   8058:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8059:     the package builds and runs on a small handful of platforms,
                   8060:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8061:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8062:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8063:     (OS-version-platform) that can use glob-style
                   8064:     wildcards.</p>
                   8065: <p>Some packages are tightly bound to a specific version of an
                   8066:     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
                   8067:     backwards compatible with other versions of the OS, and should be
                   8068:     uploaded to a version specific directory on the FTP server.  Mark
                   8069:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      8070:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  8071:     the package system internals, but may be used in the
                   8072:     future.</p>
                   8073: <p>If the package should be skipped (for example, because it
                   8074:     provides functionality already provided by the system), set
                   8075:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8076:     the package should fail because some preconditions are not met,
                   8077:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   8078:     message.</p>
                   8079: </div>
1.23      wiz      8080: <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
1.1       dsieger  8081: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8082: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  8083: <p>To ensure that a package may not be deleted, once it has been
                   8084:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8085:     be set in the package Makefile. This will be carried into any
                   8086:     binary package that is made from this pkgsrc entry. A
1.23      wiz      8087:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.29      dholland 8088:     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      8089:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  8090: </div>
1.23      wiz      8091: <div class="sect2" title="19.1.10. Handling packages with security problems">
1.1       dsieger  8092: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8093: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  8094: <p>When a vulnerability is found, this should be noted in
                   8095:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      8096:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   8097:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  8098: <p>After fixing the vulnerability by a patch, its
1.31      wiz      8099:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   8100:     course not necessary if the problem is fixed by using a newer
                   8101:     release of the software), and the pattern in the
                   8102:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  8103: <p>Also, if the fix should be applied to the stable pkgsrc
                   8104:     branch, be sure to submit a pullup request!</p>
                   8105: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8106:     semi-automatically by a weekly cron job.</p>
                   8107: </div>
1.23      wiz      8108: <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
1.1       dsieger  8109: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8110: <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  8111: <p>When making fixes to an existing package it can be useful
                   8112:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8113:     avoid conflicting with future versions by the original author, a
1.23      wiz      8114:     <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  8115:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      8116:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   8117:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  8118: <pre class="programlisting">
                   8119: DISTNAME=       foo-17.42
                   8120: PKGREVISION=    9
                   8121:     </pre>
                   8122: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      8123:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   8124:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  8125:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8126:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8127: <p>When a new release of the package is released, the
                   8128:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8129:     minor release of the above package, things should be like:</p>
                   8130: <pre class="programlisting">
                   8131: DISTNAME=       foo-17.43
                   8132:     </pre>
                   8133: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8134:     non-trivial change in the resulting binary package.  Without a
                   8135:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8136:     version installed has no way of knowing that their package is out
                   8137:     of date.  Thus, changes without increasing
                   8138:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8139:     trivial that no reasonable person would want to upgrade", and this
                   8140:     is the rough test for when increasing
                   8141:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8142:     changes that do not merit increasing
                   8143:     <code class="varname">PKGREVISION</code> are:</p>
1.23      wiz      8144: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8145: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 8146:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  8147:       or comments in Makefile.</p></li>
1.23      wiz      8148: <li class="listitem"><p>
1.1       dsieger  8149:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      8150: <li class="listitem"><p>
1.1       dsieger  8151:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      8152: <li class="listitem"><p>
1.1       dsieger  8153:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8154: </ul></div>
                   8155: <p>Examples of changes that do merit an increase to
                   8156:     <code class="varname">PKGREVISION</code> include:</p>
1.23      wiz      8157: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8158: <li class="listitem"><p>
1.1       dsieger  8159:       Security fixes</p></li>
1.23      wiz      8160: <li class="listitem"><p>
1.1       dsieger  8161:       Changes or additions to a patch file</p></li>
1.23      wiz      8162: <li class="listitem"><p>
1.1       dsieger  8163:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      8164: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  8165: </ul></div>
                   8166: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8167:     changes.</p>
                   8168: </div>
1.23      wiz      8169: <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
1.1       dsieger  8170: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8171: <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  8172: <p>When you want to replace the same text in multiple files
                   8173:     or when the replacement text varies, patches alone cannot help.
                   8174:     This is where the SUBST framework comes in. It provides an
                   8175:     easy-to-use interface for replacing text in files.
                   8176:     Example:</p>
                   8177: <pre class="programlisting">
                   8178: SUBST_CLASSES+=                 fix-paths
                   8179: SUBST_STAGE.fix-paths=          pre-configure
                   8180: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8181: SUBST_FILES.fix-paths=          src/*.c
                   8182: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8183: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8184: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8185:     </pre>
                   8186: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8187:     that are used to identify the different SUBST blocks that are
                   8188:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8189:     important to always use the <code class="literal">+=</code> operator with
                   8190:     this variable. Otherwise some substitutions may be
                   8191:     skipped.</p>
                   8192: <p>The remaining variables of each SUBST block are
                   8193:     parameterized with the identifier from the first line
                   8194:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8195:     parameters to a function call.</p>
                   8196: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8197:     which the replacement will take place. All combinations of
                   8198:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8199:     <code class="literal">post-</code> together with a phase name are
                   8200:     possible, though only few are actually used. Most commonly used
                   8201:     are <code class="literal">post-patch</code> and
                   8202:     <code class="literal">pre-configure</code>. Of these two,
                   8203:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  8204:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  8205:     have the state after applying the patches but before making any
                   8206:     other changes. This is especially useful when you are debugging
                   8207:     a package in order to create new patches for it. Similarly,
                   8208:     <code class="literal">post-build</code> is preferred over
                   8209:     <code class="literal">pre-install</code>, because the install phase should
                   8210:     generally be kept as simple as possible. When you use
                   8211:     <code class="literal">post-build</code>, you have the same files in the
                   8212:     working directory that will be installed later, so you can check
                   8213:     if the substitution has succeeded.</p>
                   8214: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8215:     that is printed just before the substitution is done.</p>
                   8216: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8217:     globbing patterns that specifies the files in which the
                   8218:     substitution will take place. The patterns are interpreted
                   8219:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8220: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29      dholland 8221:     <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  8222:     command should be prefixed with <code class="literal">-e</code>, so that
                   8223:     all SUBST blocks look uniform.</p>
                   8224: <p>There are some more variables, but they are so seldomly
                   8225:     used that they are only documented in the
                   8226:     <code class="filename">mk/subst.mk</code> file.</p>
                   8227: </div>
                   8228: </div>
1.23      wiz      8229: <div class="sect1" title="19.2. Fixing problems in the fetch phase">
1.1       dsieger  8230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8231: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.23      wiz      8232: <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
1.1       dsieger  8233: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8234: <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  8235: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8236:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8237:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8238:     with the name of each file to download as an argument, expecting
                   8239:     it to output the URL of the directory from which to download
                   8240:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
                   8241:     example of this usage.</p>
                   8242: <p>If the download can't be automated, because the user must
                   8243:     submit personal information to apply for a password, or must pay
                   8244:     for the source, or whatever, you can set
                   8245:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8246:     displayed to the user before aborting the build. Example:</p>
                   8247: <pre class="programlisting">
                   8248: FETCH_MESSAGE=  "Please download the files"
                   8249: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8250: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8251:     </pre>
                   8252: </div>
1.23      wiz      8253: <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
1.1       dsieger  8254: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8255: <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  8256: <p>Sometimes authors of a software package make some
                   8257:     modifications after the software was released, and they put up a
                   8258:     new distfile without changing the package's version number. If a
                   8259:     package is already in pkgsrc at that time, the checksum will
                   8260:     no longer match. The contents of the new distfile should be
                   8261:     compared against the old one before changing anything, to make
                   8262:     sure the distfile was really updated on purpose, and that
                   8263:     no trojan horse or so crept in.
                   8264:     Please mention that the distfiles were compared and what was found
                   8265:     in your commit message.
                   8266:     Then, the correct way to work around this is to
                   8267:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8268:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8269:     <code class="varname">DISTFILES</code> and
                   8270:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8271:     subdirectory of the local distfiles directory.
1.10      hubertf  8272:     (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  8273:     In case this
                   8274:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8275:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8276:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8277:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8278:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8279:     path in the filenames.
                   8280:     Also increase the PKGREVISION if the installed package is different.
                   8281:     Furthermore, a mail to the package's authors seems appropriate
                   8282:     telling them that changing distfiles after releases without
                   8283:     changing the file names is not good practice.</p>
                   8284: </div>
                   8285: </div>
1.23      wiz      8286: <div class="sect1" title="19.3. Fixing problems in the configure phase">
1.1       dsieger  8287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8288: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.23      wiz      8289: <div class="sect2" title="19.3.1. Shared libraries - libtool">
1.1       dsieger  8290: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8291: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8292: <p>pkgsrc supports many different machines, with different
                   8293:     object formats like a.out and ELF, and varying abilities to do
                   8294:     shared library and dynamic loading at all. To accompany this,
                   8295:     varying commands and options have to be passed to the
                   8296:     compiler, linker, etc. to get the Right Thing, which can be
                   8297:     pretty annoying especially if you don't have all the machines
                   8298:     at your hand to test things.  The
                   8299:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23      wiz      8300:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8301:     both static and dynamic libraries from a set of source files,
                   8302:     thus being platform-independent.</p>
                   8303: <p>Here's how to use libtool in a package in seven simple
                   8304:     steps:</p>
1.23      wiz      8305: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8306: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8307:        Makefile.</p></li>
1.23      wiz      8308: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8309:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8310:        add it to the definition of <code class="varname">CC</code>, if only
                   8311:        libraries are being built in a given Makefile. This one command
                   8312:        will build both PIC and non-PIC library objects, so you need not
                   8313:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8314: <li class="listitem">
1.1       dsieger  8315: <p>For the linking of the library, remove any
1.23      wiz      8316:        <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
                   8317:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8318: <pre class="programlisting">
                   8319: ${LIBTOOL} --mode=link \
                   8320:     ${CC} -o ${.TARGET:.a=.la} \
                   8321:         ${OBJS:.o=.lo} \
                   8322:         -rpath ${PREFIX}/lib \
                   8323:         -version-info major:minor
                   8324:        </pre>
                   8325: <p>Note that the library is changed to have a
                   8326:        <code class="filename">.la</code> extension, and the objects are
                   8327:        changed to have a <code class="filename">.lo</code>
                   8328:        extension. Change <code class="varname">OBJS</code> as
                   8329:        necessary. This automatically creates all of the
                   8330:        <code class="filename">.a</code>,
                   8331:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8332:        necessary) in the build directory. Be sure to include
1.23      wiz      8333:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8334:        minor are zero, as libtool will otherwise strip off the
                   8335:        shared library version.</p>
                   8336: <p>From the libtool manual:</p>
                   8337: <pre class="programlisting">
                   8338: So, libtool library versions are described by three integers:
                   8339: 
                   8340: CURRENT
                   8341: The most recent interface number that this library implements.
                   8342: 
                   8343: REVISION
                   8344: The implementation number of the CURRENT interface.
                   8345: 
                   8346: AGE
                   8347: The difference between the newest and oldest interfaces that
                   8348: this library implements.  In other words, the library implements
                   8349: all the interface numbers in the range from number `CURRENT -
                   8350: AGE' to `CURRENT'.
                   8351: 
                   8352: If two libraries have identical CURRENT and AGE numbers, then the
                   8353: dynamic linker chooses the library with the greater REVISION number.
                   8354:        </pre>
1.23      wiz      8355: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8356:        different results for a.out and ELF (excluding symlinks)
                   8357:        in only one case. An ELF library of the form
1.23      wiz      8358:        <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  8359:        will have a symlink of
1.23      wiz      8360:        <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  8361:        on an a.out platform. This is handled
                   8362:        automatically.</p>
1.23      wiz      8363: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8364:        directory of the library being built.</p>
                   8365: <p>In the <code class="filename">PLIST</code>, include only the
                   8366:        <code class="filename">.la</code> file, the other files will be
                   8367:        added automatically.</p>
                   8368: </li>
1.23      wiz      8369: <li class="listitem">
1.1       dsieger  8370: <p>When linking shared object (<code class="filename">.so</code>)
1.29      dholland 8371:        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      8372:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8373:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8374:        tacked on.</p>
                   8375: <p>The <code class="filename">PLIST</code> file gets the
                   8376:        <code class="filename">foo.so</code> entry.</p>
                   8377: </li>
1.23      wiz      8378: <li class="listitem">
1.1       dsieger  8379: <p>When linking programs that depend on these libraries
                   8380:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.29      dholland 8381:        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      8382:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8383:        libraries (static or shared), but please be aware that
                   8384:        libtool will not allow you to specify a relative path in
1.23      wiz      8385:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8386:        expects you to change that argument to be the
                   8387:        <code class="filename">.la</code> file. e.g.</p>
                   8388: <pre class="programlisting">
                   8389: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8390:        </pre>
                   8391: <p>should be changed to:</p>
                   8392: <pre class="programlisting">
                   8393: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8394:        </pre>
                   8395: <p>and it will do the right thing with the libraries.</p>
                   8396: </li>
1.23      wiz      8397: <li class="listitem">
1.29      dholland 8398: <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>
                   8399:        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      8400:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8401:        <code class="filename">.la</code>. e.g.</p>
                   8402: <pre class="programlisting">
1.22      jakllsch 8403: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1       dsieger  8404:        </pre>
                   8405: <p>This will install the static <code class="filename">.a</code>,
                   8406:        shared library, any needed symlinks, and run
1.29      dholland 8407:        <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  8408: </li>
1.23      wiz      8409: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8410:        the <code class="filename">.la</code>
                   8411:        file (this is a change from previous behaviour).</p></li>
                   8412: </ol></div>
                   8413: </div>
1.23      wiz      8414: <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
1.1       dsieger  8415: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8416: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8417: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8418:     package Makefile. This will override the package's own libtool
                   8419:     in most cases.  For older libtool using packages,  libtool is
                   8420:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8421:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8422:     configure; find work*/ -name libtool</strong></span>.</p>
                   8423: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8424:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8425:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8426:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8427:     package's libtool script(s), set it as appropriate.</p>
                   8428: <p>If you do not need <code class="filename">*.a</code> static
                   8429:     libraries built and installed, then use
                   8430:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8431: <p>If your package makes use of the platform-independent library
                   8432:     for loading dynamic shared objects, that comes with libtool
                   8433:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8434: <p>Some packages use libtool incorrectly so that the package
                   8435:     may not work or build in some circumstances. Some of the more
                   8436:     common errors are:</p>
1.23      wiz      8437: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8438: <li class="listitem">
1.1       dsieger  8439: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8440:        executable or library. This in itself isn't a problem if one of two things
                   8441:        has been done:</p>
1.23      wiz      8442: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8443: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8444:            <code class="filename">libfoo.la</code>, not
                   8445:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8446: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8447: </ol></div>
                   8448: </li>
1.23      wiz      8449: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8450:        The function lt_dlinit() should be called and the macro
                   8451:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8452:        executables.</p></li>
                   8453: </ul></div>
                   8454: </div>
1.23      wiz      8455: <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
1.1       dsieger  8456: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8457: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8458: <p>If a package needs GNU autoconf or automake to be executed
                   8459:     to regenerate the configure script and Makefile.in makefile
                   8460:     templates, then they should be executed in a pre-configure
                   8461:     target.</p>
                   8462: <p>For packages that need only autoconf:</p>
                   8463: <pre class="programlisting">
                   8464: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8465: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8466: ...
                   8467: 
                   8468: pre-configure:
                   8469:         cd ${WRKSRC} &amp;&amp; autoconf
                   8470: 
                   8471: ...
                   8472:     </pre>
                   8473: <p>and for packages that need automake and autoconf:</p>
                   8474: <pre class="programlisting">
                   8475: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8476: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8477: ...
                   8478: 
                   8479: pre-configure:
                   8480:         set -e; cd ${WRKSRC}; \
                   8481:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8482: 
                   8483: ...
                   8484:     </pre>
                   8485: <p>Packages which use GNU Automake will almost certainly
                   8486:     require GNU Make.</p>
                   8487: <p>There are times when the configure process makes
                   8488:     additional changes to the generated files, which then causes
                   8489:     the build process to try to re-execute the automake sequence.
                   8490:     This is prevented by touching various files in the configure
                   8491:     stage. If this causes problems with your package you can set
                   8492:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8493:     Makefile.</p>
                   8494: </div>
                   8495: </div>
1.23      wiz      8496: <div class="sect1" title="19.4. Programming languages">
1.1       dsieger  8497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8498: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.23      wiz      8499: <div class="sect2" title="19.4.1. C, C++, and Fortran">
1.1       dsieger  8500: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8501: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8502: <p>Compilers for the C, C++, and Fortran languages comes with
                   8503:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8504:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  8505:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8506: <p>To declare which language's compiler a package needs, set
                   8507:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      8508:     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
                   8509:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8510:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8511:     written in C++, usually need a C compiler for the configure
                   8512:     phase.</p>
                   8513: </div>
1.23      wiz      8514: <div class="sect2" title="19.4.2. Java">
1.1       dsieger  8515: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8516: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8517: <p>If a program is written in Java, use the Java framework in
                   8518:     pkgsrc.  The package must include
                   8519:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8520:     provides the following variables:</p>
1.23      wiz      8521: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8522: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8523:       dependency on the JDK is added.  If
1.23      wiz      8524:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8525:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8526:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8527:       JDK.</p></li>
1.23      wiz      8528: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8529:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8530:       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
                   8531:       <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
                   8532:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8533:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8534:       above. This variable is not set by default.</p></li>
1.24      wiz      8535: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8536:       automatically set to the runtime location of the used Java
                   8537:       implementation dependency. It may be used to set
                   8538:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8539:       needs this variable to be defined.
                   8540:       </p></li>
1.1       dsieger  8541: </ul></div>
                   8542: </div>
1.23      wiz      8543: <div class="sect2" title="19.4.3. Packages containing perl scripts">
1.1       dsieger  8544: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8545: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8546: <p>If your package contains interpreted perl scripts, add
1.23      wiz      8547:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8548:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8549:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8550:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8551:     that you want adjusted.  Every occurrence of
                   8552:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8553:     path to the perl executable.</p>
                   8554: <p>If a particular version of perl is needed, set the
                   8555:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8556:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.10      hubertf  8557: <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  8558:     about handling perl modules.</p>
                   8559: </div>
1.23      wiz      8560: <div class="sect2" title="19.4.4. Other programming languages">
1.1       dsieger  8561: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8562: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1       dsieger  8563: <p>Currently, there is no special handling for other languages
                   8564:     in pkgsrc.  If a compiler package provides a
                   8565:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8566:     just add a (build) dependency on the appropriate compiler
                   8567:     package.</p>
                   8568: </div>
                   8569: </div>
1.23      wiz      8570: <div class="sect1" title="19.5. Fixing problems in the build phase">
1.1       dsieger  8571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8572: <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  8573: <p>The most common failures when building a package are that
                   8574:        some platforms do not provide certain header files, functions or
                   8575:        libraries, or they provide the functions in a library that the
                   8576:        original package author didn't know. To work around this, you
                   8577:        can rewrite the source code in most cases so that it does not
                   8578:        use the missing functions or provides a replacement function.</p>
1.23      wiz      8579: <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
1.1       dsieger  8580: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8581: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8582: <p>If a package already comes with a GNU configure script, the
                   8583:        preferred way to fix the build failure is to change the
                   8584:        configure script, not the code. In the other cases, you can
                   8585:        utilize the C preprocessor, which defines certain macros
                   8586:        depending on the operating system and hardware architecture it
                   8587:        compiles for. These macros can be queried using for example
                   8588:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8589:        system, hardware architecture and compiler has its own macro.
                   8590:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8591:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8592:        are all defined, you know that you are using NetBSD on an i386
                   8593:        compatible CPU, and your compiler is GCC.</p>
                   8594: <p>The list of the following macros for hardware and
                   8595:        operating system depends on the compiler that is used. For
                   8596:        example, if you want to conditionally compile code on Solaris,
                   8597:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8598:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.23      wiz      8599: <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
1.1       dsieger  8600: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8601: <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  8602: <p>To distinguish between 4.4 BSD-derived systems and the
                   8603:         rest of the world, you should use the following code.</p>
                   8604: <pre class="programlisting">
                   8605: #include &lt;sys/param.h&gt;
                   8606: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8607: /* BSD-specific code goes here */
                   8608: #else
                   8609: /* non-BSD-specific code goes here */
                   8610: #endif
                   8611: </pre>
                   8612: <p>If this distinction is not fine enough, you can also test
                   8613:        for the following macros.</p>
                   8614: <pre class="programlisting">
                   8615: FreeBSD     __FreeBSD__
                   8616: DragonFly   __DragonFly__
                   8617: Interix     __INTERIX
                   8618: IRIX        __sgi (TODO: get a definite source for this)
                   8619: Linux       linux, __linux, __linux__
                   8620: NetBSD      __NetBSD__
                   8621: OpenBSD     __OpenBSD__
                   8622: Solaris     sun, __sun
                   8623: </pre>
                   8624: </div>
1.23      wiz      8625: <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
1.1       dsieger  8626: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8627: <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  8628: <pre class="programlisting">
                   8629: i386        i386, __i386, __i386__
                   8630: MIPS        __mips
                   8631: SPARC       sparc, __sparc
                   8632: </pre>
                   8633: </div>
1.23      wiz      8634: <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
1.1       dsieger  8635: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8636: <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  8637: <pre class="programlisting">
                   8638: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8639: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8640: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8641: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8642: </pre>
                   8643: </div>
                   8644: </div>
1.23      wiz      8645: <div class="sect2" title="19.5.2. How to handle compiler bugs">
1.1       dsieger  8646: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8647: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8648: <p>Some source files trigger bugs in the compiler, based on
                   8649:         combinations of compiler version and architecture and almost
                   8650:         always relation to optimisation being enabled.  Common symptoms
                   8651:         are gcc internal errors or never finishing compiling a
                   8652:        file.</p>
                   8653: <p>Typically, a workaround involves testing the
                   8654:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8655:         optimisation for that combination of file,
                   8656:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8657:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8658:        number of examples.</p>
                   8659: </div>
1.23      wiz      8660: <div class="sect2" title="19.5.3. Undefined reference to &#8220;...&#8221;">
1.1       dsieger  8661: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz      8662: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8663: </h3></div></div></div>
1.1       dsieger  8664: <p>This error message often means that a package did not
                   8665:        link to a shared library it needs. The following functions are
                   8666:        known to cause this error message over and over.</p>
                   8667: <div class="informaltable">
                   8668: <a name="undefined-reference-functions"></a><table border="1">
                   8669: <colgroup>
                   8670: <col>
                   8671: <col>
                   8672: <col>
                   8673: </colgroup>
                   8674: <thead><tr>
                   8675: <th>Function</th>
                   8676: <th>Library</th>
                   8677: <th>Affected platforms</th>
                   8678: </tr></thead>
                   8679: <tbody>
                   8680: <tr>
                   8681: <td>accept, bind, connect</td>
                   8682: <td>-lsocket</td>
                   8683: <td>Solaris</td>
                   8684: </tr>
                   8685: <tr>
                   8686: <td>crypt</td>
                   8687: <td>-lcrypt</td>
                   8688: <td>DragonFly, NetBSD</td>
                   8689: </tr>
                   8690: <tr>
                   8691: <td>dlopen, dlsym</td>
                   8692: <td>-ldl</td>
                   8693: <td>Linux</td>
                   8694: </tr>
                   8695: <tr>
                   8696: <td>gethost*</td>
                   8697: <td>-lnsl</td>
                   8698: <td>Solaris</td>
                   8699: </tr>
                   8700: <tr>
                   8701: <td>inet_aton</td>
                   8702: <td>-lresolv</td>
                   8703: <td>Solaris</td>
                   8704: </tr>
                   8705: <tr>
                   8706: <td>nanosleep, sem_*, timer_*</td>
                   8707: <td>-lrt</td>
                   8708: <td>Solaris</td>
                   8709: </tr>
                   8710: <tr>
                   8711: <td>openpty</td>
                   8712: <td>-lutil</td>
                   8713: <td>Linux</td>
                   8714: </tr>
                   8715: </tbody>
                   8716: </table>
                   8717: </div>
                   8718: <p>To fix these linker errors, it is often sufficient to say
                   8719:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8720:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8721:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8722:     bmake</strong></span>.</p>
1.23      wiz      8723: <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
1.1       dsieger  8724: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8725: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8726: <p>When you are using the SunPro compiler, there is another
                   8727: possibility. That compiler cannot handle the following code:</p>
                   8728: <pre class="programlisting">
                   8729: extern int extern_func(int);
                   8730: 
                   8731: static inline int
                   8732: inline_func(int x)
                   8733: {
                   8734:         return extern_func(x);
                   8735: }
                   8736: 
                   8737: int main(void)
                   8738: {
                   8739:         return 0;
                   8740: }
                   8741: </pre>
                   8742: <p>It generates the code for <code class="function">inline_func</code> even if
                   8743: that function is never used. This code then refers to
                   8744: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8745: solve this problem you can try to tell the package to disable inlining
                   8746: of functions.</p>
                   8747: </div>
                   8748: </div>
1.23      wiz      8749: <div class="sect2" title="19.5.4. Running out of memory">
1.1       dsieger  8750: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8751: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8752: <p>Sometimes packages fail to build because the compiler runs
                   8753:     into an operating system specific soft limit.  With the
                   8754:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8755:     to unlimit the resources.  Currently, the allowed values are
1.23      wiz      8756:     <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  8757:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8758:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8759:     segment size or maximum stack size of a process, respectively, to
                   8760:     their hard limits.</p>
                   8761: </div>
                   8762: </div>
1.23      wiz      8763: <div class="sect1" title="19.6. Fixing problems in the install phase">
1.1       dsieger  8764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8765: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.23      wiz      8766: <div class="sect2" title="19.6.1. Creating needed directories">
1.1       dsieger  8767: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8768: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8769: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8770:     with some operating systems cannot create more than one
                   8771:     directory at a time. As such, you should call
                   8772:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8773: <pre class="programlisting">
                   8774: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8775: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8776:     </pre>
1.23      wiz      8777: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8778:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8779:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8780:     automatically do the right thing.</p>
                   8781: </div>
1.23      wiz      8782: <div class="sect2" title="19.6.2. Where to install documentation">
1.1       dsieger  8783: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8784: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8785: <p>In general, documentation should be installed into
                   8786:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8787:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8788:     includes the version number of the package).</p>
                   8789: <p>Many modern packages using GNU autoconf allow to set the
                   8790:     directory where HTML documentation is installed with the
1.23      wiz      8791:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8792:     is needed because otherwise the documentation ends up in
                   8793:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8794:     places.</p>
                   8795: <p>An exception to the above is that library API documentation
                   8796:     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
                   8797:     browsers (devhelp) should be left at their default location, which
                   8798:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8799:     documentation can be recognized from files ending in
                   8800:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8801:     (It is also acceptable to install such files in
                   8802:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8803:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8804:     <code class="filename">.devhelp*</code> file must be directly in that
                   8805:     directory then, no additional subdirectory level is allowed in
                   8806:     this case. This is usually achieved by using
1.23      wiz      8807:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8808:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8809:     though.)</p>
                   8810: </div>
1.23      wiz      8811: <div class="sect2" title="19.6.3. Installing highscore files">
1.1       dsieger  8812: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8813: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8814: <p>Certain packages, most of them in the games category, install
                   8815:     a score file that allows all users on the system to record their
                   8816:     highscores.  In order for this to work, the binaries need to be
                   8817:     installed setgid and the score files owned by the appropriate
                   8818:     group and/or owner (traditionally the "games" user/group).  The
                   8819:     following variables, documented in more detail in
                   8820:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8821:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8822:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8823:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
                   8824: <p>Note that per default, setgid installation of games is
                   8825:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8826:     the other variables accordingly.</p>
1.14      jmcneill 8827: <p>A package should therefore never hard code file ownership or
1.1       dsieger  8828:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8829:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8830:     correctly.</p>
                   8831: </div>
1.23      wiz      8832: <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
1.1       dsieger  8833: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8834: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8835: <p><code class="varname">DESTDIR</code> support means that a package
                   8836:     installs into a staging directory, not the final location of the
                   8837:     files. Then a binary package is created which can be used for
                   8838:     installation as usual. There are two ways: Either the package must
1.23      wiz      8839:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8840:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
                   8841: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   8842: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8843:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. If
1.14      jmcneill 8844:       bsd.prefs.mk is included in the Makefile,
                   8845:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8846:       the inclusion.</p></li>
1.23      wiz      8847: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8848:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8849: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8850:       automatically. Many manual rules and pre/post-install often are
                   8851:       incorrect; fix them.</p></li>
1.23      wiz      8852: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8853:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8854: <li class="listitem"><p>In general, packages should support
1.4       rillig   8855:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8856:       DESTDIR.</p></li>
                   8857: </ul></div>
                   8858: </div>
1.23      wiz      8859: <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
1.4       rillig   8860: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8861: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8862: <p>Your package may also contain scripts with hardcoded paths to
                   8863:       other interpreters besides (or as well as) perl.  To correct the
                   8864:       full pathname to the script interpreter, you need to set the
                   8865:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8866:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8867: <pre class="programlisting">
                   8868: REPLACE_INTERPRETER+=   tcl
                   8869: REPLACE.tcl.old=        .*/bin/tclsh
                   8870: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8871: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8872: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8873:     </pre>
1.23      wiz      8874: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8875: <h3 class="title">Note</h3>
                   8876: <p>Before March 2006, these variables were called
                   8877:     <code class="varname">_REPLACE.*</code> and
                   8878:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8879: </div>
                   8880: </div>
1.23      wiz      8881: <div class="sect2" title="19.6.6. Packages installing perl modules">
1.1       dsieger  8882: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8883: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8884: <p>Makefiles of packages providing perl5 modules should include
                   8885:     the Makefile fragment
                   8886:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8887:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8888:     configuration for such modules as well as various hooks to tune
                   8889:     this configuration.  See comments in this file for
                   8890:     details.</p>
                   8891: <p>Perl5 modules will install into different places depending
                   8892:     on the version of perl used during the build process.  To
                   8893:     address this, pkgsrc will append lines to the
                   8894:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8895:     the installed <code class="filename">.packlist</code> file generated by
                   8896:     most perl5 modules.  This is invoked by defining
                   8897:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8898:     paths to packlist files, e.g.:</p>
                   8899: <pre class="programlisting">
                   8900: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8901:     </pre>
                   8902: <p>The variables <code class="varname">PERL5_SITELIB</code>,
                   8903:     <code class="varname">PERL5_SITEARCH</code>, and
                   8904:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8905:     in which perl5 modules may be installed, and may be used by
                   8906:     perl5 packages that don't have a packlist.  These three
                   8907:     variables are also substituted for in the
                   8908:     <code class="filename">PLIST</code>.</p>
                   8909: </div>
1.23      wiz      8910: <div class="sect2" title="19.6.7. Packages installing info files">
1.1       dsieger  8911: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8912: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8913: <p>Some packages install info files or use the
1.23      wiz      8914:     <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  8915:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8916:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8917:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8918:     handle registration of the info files in the Info directory
1.23      wiz      8919:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8920:     files registration is either provided by the system, or by a
                   8921:     special purpose package automatically added as dependency if
                   8922:     needed.</p>
                   8923: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8924:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8925:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8926:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8927: <p>The info files for the package should be listed in the
                   8928:     package <code class="filename">PLIST</code>; however any split info files
                   8929:     need not be listed.</p>
1.23      wiz      8930: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8931:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8932:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8933:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8934:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8935:     variable in the package <code class="filename">Makefile</code>. By
                   8936:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8937:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8938:     does not match the required minimum, a build dependency on the
                   8939:     <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
                   8940:     be added automatically.</p>
                   8941: <p>The build and installation process of the software provided
                   8942:     by the package should not use the
1.10      hubertf  8943:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8944:     info files is the task of the package
                   8945:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8946:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8947: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8948:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8949:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8950:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8951: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8952:     no effect except the logging of a message. The script overriding
1.10      hubertf  8953:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8954:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8955:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8956: </div>
1.23      wiz      8957: <div class="sect2" title="19.6.8. Packages installing man pages">
1.1       dsieger  8958: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8959: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8960: <p>All packages that install manual pages should install them
                   8961:     into the same directory, so that there is one common place to look
                   8962:     for them. In pkgsrc, this place is
                   8963:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8964:     should be used in packages. The default for
                   8965:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8966:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8967:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
                   8968: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8969: <h3 class="title">Note</h3>
                   8970: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8971:     is far from complete.</p>
                   8972: </div>
                   8973: <p>The <code class="filename">PLIST</code> files can just use
                   8974:     <code class="filename">man/</code> as the top level directory for the man
                   8975:     page file entries, and the pkgsrc framework will convert as
                   8976:     needed. In all other places, the correct
                   8977:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8978: <p>Packages that are
                   8979:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      8980:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  8981:     <code class="filename">./configure</code>
                   8982:     --mandir switch to set where the man pages should be installed.
                   8983:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8984:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8985: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8986:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      8987:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  8988:     Or if the <code class="filename">./configure</code> script uses
                   8989:     a non-standard use of --mandir, you can set
                   8990:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  8991: <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  8992:     information on installation of compressed manual pages.</p>
                   8993: </div>
1.23      wiz      8994: <div class="sect2" title="19.6.9. Packages installing GConf data files">
1.1       dsieger  8995: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   8996: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8997: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8998:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8999:     you need to take some extra steps to make sure they get registered
                   9000:     in the database:</p>
1.23      wiz      9001: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9002: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  9003:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   9004:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  9005:        deinstallation time, and tells the package where to install
1.7       rillig   9006:        GConf data files using some standard configure arguments.  It
1.1       dsieger  9007:        also disallows any access to the database directly from the
                   9008:        package.</p></li>
1.23      wiz      9009: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  9010:        <code class="filename">.schemas</code> files under
                   9011:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9012:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9013:        need to manually patch the package.</p></li>
1.23      wiz      9014: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  9015:        directory, as they will be handled automatically.  See
1.10      hubertf  9016:        <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      9017: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  9018:        your <code class="filename">Makefile</code> with a list of all
                   9019:        <code class="filename">.schemas</code> files installed by the package, if
                   9020:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      9021: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  9022:        your <code class="filename">Makefile</code> with a
                   9023:        list of all <code class="filename">.entries</code> files installed by the
                   9024:        package, if any. Names must not contain any directories in
                   9025:        them.</p></li>
                   9026: </ol></div>
                   9027: </div>
1.23      wiz      9028: <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
1.1       dsieger  9029: <div class="titlepage"><div><div><h3 class="title">
1.18      snj      9030: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  9031: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      9032:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  9033:     get registered in the database:</p>
1.23      wiz      9034: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9035: <li class="listitem"><p>Include
1.18      snj      9036:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9037:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  9038:        takes care of rebuilding the scrollkeeper database at
                   9039:        installation and deinstallation time, and disallows any access
                   9040:        to it directly from the package.</p></li>
1.23      wiz      9041: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9042:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9043:        will be handled automatically.</p></li>
1.23      wiz      9044: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      9045:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9046:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  9047: </ol></div>
                   9048: </div>
1.23      wiz      9049: <div class="sect2" title="19.6.11. Packages installing X11 fonts">
1.1       dsieger  9050: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9051: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9052: <p>If a package installs font files, you will need to rebuild
                   9053:     the fonts database in the directory where they get installed at
                   9054:     installation and deinstallation time.  This can be automatically
                   9055:     done by using the pkginstall framework.</p>
                   9056: <p>You can list the directories where fonts are installed in the
                   9057:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9058:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9059:     <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  9060:     Also make sure that the database file
                   9061:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9062: <p>Note that you should not create new directories for fonts;
                   9063:     instead use the standard ones to avoid that the user needs to
                   9064:     manually configure his X server to find them.</p>
                   9065: </div>
1.23      wiz      9066: <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
1.1       dsieger  9067: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9068: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  9069: <p>If a package installs GTK2 immodules or loaders, you need to
                   9070:     take some extra steps to get them registered in the GTK2 database
                   9071:     properly:</p>
1.23      wiz      9072: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9073: <li class="listitem"><p>Include
1.1       dsieger  9074:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9075:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9076:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      9077: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  9078:       your package installs GTK2 immodules.</p></li>
1.23      wiz      9079: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  9080:       GTK2 loaders.</p></li>
1.23      wiz      9081: <li class="listitem">
1.1       dsieger  9082: <p>Patch the package to not touch any of the GTK2
                   9083:       databases directly.  These are:</p>
1.23      wiz      9084: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9085: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9086: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  9087: </ul></div>
                   9088: </li>
1.23      wiz      9089: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  9090:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9091:       directory, as they will be handled automatically.</p></li>
                   9092: </ol></div>
                   9093: </div>
1.23      wiz      9094: <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
1.1       dsieger  9095: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9096: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9097: <p>If a package installs SGML or XML data files that need to be
                   9098:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9099:     etc.), you need to take some extra steps:</p>
1.23      wiz      9100: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9101: <li class="listitem"><p>Include
1.1       dsieger  9102:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9103:        your <code class="filename">Makefile</code>, which takes care of
                   9104:        registering those files in system-wide catalogs at
                   9105:        installation and deinstallation time.</p></li>
1.23      wiz      9106: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9107:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9108: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9109:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9110: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9111:        to be added to the SGML catalog.  These come in groups of
                   9112:        three strings; see xmlcatmgr(1) for more information
                   9113:        (specifically, arguments recognized by the 'add' action).
                   9114:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9115: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9116:        to be added to the XML catalog.  These come in groups of three
                   9117:        strings; see xmlcatmgr(1) for more information (specifically,
                   9118:        arguments recognized by the 'add' action).  Note that you will
                   9119:        normally not use this variable.</p></li>
                   9120: </ol></div>
                   9121: </div>
1.23      wiz      9122: <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
1.1       dsieger  9123: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9124: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9125: <p>If a package provides extensions to the MIME database by
                   9126:     installing <code class="filename">.xml</code> files inside
                   9127:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9128:     need to take some extra steps to ensure that the database is kept
                   9129:     consistent with respect to these new files:</p>
1.23      wiz      9130: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9131: <li class="listitem"><p>Include
1.1       dsieger  9132:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9133:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9134:        this same directory, which is reserved for inclusion from
                   9135:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9136:        care of rebuilding the MIME database at installation and
                   9137:        deinstallation time, and disallows any access to it directly
                   9138:        from the package.</p></li>
1.23      wiz      9139: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9140:        <code class="filename">share/mime</code> directory,
                   9141:        <span class="emphasis"><em>except</em></span> for files saved under
                   9142:        <code class="filename">share/mime/packages</code>.  The former are
                   9143:        handled automatically by
                   9144:        the update-mime-database program, but the latter are
                   9145:        package-dependent and must be removed by the package that
                   9146:        installed them in the first place.</p></li>
1.23      wiz      9147: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9148:        from the PLIST.  They will be handled by the shared-mime-info
                   9149:        package.</p></li>
                   9150: </ol></div>
                   9151: </div>
1.23      wiz      9152: <div class="sect2" title="19.6.15. Packages using intltool">
1.1       dsieger  9153: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9154: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9155: <p>If a package uses intltool during its build, add
                   9156:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9157:     which forces it to use the intltool package provided by pkgsrc,
                   9158:     instead of the one bundled with the distribution file.</p>
                   9159: <p>This tracks intltool's build-time dependencies and uses the
                   9160:     latest available version; this way, the package benefits of any
                   9161:     bug fixes that may have appeared since it was released.</p>
                   9162: </div>
1.23      wiz      9163: <div class="sect2" title="19.6.16. Packages installing startup scripts">
1.1       dsieger  9164: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9165: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9166: <p>If a package contains a rc.d script, it won't be copied into
                   9167:     the startup directory by default, but you can enable it, by adding
                   9168:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9169:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9170:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9171:     it will automatically remove the scripts when the package is
                   9172:     deinstalled.</p>
                   9173: </div>
1.23      wiz      9174: <div class="sect2" title="19.6.17. Packages installing TeX modules">
1.1       dsieger  9175: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9176: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9177: <p>If a package installs TeX packages into the texmf tree,
                   9178:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9179:     updated.</p>
1.23      wiz      9180: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9181: <h3 class="title">Note</h3>
1.22      jakllsch 9182: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9183:     packages should install files
1.22      jakllsch 9184:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9185:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9186: </div>
1.23      wiz      9187: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9188: <li class="listitem"><p>Include
1.22      jakllsch 9189:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9190:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9191:       database at installation and deinstallation time.</p></li>
1.23      wiz      9192: <li class="listitem">
1.1       dsieger  9193: <p>If your package installs files into a texmf
                   9194:       tree other than the one
1.22      jakllsch 9195:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9196:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9197:       trees that need database update.</p>
                   9198: <p>If your package also installs font map files that need
1.10      hubertf  9199:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9200:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9201:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9202:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9203:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9204:       be run automatically at installation/deinstallation to
                   9205:       enable/disable font map files for TeX output
                   9206:       drivers.</p>
                   9207: </li>
1.23      wiz      9208: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9209:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9210:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9211: </ol></div>
                   9212: </div>
1.23      wiz      9213: <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
1.1       dsieger  9214: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9215: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  9216:     emulation</h3></div></div></div>
                   9217: <p>There are some packages that provide libraries and
                   9218:     executables for running binaries from a one operating system
                   9219:     on a different one (if the latter supports it).  One example
                   9220:     is running Linux binaries on NetBSD.</p>
                   9221: <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>
                   9222:     helps in extracting and packaging Linux rpm packages.</p>
                   9223: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9224:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9225:     if all libraries for each installed executable can be found by
                   9226:     the dynamic linker.  Since the standard dynamic linker is run,
                   9227:     this fails for emulation packages, because the libraries used
                   9228:     by the emulation are not in the standard directories.</p>
                   9229: </div>
1.23      wiz      9230: <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
1.1       dsieger  9231: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9232: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9233: <p>If a package installs images under the
                   9234:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9235:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9236:     database, you need to take some extra steps to make sure that the
                   9237:     shared theme directory is handled appropriately and that the cache
                   9238:     database is rebuilt:</p>
1.23      wiz      9239: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9240: <li class="listitem"><p>Include
1.1       dsieger  9241:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      9242: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  9243:        entry that refers to the theme cache.</p></li>
1.23      wiz      9244: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  9245:          directories from the <code class="filename">share/icons/hicolor</code>
                   9246:          hierarchy because they will be handled automatically.</p></li>
                   9247: </ol></div>
                   9248: <p>The best way to verify that the PLIST is correct with
                   9249:       respect to the last two points is to regenerate it using
1.10      hubertf  9250:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  9251: </div>
1.23      wiz      9252: <div class="sect2" title="19.6.20. Packages installing desktop files">
1.1       dsieger  9253: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9254: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  9255: <p>If a package installs <code class="filename">.desktop</code> files
                   9256:       under <code class="filename">share/applications</code> and these include
                   9257:       MIME information, you need to take extra steps to ensure that they
                   9258:       are registered into the MIME database:</p>
1.23      wiz      9259: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9260: <li class="listitem"><p>Include
1.1       dsieger  9261:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      9262: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  9263:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9264:          It will be handled automatically.</p></li>
                   9265: </ol></div>
                   9266: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  9267:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  9268:       print-PLIST</strong></span>.</p>
                   9269: </div>
                   9270: </div>
1.23      wiz      9271: <div class="sect1" title="19.7. Marking packages as having problems">
1.1       dsieger  9272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9273: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9274: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 9275:   immediately. In this case, one can plainly mark a package as broken.  For
                   9276:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9277:   reason why the package is broken (similar to the
                   9278:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9279:   the package will immediately be shown this message, and the build
                   9280:   will not be even tried.</p>
                   9281: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  9282:   intervals.</p>
                   9283: </div>
                   9284: </div>
1.23      wiz      9285: <div class="chapter" title="Chapter 20. Debugging">
1.1       dsieger  9286: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9287: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9288: <p>To check out all the gotchas when building a package, here are
                   9289:   the steps that I do in order to get a package working.  Please note
                   9290:   this is basically the same as what was explained in the previous
                   9291:   sections, only with some debugging aids.</p>
1.23      wiz      9292: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9293: <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>
                   9294: <li class="listitem">
1.1       dsieger  9295: <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>,
                   9296:       create a directory for a new package, change into it, then run
1.10      hubertf  9297:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  9298: <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>
                   9299: <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>
                   9300: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9301: </li>
1.23      wiz      9302: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9303: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9304: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9305: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  9306:       configure step to the package's
                   9307:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      9308: <li class="listitem">
1.1       dsieger  9309: <p>Make the package compile, doing multiple rounds of</p>
                   9310: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9311: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9312: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9313: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9314: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9315: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9316: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9317: <p>Doing this step as non-root user will ensure that no files
                   9318:       are modified that shouldn't be, especially during the build
1.10      hubertf  9319:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9320:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1       dsieger  9321:       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>
                   9322:       package.</p>
                   9323: </li>
1.23      wiz      9324: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9325:       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>
                   9326: <li class="listitem">
1.1       dsieger  9327: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9329: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9330: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9331: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9332: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9333: <p>You usually need to be <code class="username">root</code> to do
                   9334:       this.  Look if there are any files left:</p>
                   9335: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9336: <p>If this reveals any files that are missing in
                   9337:       <code class="filename">PLIST</code>, add them.</p>
                   9338: </li>
1.23      wiz      9339: <li class="listitem">
1.1       dsieger  9340: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9341:       package again and make a binary package:</p>
                   9342: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9343: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9344: </li>
1.23      wiz      9345: <li class="listitem">
1.1       dsieger  9346: <p>Delete the installed package:</p>
                   9347: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9348: </li>
1.23      wiz      9349: <li class="listitem">
1.10      hubertf  9350: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  9351:       command, which shouldn't find anything now:</p>
                   9352: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9353: </li>
1.23      wiz      9354: <li class="listitem">
1.1       dsieger  9355: <p>Reinstall the binary package:</p>
                   9356: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9357: </li>
1.23      wiz      9358: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9359: <li class="listitem">
1.10      hubertf  9360: <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  9361:       reports:</p>
                   9362: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9363: </li>
1.23      wiz      9364: <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  9365: </ul></div>
                   9366: </div>
1.23      wiz      9367: <div class="chapter" title="Chapter 21. Submitting and Committing">
1.1       dsieger  9368: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9369: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9370: <div class="toc">
                   9371: <p><b>Table of Contents</b></p>
                   9372: <dl>
1.6       rillig   9373: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9374: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9375: <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      9376: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6       rillig   9377: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20      snj      9378: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9379: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9380: </dl>
                   9381: </div>
1.23      wiz      9382: <div class="sect1" title="21.1. Submitting binary packages">
1.1       dsieger  9383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9384: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9385: <p>Our policy is that we accept binaries only from pkgsrc
                   9386:        developers to guarantee that the packages don't contain any
                   9387:        trojan horses etc. This is not to annoy anyone but rather to
                   9388:        protect our users! You're still free to put up your home-made
                   9389:        binary packages and tell the world where to get them. NetBSD
                   9390:        developers doing bulk builds and wanting to upload them please
1.10      hubertf  9391:        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  9392: </div>
1.23      wiz      9393: <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
1.1       dsieger  9394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9395: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9396: <p>First, check that your package is complete, compiles and
1.10      hubertf  9397:        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 9398:        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  9399:        archive that contains all files that make up the package.
                   9400:        Finally, send this package to the pkgsrc bug tracking system,
1.29      dholland 9401:        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  9402:        that, go to the web page
1.10      hubertf  9403:        <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      9404:        which contains some instructions and a link to a form where you
                   9405:        can submit packages.  The
                   9406:        <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
                   9407:        also available as a substitute for either of the above two tools.
                   9408:        </p>
1.1       dsieger  9409: <p>In the form of the problem report, the category should be
1.23      wiz      9410:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9411:        and version number, and the description field should contain a
                   9412:        short description of your package (contents of the COMMENT
                   9413:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      9414:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  9415: <p>If you want to submit several packages, please send a
                   9416:        separate PR for each one, it's easier for us to track things
                   9417:        that way.</p>
                   9418: <p>Alternatively, you can also import new packages into
1.23      wiz      9419:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.10      hubertf  9420:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger  9421:        for details.</p>
                   9422: </div>
1.23      wiz      9423: <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
1.1       dsieger  9424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9425: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9426: <p>Please note all package additions, updates, moves, and
                   9427:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9428:        important to keep this file up to date and conforming to the
                   9429:        existing format, because it will be used by scripts to
1.10      hubertf  9430:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9431:        sites. Additionally, check the
                   9432:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9433:        for the package you updated or removed, in case it was mentioned
                   9434:        there.</p>
                   9435: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9436:        bumped, the change should appear in
                   9437:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9438:        related or otherwise relevant. Mass bumps that result from a
                   9439:        dependency being updated should not be mentioned. In all other
                   9440:        cases it's the developer's decision.</p>
                   9441: <p>There is a make target that helps in creating proper
1.10      hubertf  9442:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9443:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9444:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9445:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9446:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9447:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9448:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9449:   For new packages, or package moves or removals, set the
                   9450:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9451:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9452:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9453:   not the same as your NetBSD login name. The target also automatically
                   9454:   removes possibly existing entries for the package in the
                   9455:   <code class="filename">TODO</code> file. Don't forget to commit
                   9456:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
                   9457:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9458:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9459:   makes the cvs commands use the main repository.
                   9460:   </p>
1.1       dsieger  9461: </div>
1.33      wiz      9462: <div class="sect1" title="21.4. Committing: Adding a package to CVS">
1.1       dsieger  9463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33      wiz      9464: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  9465: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      9466:   access to the pkgsrc repository.</p>
                   9467: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9468: Start by adding the directory and then files in the directory. Don't
                   9469: forget to add the new package to the category's
                   9470: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9471: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9472: <pre class="programlisting">
                   9473: <code class="prompt">$</code> cd .../pkgsrc/category
                   9474: <code class="prompt">$</code> cvs add pkgname
                   9475: <code class="prompt">$</code> cd pkgname
                   9476: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9477: <code class="prompt">$</code> cvs add patches/p*
                   9478: <code class="prompt">$</code> cvs status | less
1.34    ! wiz      9479: <code class="prompt">$</code> cvs commit
1.33      wiz      9480: <code class="prompt">$</code> cd ..
                   9481: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34    ! wiz      9482: <code class="prompt">$</code> cvs commit Makefile
1.33      wiz      9483: </pre>
1.1       dsieger  9484: <p>The commit message of the initial import should include part of the
                   9485:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9486:   what the package is/does.</p>
1.33      wiz      9487: <p>Also mention the new package in
                   9488: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9489: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9490: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  9491: </div>
1.23      wiz      9492: <div class="sect1" title="21.5. Updating a package to a newer version">
1.1       dsieger  9493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9494: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9495: <p>Please always put a concise, appropriate and relevant summary of the
                   9496:   changes between old and new versions into the commit log when updating
                   9497:   a package. There are various reasons for this:</p>
1.23      wiz      9498: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9499: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9500:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9501: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9502:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9503: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9504:   repository is very useful for people who read the pkgsrc-changes mailing
                   9505:   list, so that they can make tactical decisions about when to upgrade
                   9506:   the package.</p></li>
                   9507: </ul></div>
                   9508: <p>Please also recognize that, just because a new version of a package
                   9509:   has been released, it should not automatically be upgraded in the CVS
                   9510:   repository.  We prefer to be conservative in the packages that are
                   9511:   included in pkgsrc - development or beta packages are not really the
                   9512:   best thing for most places in which pkgsrc is used. Please use your
                   9513:   judgement about what should go into pkgsrc, and bear in mind that
                   9514:   stability is to be preferred above new and possibly untested features.</p>
                   9515: </div>
1.23      wiz      9516: <div class="sect1" title="21.6. Renaming a package in pkgsrc">
1.1       dsieger  9517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20      snj      9518: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9519: <p>Renaming packages is not recommended.</p>
                   9520: <p>When renaming packages, be sure to fix any references to old name
                   9521:   in other Makefiles, options, buildlink files, etc.</p>
                   9522: <p>Also When renaming a package, please define
                   9523:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9524:   pattern(s) of the previous package name.
                   9525:   This may be repeated for multiple renames.
                   9526:   The new package would be an exact replacement.
                   9527: </p>
1.23      wiz      9528: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9529:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9530:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9531:   not be an exact replacement but is a suggestion for the replaced
                   9532:   functionality.</p>
                   9533: </div>
1.23      wiz      9534: <div class="sect1" title="21.7. Moving a package in pkgsrc">
1.20      snj      9535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9536: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9537: <p>It is preferred that packages are not renamed or moved, but if needed
                   9538:   please follow these steps.
                   9539: </p>
1.23      wiz      9540: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9541: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9542: <li class="listitem">
1.1       dsieger  9543: <p>Remove all CVS dirs.</p>
                   9544: <p>Alternatively to the first two steps you can also do:</p>
                   9545: <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>
                   9546: <p>and use that for further work.</p>
                   9547: </li>
1.23      wiz      9548: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9549: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9550: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9551: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      9552: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9553: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9554: for doing an update using pkgsrc building; for example, it can
1.29      dholland 9555: 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      9556: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9557: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9558: it may have multiple matches, so the tool should also check on the
                   9559: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9560: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9561: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9562: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9563: place.</p></li>
1.23      wiz      9564: <li class="listitem">
1.1       dsieger  9565: <p>Check if any package depends on it:
                   9566: </p>
                   9567: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9568: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9569: </li>
1.23      wiz      9570: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9571: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9572: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9573: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9574: <li class="listitem">
1.1       dsieger  9575: <p>Commit the changed and removed files:</p>
                   9576: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9577: <p>(and any packages from step 5, of course).</p>
                   9578: </li>
                   9579: </ol></div>
                   9580: </div>
                   9581: </div>
1.23      wiz      9582: <div class="chapter" title="Chapter 22. Frequently Asked Questions">
1.1       dsieger  9583: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9584: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9585: <p>This section contains the answers to questions that may
                   9586:        arise when you are writing a package. If you don't find your
                   9587:        question answered here, first have a look in the other chapters,
                   9588:        and if you still don't have the answer, ask on the
                   9589:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.23      wiz      9590: <div class="qandaset" title="Frequently Asked Questions">
1.34    ! wiz      9591: <a name="id1168229304425"></a><dl>
1.6       rillig   9592: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9593:        MAKEFLAGS, .MAKEFLAGS and
                   9594:        MAKE_FLAGS?</a>
                   9595: </dt>
1.6       rillig   9596: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9597:        MAKE, GMAKE and
                   9598:        MAKE_PROGRAM?</a>
                   9599: </dt>
1.6       rillig   9600: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9601:        CC, PKG_CC and
                   9602:        PKGSRC_COMPILER?</a>
                   9603: </dt>
1.6       rillig   9604: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9605:        BUILDLINK_LDFLAGS,
                   9606:        BUILDLINK_LDADD and
                   9607:        BUILDLINK_LIBS?</a>
                   9608: </dt>
1.6       rillig   9609: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9610:        VARNAME=BUILDLINK_PREFIX.foo
                   9611:        say it's empty?</a>
                   9612: </dt>
1.6       rillig   9613: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9614:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9615:        don't understand the := inside
                   9616:        it.</a>
                   9617: </dt>
1.6       rillig   9618: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9619:        developers?</a>
                   9620: </dt>
1.6       rillig   9621: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9622:        documentation?</a>
                   9623: </dt>
1.6       rillig   9624: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9625: do?</a>
                   9626: </dt>
                   9627: </dl>
1.23      wiz      9628: <table border="0" width="100%" summary="Q and A Set">
1.1       dsieger  9629: <col align="left" width="1%">
1.23      wiz      9630: <col>
1.1       dsieger  9631: <tbody>
1.23      wiz      9632: <tr class="question" title="22.1.">
1.1       dsieger  9633: <td align="left" valign="top">
1.34    ! wiz      9634: <a name="devfaq.makeflags"></a><a name="id1168229304428"></a><p><b>22.1.</b></p>
1.1       dsieger  9635: </td>
                   9636: <td align="left" valign="top"><p>What is the difference between
                   9637:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9638:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9639: </tr>
                   9640: <tr class="answer">
                   9641: <td align="left" valign="top"></td>
                   9642: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29      dholland 9643:        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  9644:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9645:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9646:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9647: </tr>
1.23      wiz      9648: <tr class="question" title="22.2.">
1.1       dsieger  9649: <td align="left" valign="top">
1.34    ! wiz      9650: <a name="devfaq.make"></a><a name="id1168229287020"></a><p><b>22.2.</b></p>
1.1       dsieger  9651: </td>
                   9652: <td align="left" valign="top"><p>What is the difference between
                   9653:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9654:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9655: </tr>
                   9656: <tr class="answer">
                   9657: <td align="left" valign="top"></td>
                   9658: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29      dholland 9659:        <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  9660:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9661:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9662:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9663:        Make program that is used for building the
                   9664:        package.</p></td>
                   9665: </tr>
1.23      wiz      9666: <tr class="question" title="22.3.">
1.1       dsieger  9667: <td align="left" valign="top">
1.34    ! wiz      9668: <a name="devfaq.cc"></a><a name="id1168229287057"></a><p><b>22.3.</b></p>
1.1       dsieger  9669: </td>
                   9670: <td align="left" valign="top"><p>What is the difference between
                   9671:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9672:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9673: </tr>
                   9674: <tr class="answer">
                   9675: <td align="left" valign="top"></td>
                   9676: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9677:        compiler, which can be configured by the pkgsrc user.
                   9678:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9679:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9680:        path to a compiler, but the type of compiler that should be
                   9681:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9682:        information about the latter variable.</p></td>
                   9683: </tr>
1.23      wiz      9684: <tr class="question" title="22.4.">
1.1       dsieger  9685: <td align="left" valign="top">
1.34    ! wiz      9686: <a name="devfaq.bl3flags"></a><a name="id1168229287092"></a><p><b>22.4.</b></p>
1.1       dsieger  9687: </td>
                   9688: <td align="left" valign="top"><p>What is the difference between
                   9689:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9690:        <code class="varname">BUILDLINK_LDADD</code> and
                   9691:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9692: </tr>
                   9693: <tr class="answer">
                   9694: <td align="left" valign="top"></td>
                   9695: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9696: </tr>
1.23      wiz      9697: <tr class="question" title="22.5.">
1.1       dsieger  9698: <td align="left" valign="top">
1.34    ! wiz      9699: <a name="devfaq.bl3prefix"></a><a name="id1168229287110"></a><p><b>22.5.</b></p>
1.1       dsieger  9700: </td>
1.10      hubertf  9701: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9702:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9703:        say it's empty?</p></td>
                   9704: </tr>
                   9705: <tr class="answer">
                   9706: <td align="left" valign="top"></td>
                   9707: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9708:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9709:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9710:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9711:        command.</p></td>
                   9712: </tr>
1.23      wiz      9713: <tr class="question" title="22.6.">
1.1       dsieger  9714: <td align="left" valign="top">
1.34    ! wiz      9715: <a name="devfaq.master_sites"></a><a name="id1168229287136"></a><p><b>22.6.</b></p>
1.1       dsieger  9716: </td>
                   9717: <td align="left" valign="top"><p>What does
                   9718:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9719:        don't understand the <code class="literal">:=</code> inside
                   9720:        it.</p></td>
                   9721: </tr>
                   9722: <tr class="answer">
                   9723: <td align="left" valign="top"></td>
                   9724: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9725:        assignment operator, like you might expect at first sight.
                   9726:        Instead, it is a degenerate form of
                   9727:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29      dholland 9728:        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  9729:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9730:        case of <code class="varname">MASTER_SITE_*</code>,
                   9731:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9732:        <em class="replaceable"><code>new_string</code></em> is
                   9733:        <code class="literal">package/</code>. That's where the
                   9734:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9735:        together.</p></td>
                   9736: </tr>
1.23      wiz      9737: <tr class="question" title="22.7.">
1.1       dsieger  9738: <td align="left" valign="top">
1.34    ! wiz      9739: <a name="devfaq.mailinglists"></a><a name="id1168229287203"></a><p><b>22.7.</b></p>
1.1       dsieger  9740: </td>
                   9741: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9742:        developers?</p></td>
                   9743: </tr>
                   9744: <tr class="answer">
                   9745: <td align="left" valign="top"></td>
                   9746: <td align="left" valign="top"><div class="variablelist"><dl>
1.10      hubertf  9747: <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  9748: <dd><p>This is a list for technical discussions related
                   9749:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9750:        pkgsrc infrastructure, proposed new features, questions related
                   9751:        to porting pkgsrc to a new platform, advice for maintaining a
                   9752:        package, patches that affect many packages, help requests moved
                   9753:        from pkgsrc-users when an infrastructure bug is found,
                   9754:        etc.</p></dd>
1.10      hubertf  9755: <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  9756: <dd><p>All bug reports in category "pkg" sent with
1.29      dholland 9757:        <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  9758:        directly; use one of the other mailing
                   9759:        lists.</p></dd>
                   9760: </dl></div></td>
                   9761: </tr>
1.23      wiz      9762: <tr class="question" title="22.8.">
1.1       dsieger  9763: <td align="left" valign="top">
1.34    ! wiz      9764: <a name="devfaq.documentation"></a><a name="id1168229287303"></a><p><b>22.8.</b></p>
1.1       dsieger  9765: </td>
                   9766: <td align="left" valign="top"><p>Where is the pkgsrc
                   9767:        documentation?</p></td>
                   9768: </tr>
                   9769: <tr class="answer">
                   9770: <td align="left" valign="top"></td>
                   9771: <td align="left" valign="top">
                   9772: <p>There are many places where you can find
                   9773:        documentation about pkgsrc:</p>
1.23      wiz      9774: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9775: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9776:        of chapters that explain large parts of pkgsrc, but some
                   9777:        chapters tend to be outdated. Which ones they are is hard to
                   9778:        say.</p></li>
1.23      wiz      9779: <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  9780:        about certain features, announcements of new parts of the pkgsrc
                   9781:        infrastructure and sometimes even announcements that a certain
                   9782:        feature has been marked as obsolete. The benefit here is that
                   9783:        each message has a date appended to it.</p></li>
1.23      wiz      9784: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9785:        <code class="filename">mk/</code> directory start with a comment that
                   9786:        describes the purpose of the file and how it can be used by the
                   9787:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9788:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9789:        help</strong></span>.</p></li>
1.23      wiz      9790: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9791:        information, but they tend to be highly abbreviated, especially
                   9792:        for actions that occur often. Some contain a detailed
                   9793:        description of what has changed, but they are geared towards the
                   9794:        other pkgsrc developers, not towards an average pkgsrc user.
                   9795:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9796:        don't know what has been before, these messages may not be worth
                   9797:        too much to you.</p></li>
1.23      wiz      9798: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9799:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9800:        mind of the developer who wrote the code. To get this
1.10      hubertf  9801:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9802:        to see who has written it and ask on the
                   9803:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9804:        find your questions later (see above). To be sure that the
                   9805:        developer in charge reads the mail, you may CC him or
                   9806:        her.</p></li>
                   9807: </ul></div>
                   9808: </td>
                   9809: </tr>
1.23      wiz      9810: <tr class="question" title="22.9.">
1.1       dsieger  9811: <td align="left" valign="top">
1.34    ! wiz      9812: <a name="devfaq.too-much-time"></a><a name="id1168229287426"></a><p><b>22.9.</b></p>
1.1       dsieger  9813: </td>
                   9814: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9815: do?</p></td>
                   9816: </tr>
                   9817: <tr class="answer">
                   9818: <td align="left" valign="top"></td>
                   9819: <td align="left" valign="top">
                   9820: <p>This is not really an FAQ yet, but here's the answer
                   9821: anyway.</p>
1.23      wiz      9822: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9823: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1       dsieger  9824:     <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
                   9825:     will tell you about newer versions of installed packages that are
                   9826:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9827: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9828:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9829:     cleanups and enhancements for pkgsrc that would be nice to
                   9830:     have.</p></li>
1.23      wiz      9831: <li class="listitem"><p>Review packages for which review was requested on
1.10      hubertf  9832:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1       dsieger  9833:     mailing list.</p></li>
                   9834: </ul></div>
                   9835: </td>
                   9836: </tr>
                   9837: </tbody>
                   9838: </table>
                   9839: </div>
                   9840: </div>
1.23      wiz      9841: <div class="chapter" title="Chapter 23. GNOME packaging and porting">
1.1       dsieger  9842: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9843: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9844: <div class="toc">
                   9845: <p><b>Table of Contents</b></p>
                   9846: <dl>
1.6       rillig   9847: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9848: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9849: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9850: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9851: </dl>
                   9852: </div>
1.10      hubertf  9853: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9854: site</a>:</p>
                   9855: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9856:   environment, an intuitive and attractive desktop for users, and the
                   9857:   GNOME development platform, an extensive framework for building
                   9858:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9859: <p>pkgsrc provides a seamless way to automatically build and install
                   9860: a complete GNOME environment <span class="emphasis"><em>under many different
                   9861: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9862: the most advanced build and packaging systems for GNOME due to its
                   9863: included technologies buildlink3, the wrappers and tools framework and
                   9864: automatic configuration file management.  Lots of efforts are put into
                   9865: achieving a completely clean deinstallation of installed software
                   9866: components.</p>
1.10      hubertf  9867: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9868: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9869: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9870: pkgsrc as its preferred packaging system, contributing lots of
                   9871: portability fixes to make GNOME build and install under it.</p>
                   9872: <p>This chapter is aimed at pkgsrc developers and other people
                   9873: interested in helping our GNOME porting and packaging efforts.  It
                   9874: provides instructions on how to manage the existing packages and some
                   9875: important information regarding their internals.</p>
1.23      wiz      9876: <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9877: <h3 class="title">We need your help!</h3>
                   9878: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9879:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9880:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9881:   work</a> list!  There is still a long way to go to get a
                   9882:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9883:   achieve it!</p>
                   9884: </div>
1.23      wiz      9885: <div class="sect1" title="23.1. Meta packages">
1.1       dsieger  9886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9887: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9888: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.23      wiz      9889: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9890: <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  9891:     the core GNOME desktop environment.  It only includes the necessary
                   9892:     bits to get it to boot correctly, although it may lack important
                   9893:     functionality for daily operation.  The idea behind this package is
                   9894:     to let end users build their own configurations on top of this one,
                   9895:     first installing this meta package to achieve a functional setup and
                   9896:     then adding individual applications.</p></li>
1.23      wiz      9897: <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  9898:     complete installation of the GNOME platform and desktop as defined
                   9899:     by the GNOME project; this is based on the components distributed in
                   9900:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9901:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9902:     official FTP server.  Developer-only tools found in those
                   9903:     directories are not installed unless required by some other
                   9904:     component to work properly.  Similarly, packages from the bindings
                   9905:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9906:     in unless required as a dependency for an end-user component.  This
                   9907:     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      9908: <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  9909:     Installs all the tools required to build a GNOME component when
                   9910:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9911:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9912: </ul></div>
                   9913: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9914: sorted in a way that eases updates: a package may depend on other
                   9915: packages listed before it but not on any listed after it.  It is very
                   9916: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9917: change it to alphabetical sorting!</em></span></p>
                   9918: </div>
1.23      wiz      9919: <div class="sect1" title="23.2. Packaging a GNOME application">
1.1       dsieger  9920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9921: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9922: <p>Almost all GNOME applications are written in C and use a common
                   9923: set of tools as their build system.  Things get different with the new
                   9924: bindings to other languages (such as Python), but the following will
                   9925: give you a general idea on the minimum required tools:</p>
1.23      wiz      9926: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   9927: <li class="listitem">
1.1       dsieger  9928: <p>Almost all GNOME applications use the GNU Autotools as their
                   9929:     build system.  As a general rule you will need to tell this to your
                   9930:     package:</p>
                   9931: <pre class="programlisting">
                   9932: GNU_CONFIGURE=yes
                   9933: USE_LIBTOOL=yes
                   9934: USE_TOOLS+=gmake
                   9935: </pre>
                   9936: </li>
1.23      wiz      9937: <li class="listitem">
1.1       dsieger  9938: <p>If the package uses pkg-config to detect dependencies, add this
                   9939:     tool to the list of required utilities:</p>
                   9940: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   9941: <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
                   9942:     the end of the build process to ensure that you did not miss to
                   9943:     specify any dependency in your package and that the version
                   9944:     requirements are all correct.</p>
                   9945: </li>
1.23      wiz      9946: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9947:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9948:     to handle dependencies and to force the package to use the latest
                   9949:     available version.</p></li>
1.23      wiz      9950: <li class="listitem">
1.1       dsieger  9951: <p>If the package uses gtk-doc (a documentation generation
                   9952:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9953:     tool is rather big and the distfile should come with pregenerated
                   9954:     documentation anyway; if it does not, it is a bug that you ought to
                   9955:     report.  For such packages you should disable gtk-doc (unless it is
                   9956:     the default):</p>
                   9957: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9958: <p>The default location of installed HTML files
                   9959:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9960:     and should not be changed unless the package insists on installing
                   9961:     them somewhere else.  Otherwise programs as
1.10      hubertf  9962:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9963:     do that with an entry similar to:</p>
                   9964: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   9965: </li>
                   9966: </ul></div>
                   9967: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9968: files under the installation prefix to maintain databases.  In this
                   9969: context, shared means that those exact same directories and files are
                   9970: used among several different packages, leading to conflicts in the
                   9971: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9972: handle the most common cases, so you have to forget about using
                   9973: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9974: omitting shared files from them.  If you find yourself doing those,
                   9975: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9976: <p>The following table lists the common situations that result in
                   9977: using shared directories or files.  For each of them, the appropriate
                   9978: solution is given.  After applying the solution be sure to
                   9979: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  9980: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  9981: <div class="table">
1.6       rillig   9982: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  9983: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   9984: <colgroup>
                   9985: <col>
                   9986: <col>
                   9987: </colgroup>
                   9988: <thead><tr>
                   9989: <th>If the package...</th>
                   9990: <th>Then...</th>
                   9991: </tr></thead>
                   9992: <tbody>
                   9993: <tr>
                   9994: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18      snj      9995: <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  9996: </tr>
                   9997: <tr>
                   9998: <td>Installs icons under the
                   9999:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10000:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  10001: <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  10002: </tr>
                   10003: <tr>
                   10004: <td>Installs files under
                   10005:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  10006: <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  10007: </tr>
                   10008: <tr>
                   10009: <td>Installs <code class="filename">.desktop</code> files under
                   10010:         <code class="filename">share/applications</code> and these include MIME
                   10011:         information.</td>
1.10      hubertf  10012: <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  10013: </tr>
                   10014: </tbody>
                   10015: </table></div>
                   10016: </div>
                   10017: <br class="table-break">
                   10018: </div>
1.23      wiz      10019: <div class="sect1" title="23.3. Updating GNOME to a newer version">
1.1       dsieger  10020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10021: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  10022: <p>When seeing GNOME as a whole, there are two kinds of
                   10023: updates:</p>
                   10024: <div class="variablelist"><dl>
                   10025: <dt><span class="term">Major update</span></dt>
                   10026: <dd>
                   10027: <p>Given that there is still a very long way for GNOME 3 (if it
                   10028:       ever appears), we consider a major update one that goes from a
                   10029:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10030:       where <code class="literal">Y</code> is even and greater than
                   10031:       <code class="literal">X</code>.  These are hard to achieve because they
                   10032:       introduce lots of changes in the components' code and almost all
                   10033:       GNOME distfiles are updated to newer versions.  Some of them can
                   10034:       even break API and ABI compatibility with the previous major
                   10035:       version series.  As a result, the update needs to be done all at
                   10036:       once to minimize breakage.</p>
                   10037: <p>A major update typically consists of around 80 package
                   10038:       updates and the addition of some new ones.</p>
                   10039: </dd>
                   10040: <dt><span class="term">Minor update</span></dt>
                   10041: <dd>
                   10042: <p>We consider a minor update one that goes from a
                   10043:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10044:       one where <code class="literal">Y</code> is greater than
                   10045:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10046:       not update all GNOME components, can be done in an incremental way
                   10047:       and do not break API nor ABI compatibility.</p>
                   10048: <p>A minor update typically consists of around 50 package
                   10049:       updates, although the numbers here may vary a lot.</p>
                   10050: </dd>
                   10051: </dl></div>
                   10052: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10053: release (either major or minor), the following steps should be
                   10054: followed:</p>
1.23      wiz      10055: <div class="orderedlist"><ol class="orderedlist" type="1">
                   10056: <li class="listitem">
1.1       dsieger  10057: <p>Get a list of all the tarballs that form the new release by
                   10058:     using the following commands.  These will leave the full list of the
1.18      snj      10059:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  10060:     file:</p>
                   10061: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10062:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10063:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10064: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10065:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10066:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10067: </li>
1.23      wiz      10068: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  10069:     bump their version to the release you are updating them to.  The
                   10070:     three meta packages should be always consistent with versioning.
                   10071:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10072:     in them.</p></li>
1.23      wiz      10073: <li class="listitem">
1.1       dsieger  10074: <p>For each meta package, update all its
                   10075:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10076:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10077:     newer version (even if found in the FTP) because the meta packages
                   10078:     are supposed to list the exact versions that form a specific GNOME
                   10079:     release.  Exceptions are permitted here if a newer version solves a
                   10080:     serious issue in the overall desktop experience; these typically
                   10081:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10082:     from the developers.</p>
                   10083: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10084:     should be updated to the latest version available (if found in
                   10085:     pkgsrc).  This is the case, for example, of the dependencies on the
                   10086:     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>
                   10087: </li>
1.23      wiz      10088: <li class="listitem">
1.1       dsieger  10089: <p>Generate a patch from the modified meta packages and extract the
                   10090:     list of "new" lines.  This will provide you an outline on what
                   10091:     packages need to be updated in pkgsrc and in what order:</p>
                   10092: <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>
                   10093: </li>
1.23      wiz      10094: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  10095:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      10096: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  10097:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10098:     it in order.  For major desktop updates none of these should be
                   10099:     committed until the entire set is completed because there are chances
                   10100:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      10101: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  10102:     the tree one by one with appropriate log messages.  At the end,
                   10103:     commit the three meta package updates and all the corresponding
                   10104:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10105:     <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>
                   10106: </ol></div>
                   10107: </div>
1.23      wiz      10108: <div class="sect1" title="23.4. Patching guidelines">
1.1       dsieger  10109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10110: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  10111: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10112: packages.  Please, it is very important that you always, always,
                   10113: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  10114: 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  10115: their attention on portability issues and to ensure that future versions
                   10116: can be built out-of-the box on NetBSD.  The less custom patches in
                   10117: pkgsrc, the easier further updates are.  Those developers in charge of
                   10118: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  10119: <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  10120: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10121: of them do.  Do not be short on your reports: always provide detailed
                   10122: explanations of the current failure, how it can be improved to achieve
                   10123: maximum portability and, if at all possible, provide a patch against CVS
                   10124: head.  The more verbose you are, the higher chances of your patch being
                   10125: accepted.</p>
                   10126: <p>Also, please avoid using preprocessor magic to fix portability
                   10127: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10128: GNOME to their operating system, the official GNOME sources are now
                   10129: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10130: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  10131: 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  10132: details.</p>
                   10133: </div>
                   10134: </div>
                   10135: </div>
1.23      wiz      10136: <div class="part" title="Part III. The pkgsrc infrastructure internals">
1.1       dsieger  10137: <div class="titlepage"><div><div><h1 class="title">
                   10138: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.23      wiz      10139: <div class="partintro" title="The pkgsrc infrastructure internals">
1.1       dsieger  10140: <div></div>
                   10141: <p>This part of the guide deals with everything
                   10142:        from the infrastructure that is behind the interfaces described
                   10143:        in the developer's guide. A casual package maintainer should not
                   10144:        need anything from this part.</p>
                   10145: <div class="toc">
                   10146: <p><b>Table of Contents</b></p>
                   10147: <dl>
1.6       rillig   10148: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10149: <dd><dl>
1.6       rillig   10150: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10151: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10152: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10153: <dd><dl>
1.6       rillig   10154: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10155: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10156: </dl></dd>
1.6       rillig   10157: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10158: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10159: <dd><dl>
1.6       rillig   10160: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10161: <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  10162: </dl></dd>
1.6       rillig   10163: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10164: <dd><dl>
1.23      wiz      10165: <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>
                   10166: <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  10167: </dl></dd>
                   10168: </dl></dd>
1.6       rillig   10169: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10170: <dd><dl>
1.6       rillig   10171: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10172: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10173: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10174: <dd><dl>
1.6       rillig   10175: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10176: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10177: </dl></dd>
                   10178: </dl></dd>
1.6       rillig   10179: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10180: <dd><dl>
1.6       rillig   10181: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10182: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10183: </dl></dd>
                   10184: </dl>
                   10185: </div>
                   10186: </div>
1.23      wiz      10187: <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
1.1       dsieger  10188: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10189: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10190: <div class="toc">
                   10191: <p><b>Table of Contents</b></p>
                   10192: <dl>
1.6       rillig   10193: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10194: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10195: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10196: <dd><dl>
1.6       rillig   10197: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10198: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10199: </dl></dd>
1.6       rillig   10200: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10201: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10202: <dd><dl>
1.6       rillig   10203: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10204: <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  10205: </dl></dd>
1.6       rillig   10206: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10207: <dd><dl>
1.23      wiz      10208: <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>
                   10209: <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  10210: </dl></dd>
                   10211: </dl>
                   10212: </div>
                   10213: <p>The pkgsrc infrastructure consists of many small Makefile
                   10214:        fragments. Each such fragment needs a properly specified
                   10215:        interface. This chapter explains how such an interface looks
                   10216:        like.</p>
1.23      wiz      10217: <div class="sect1" title="24.1. The meaning of variable definitions">
1.1       dsieger  10218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10219: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10220: <p>Whenever a variable is defined in the pkgsrc
                   10221:        infrastructure, the location and the way of definition provide
                   10222:        much information about the intended use of that variable.
                   10223:        Additionally, more documentation may be found in a header
                   10224:        comment or in this pkgsrc guide.</p>
                   10225: <p>A special file is
                   10226:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10227:        variables that are intended to be user-defined. They are either
                   10228:        defined using the <code class="literal">?=</code> operator or they are
                   10229:        left undefined because defining them to anything would
1.23      wiz      10230:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10231:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10232:        file.</p>
                   10233: <p>Outside this file, the following conventions apply:
                   10234:        Variables that are defined using the <code class="literal">?=</code>
                   10235:        operator may be overridden by a package.</p>
                   10236: <p>Variables that are defined using the <code class="literal">=</code>
                   10237:        operator may be used read-only at run-time.</p>
                   10238: <p>Variables whose name starts with an underscore must not be
                   10239:        accessed outside the pkgsrc infrastructure at all. They may
                   10240:        change without further notice.</p>
1.23      wiz      10241: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10242: <h3 class="title">Note</h3>
                   10243: <p>These conventions are currently not applied
                   10244:        consistently to the complete pkgsrc
                   10245:        infrastructure.</p>
                   10246: </div>
                   10247: </div>
1.23      wiz      10248: <div class="sect1" title="24.2. Avoiding problems before they arise">
1.1       dsieger  10249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10250: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10251: <p>All variables that contain lists of things should default
                   10252:        to being empty. Two examples that do not follow this rule are
                   10253:        <code class="varname">USE_LANGUAGES</code> and
                   10254:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10255:        modified using the <code class="literal">+=</code> operator in package
                   10256:        <code class="filename">Makefile</code>s (or other files included by
                   10257:        them), since there is no guarantee whether the variable is
                   10258:        already set or not, and what its value is. In the case of
1.23      wiz      10259:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10260:        the default value and just define it as in the following
                   10261:        example.</p>
                   10262: <pre class="programlisting">
                   10263: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10264: </pre>
                   10265: <p>Because of the selection of this default value, the same
                   10266:        value appears in many package Makefiles. Similarly for
                   10267:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10268:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10269:        doesn't stand out. Nevertheless it is mentioned in many
                   10270:        files.</p>
                   10271: </div>
1.23      wiz      10272: <div class="sect1" title="24.3. Variable evaluation">
1.1       dsieger  10273: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10274: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.23      wiz      10275: <div class="sect2" title="24.3.1. At load time">
1.1       dsieger  10276: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10277: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10278: <p>Variable evaluation takes place either at load time or at
                   10279:        runtime, depending on the context in which they occur. The
                   10280:        contexts where variables are evaluated at load time are:</p>
1.23      wiz      10281: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   10282: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10283:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10284: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10285:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10286: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10287: </ul></div>
                   10288: <p>A special exception are references to the iteration
                   10289:        variables of <code class="literal">.for</code> loops, which are expanded
                   10290:        inline, no matter in which context they appear.</p>
                   10291: <p>As the values of variables may change during load time,
                   10292:        care must be taken not to evaluate them by accident. Typical
                   10293:        examples for variables that should not be evaluated at load time
                   10294:        are <code class="varname">DEPENDS</code> and
                   10295:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10296:        clear, here is an example:</p>
                   10297: <pre class="programlisting">
                   10298: CONFIGURE_ARGS=         # none
                   10299: CFLAGS=                 -O
                   10300: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10301: 
                   10302: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10303: 
                   10304: CFLAGS+=                -Wall
                   10305:        </pre>
                   10306: <p>This code shows how the use of the <code class="literal">:=</code>
                   10307:        operator can quickly lead to unexpected results. The first
                   10308:        paragraph is fairly common code. The second paragraph evaluates
                   10309:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10310:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10311:        <code class="literal">-Wall</code> is appended to the
                   10312:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10313:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10314:        paragraphs from above typically occur in completely unrelated
                   10315:        files.</p>
                   10316: </div>
1.23      wiz      10317: <div class="sect2" title="24.3.2. At runtime">
1.1       dsieger  10318: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10319: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10320: <p>After all the files have been loaded, the values of the
                   10321:        variables cannot be changed anymore. Variables that are used in
                   10322:        the shell commands are expanded at this point.</p>
                   10323: </div>
                   10324: </div>
1.23      wiz      10325: <div class="sect1" title="24.4. How can variables be specified?">
1.1       dsieger  10326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10327: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10328: <p>There are many ways in which the definition and use of a
                   10329:        variable can be restricted in order to detect bugs and
                   10330:        violations of the (mostly unwritten) policies. See the
                   10331:        <code class="literal">pkglint</code> developer's documentation for further
                   10332:        details.</p>
                   10333: </div>
1.23      wiz      10334: <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
1.1       dsieger  10335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10336: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10337: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10338:        of the following classes. Cases where a file falls into more
                   10339:        than one class should be avoided as it often leads to subtle
                   10340:        bugs.</p>
1.23      wiz      10341: <div class="sect2" title="24.5.1. Procedures with parameters">
1.1       dsieger  10342: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10343: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10344: <p>In a traditional imperative programming language some of
                   10345:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10346:        procedures. They take some input parameters and&mdash;after
                   10347:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10348:        variables in <code class="filename">Makefile</code>s have global scope
                   10349:        care must be taken not to use parameter names that have already
                   10350:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10351:        bad choice for a parameter name.</p>
                   10352: <p>Procedures are completely evaluated at preprocessing time.
                   10353:        That is, when calling a procedure all input parameters must be
                   10354:        completely resolvable. For example,
                   10355:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10356:        parameter since it is very likely that further text will be
                   10357:        added after calling the procedure, which would effectively apply
                   10358:        the procedure to only a part of the variable. Also, references
                   10359:        to other variables wit will be modified after calling the
                   10360:        procedure.</p>
                   10361: <p>A procedure can declare its output parameters either as
                   10362:        suitable for use in preprocessing directives or as only
                   10363:        available at runtime. The latter alternative is for variables
                   10364:        that contain references to other runtime variables.</p>
                   10365: <p>Procedures shall be written such that it is possible to
                   10366:        call the procedure more than once. That is, the file must not
                   10367:        contain multiple-inclusion guards.</p>
                   10368: <p>Examples for procedures are
                   10369:        <code class="filename">mk/bsd.options.mk</code> and
                   10370:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10371:        that the parameters are evaluated at load time, they should be
                   10372:        assigned using the <code class="literal">:=</code> operator, which should
                   10373:        be used only for this purpose.</p>
                   10374: </div>
1.23      wiz      10375: <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
1.1       dsieger  10376: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10377: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10378: <p>Action files take some input parameters and may define
                   10379:        runtime variables. They shall not define loadtime variables.
                   10380:        There are action files that are included implicitly by the
                   10381:        pkgsrc infrastructure, while other must be included
                   10382:        explicitly.</p>
                   10383: <p>An example for action files is
                   10384:        <code class="filename">mk/subst.mk</code>.</p>
                   10385: </div>
                   10386: </div>
1.23      wiz      10387: <div class="sect1" title="24.6. The order in which files are loaded">
1.1       dsieger  10388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10389: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10390: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10391:        a set of variable definitions, and include the file
                   10392:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10393:        Before that, they may also include various other
                   10394:        <code class="filename">*.mk</code> files if they need to query the
                   10395:        availability of certain features like the type of compiler or
                   10396:        the X11 implementation. Due to the heavy use of preprocessor
                   10397:        directives like <code class="literal">.if</code> and
                   10398:        <code class="literal">.for</code>, the order in which the files are loaded
                   10399:        matters.</p>
                   10400: <p>This section describes at which point the various files
                   10401:        are loaded and gives reasons for that order.</p>
1.23      wiz      10402: <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
1.1       dsieger  10403: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10404: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10405: </h3></div></div></div>
                   10406: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10407:        is to define some essential variables like
                   10408:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10409:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10410: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10411:        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   10412:        After that, those variables
1.1       dsieger  10413:        that have not been overridden by the user are loaded from
                   10414:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10415: <p>After the user settings, the system settings and platform
                   10416:        settings are loaded, which may override the user
                   10417:        settings.</p>
                   10418: <p>Then, the tool definitions are loaded. The tool wrappers
                   10419:        are not yet in effect. This only happens when building a
                   10420:        package, so the proper variables must be used instead of the
                   10421:        direct tool names.</p>
                   10422: <p>As the last steps, some essential variables from the
                   10423:        wrapper and the package system flavor are loaded, as well as the
                   10424:        variables that have been cached in earlier phases of a package
                   10425:        build.</p>
                   10426: </div>
1.23      wiz      10427: <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
1.1       dsieger  10428: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10429: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10430: </h3></div></div></div>
                   10431: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10432: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10433:        loaded, which fill default values for those variables that have
                   10434:        not been defined by the package. These variables may later
                   10435:        be used even in unrelated files.</p>
                   10436: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10437:        provides the target <code class="literal">error-check</code> that is added
                   10438:        as a special dependency to all other targets that use
                   10439:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10440:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10441: <p>Then, the package-specific hacks from
                   10442:        <code class="filename">hacks.mk</code> are included.</p>
                   10443: <p>Then, various other files follow. Most of them don't have
                   10444:        any dependencies on what they need to have included before or
                   10445:        after them, though some do.</p>
                   10446: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10447:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10448:        restricts the use of these variables to all the files that have
                   10449:        been included before. Appearances in later files will be
                   10450:        silently ignored.</p>
                   10451: <p>Then, the files for the main targets are included, in the
                   10452:        order of later execution, though the actual order should not
                   10453:        matter.</p>
                   10454: <p>At last, some more files are included that don't set any
                   10455:        interesting variables but rather just define make targets to be
                   10456:        executed.</p>
                   10457: </div>
                   10458: </div>
                   10459: </div>
1.23      wiz      10460: <div class="chapter" title="Chapter 25. Regression tests">
1.1       dsieger  10461: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10462: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10463: <div class="toc">
                   10464: <p><b>Table of Contents</b></p>
                   10465: <dl>
1.6       rillig   10466: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10467: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10468: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10469: <dd><dl>
1.6       rillig   10470: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10471: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10472: </dl></dd>
                   10473: </dl>
                   10474: </div>
                   10475: <p>The pkgsrc infrastructure consists of a large codebase,
                   10476:        and there are many corners where every little bit of a file is
                   10477:        well thought out, making pkgsrc likely to fail as soon as
                   10478:        anything is changed near those parts. To prevent most changes
                   10479:        from breaking anything, a suite of regression tests should go
                   10480:        along with every important part of the pkgsrc infrastructure.
                   10481:        This chapter describes how regression tests work in pkgsrc and
                   10482:        how you can add new tests.</p>
1.23      wiz      10483: <div class="sect1" title="25.1. The regression tests framework">
1.1       dsieger  10484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10485: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10486: <p></p>
                   10487: </div>
1.23      wiz      10488: <div class="sect1" title="25.2. Running the regression tests">
1.1       dsieger  10489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10490: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10491: <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  10492:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10493:        can simply run that command, which will run all tests in the
                   10494:        <code class="filename">regress</code> category.</p>
                   10495: </div>
1.23      wiz      10496: <div class="sect1" title="25.3. Adding a new regression test">
1.1       dsieger  10497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10498: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10499: <p>Every directory in the <code class="filename">regress</code>
                   10500:        category that contains a file called <code class="filename">spec</code>
                   10501:        is considered a regression test. This file is a shell program
1.10      hubertf  10502:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10503:        The following functions can be overridden to suit your
                   10504:        needs.</p>
1.23      wiz      10505: <div class="sect2" title="25.3.1. Overridable functions">
1.1       dsieger  10506: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10507: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10508: <p>These functions do not take any parameters. They are all
1.23      wiz      10509:        called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
1.1       dsieger  10510:        to check the exitcodes of any commands you run in the
                   10511:        test.</p>
                   10512: <div class="variablelist"><dl>
                   10513: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10514: <dd><p>This function prepares the environment for the
                   10515:        test. By default it does nothing.</p></dd>
                   10516: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10517: <dd><p>This function runs the actual test. By default,
                   10518:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10519:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10520:        error messages into the file
                   10521:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10522: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10523: <dd><p>This function is run after the test and is
                   10524:        typically used to compare the actual output from the one that is
                   10525:        expected. It can make use of the various helper functions from
                   10526:        the next section.</p></dd>
                   10527: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10528: <dd><p>This function cleans everything up after the
                   10529:        test has been run. By default it does nothing.</p></dd>
                   10530: </dl></div>
                   10531: </div>
1.23      wiz      10532: <div class="sect2" title="25.3.2. Helper functions">
1.1       dsieger  10533: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10534: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1       dsieger  10535: <div class="variablelist"><dl>
                   10536: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10537: <dd><p>This function compares the exitcode of the
1.10      hubertf  10538:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1       dsieger  10539:        If they differ, the test will fail.</p></dd>
                   10540: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10541: <dd><p>This function checks for each of its parameters
1.10      hubertf  10542:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1       dsieger  10543:        extended regular expression. If it does not, the test will
                   10544:        fail.</p></dd>
                   10545: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10546: <dd><p>This function checks for each of its parameters
1.10      hubertf  10547:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10548:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10549:        If any of the regular expressions matches, the test will
                   10550:        fail.</p></dd>
                   10551: </dl></div>
                   10552: </div>
                   10553: </div>
                   10554: </div>
1.23      wiz      10555: <div class="chapter" title="Chapter 26. Porting pkgsrc">
1.1       dsieger  10556: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10557: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10558: <div class="toc">
                   10559: <p><b>Table of Contents</b></p>
                   10560: <dl>
1.6       rillig   10561: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10562: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10563: </dl>
                   10564: </div>
                   10565: <p>The pkgsrc system has already been ported to many
                   10566:        operating systems, hardware architectures and compilers. This
                   10567:        chapter explains the necessary steps to make pkgsrc even more
                   10568:        portable.</p>
1.23      wiz      10569: <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
1.1       dsieger  10570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10571: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10572: <p>To port pkgsrc to a new operating system (called
                   10573:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10574:        following files:</p>
                   10575: <div class="variablelist"><dl>
                   10576: <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>
                   10577: <dd><p>This file contains some basic definitions, for
                   10578:        example the name of the C
                   10579:        compiler.</p></dd>
                   10580: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10581: <dd><p>Insert code that defines the variables
                   10582:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10583:        <code class="varname">LOWER_OS_VERSION</code>,
                   10584:        <code class="varname">LOWER_VENDOR</code>,
                   10585:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10586:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10587:        appear in this file.</p></dd>
                   10588: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10589: <dd><p>This file contains the platform-specific
                   10590:        definitions that are used by pkgsrc. Start by copying one of the
                   10591:        other files and edit it to your
                   10592:        needs.</p></dd>
                   10593: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10594: <dd><p>This file contains a list of directories,
                   10595:        together with their permission bits and ownership. These
                   10596:        directories will be created automatically with every package
                   10597:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10598:        be removed.</p></dd>
                   10599: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10600: <dd><p>Just copy one of the pre-existing x11.dist files
                   10601:        to your
                   10602:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10603: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10604: <dd><p>On some operating systems, the tools that are
                   10605:        provided with the base system are not good enough for pkgsrc.
1.29      dholland 10606:        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  10607:        narrow limit on the line length they can process. Therefore
                   10608:        pkgsrc brings its own tools, which can be enabled
                   10609:        here.</p></dd>
                   10610: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10611: <dd><p>This file defines the paths to all the tools
                   10612:        that are needed by one or the other package in pkgsrc, as well
                   10613:        as by pkgsrc itself. Find out where these tools are on your
                   10614:        platform and add them.</p></dd>
                   10615: </dl></div>
                   10616: <p>Now, you should be able to build some basic packages, like
                   10617:        <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>
                   10618: </div>
1.23      wiz      10619: <div class="sect1" title="26.2. Adding support for a new compiler">
1.1       dsieger  10620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10621: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10622: <p>TODO</p>
                   10623: </div>
                   10624: </div>
                   10625: </div>
1.23      wiz      10626: <div class="appendix" title="Appendix A. A simple example package: bison">
1.1       dsieger  10627: <div class="titlepage"><div><div><h2 class="title">
                   10628: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10629: <div class="toc">
                   10630: <p><b>Table of Contents</b></p>
                   10631: <dl>
                   10632: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10633: <dd><dl>
                   10634: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10635: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10636: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10637: <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  10638: </dl></dd>
                   10639: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10640: </dl>
                   10641: </div>
                   10642: <p>We checked to find a piece of software that wasn't in the packages
                   10643:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10644:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10645:     present in the tree is beyond us, but it's useful for the purposes of
                   10646:     this exercise.</p>
1.23      wiz      10647: <div class="sect1" title="A.1. files">
1.1       dsieger  10648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10649: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.23      wiz      10650: <div class="sect2" title="A.1.1. Makefile">
1.1       dsieger  10651: <div class="titlepage"><div><div><h3 class="title">
                   10652: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10653: <pre class="programlisting">
                   10654: # $NetBSD$
                   10655: #
                   10656: 
                   10657: DISTNAME=       bison-1.25
                   10658: CATEGORIES=     devel
                   10659: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10660: 
1.29      dholland 10661: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10662: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10663: COMMENT=        GNU yacc clone
                   10664: 
                   10665: GNU_CONFIGURE=  yes
                   10666: INFO_FILES=     bison.info
                   10667: 
                   10668: .include "../../mk/bsd.pkg.mk"
                   10669: </pre>
                   10670: </div>
1.23      wiz      10671: <div class="sect2" title="A.1.2. DESCR">
1.1       dsieger  10672: <div class="titlepage"><div><div><h3 class="title">
                   10673: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10674: <pre class="programlisting">
                   10675: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.29      dholland 10676: 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  10677: of the NetBSD source tree is beyond me.
                   10678: </pre>
                   10679: </div>
1.23      wiz      10680: <div class="sect2" title="A.1.3. PLIST">
1.1       dsieger  10681: <div class="titlepage"><div><div><h3 class="title">
                   10682: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10683: <pre class="programlisting">
                   10684: @comment $NetBSD$
                   10685: bin/bison
                   10686: man/man1/bison.1.gz
                   10687: share/bison.simple
                   10688: share/bison.hairy
                   10689: </pre>
                   10690: </div>
1.23      wiz      10691: <div class="sect2" title="A.1.4. Checking a package with pkglint">
1.1       dsieger  10692: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10693: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10694: </h3></div></div></div>
                   10695: <p>The NetBSD package system comes with
                   10696:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10697:        which helps to check the contents of these
                   10698:        files. After installation it is quite easy to use, just change to the
                   10699:        directory of the package you wish to examine and execute
1.10      hubertf  10700:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10701: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10702: looks fine.</pre>
                   10703: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10704:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10705:        -Wall</strong></span> for a very thorough check.</p>
                   10706: </div>
                   10707: </div>
1.23      wiz      10708: <div class="sect1" title="A.2. Steps for building, installing, packaging">
1.1       dsieger  10709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10710: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10711: <p>Create the directory where the package lives,
                   10712:       plus any auxiliary directories:</p>
                   10713: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10714: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10715: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10716: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10717: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  10718:       <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  10719:       then continue with fetching the distfile:</p>
                   10720: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10721: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10722: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10723: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10724: ftp: Error retrieving file: 500 Internal error
                   10725: 
                   10726: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10727: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10728: ftp: Error retrieving file: 500 Internal error
                   10729: 
                   10730: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10731: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10732: Successfully retrieved file.</pre>
                   10733: <p>Generate the checksum of the distfile into
                   10734:       <code class="filename">distinfo</code>:</p>
                   10735: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10736: <p>Now compile:</p>
                   10737: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10738: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10739: ===&gt;  Extracting for bison-1.25
                   10740: ===&gt;  Patching for bison-1.25
                   10741: ===&gt;   Ignoring empty patch directory
                   10742: ===&gt;  Configuring for bison-1.25
                   10743: creating cache ./config.cache
                   10744: checking for gcc... cc
                   10745: checking whether we are using GNU C... yes
                   10746: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10747: checking how to run the C preprocessor... cc -E
                   10748: checking for minix/config.h... no
                   10749: checking for POSIXized ISC... no
                   10750: checking whether cross-compiling... no
                   10751: checking for ANSI C header files... yes
                   10752: checking for string.h... yes
                   10753: checking for stdlib.h... yes
                   10754: checking for memory.h... yes
                   10755: checking for working const... yes
                   10756: checking for working alloca.h... no
                   10757: checking for alloca... yes
                   10758: checking for strerror... yes
                   10759: updating cache ./config.cache
                   10760: creating ./config.status
                   10761: creating Makefile
                   10762: ===&gt;  Building for bison-1.25
                   10763: 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
                   10764: 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
                   10765: 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
                   10766: 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
                   10767: 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
                   10768: 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
                   10769: 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
                   10770: 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
                   10771: 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
                   10772: 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
                   10773: 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
                   10774: 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
                   10775: 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
                   10776: 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
                   10777: 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
                   10778: 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
                   10779: 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
                   10780: 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
                   10781: 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
                   10782: 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
                   10783: 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
                   10784: 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
                   10785: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10786: rm -f bison.s1
                   10787: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10788: <p>Everything seems OK, so install the files:</p>
                   10789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10790: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10791: ===&gt;  Installing for bison-1.25
                   10792: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10793: rm -f /usr/pkg/bin/bison
                   10794: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10795: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10796: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10797: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10798: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10799: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10800: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10801: ===&gt;  Registering installation for bison-1.25</pre>
                   10802: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10803:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10804:       binary package, do this now:</p>
                   10805: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10806: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10807: ===&gt;  Building package for bison-1.25
                   10808: Creating package bison-1.25.tgz
                   10809: Registering depends:.
                   10810: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10811: <p>Now that you don't need the source and object files
                   10812:       any more, clean up:</p>
                   10813: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10814: ===&gt;  Cleaning for bison-1.25</pre>
                   10815: </div>
                   10816: </div>
1.23      wiz      10817: <div class="appendix" title="Appendix B. Build logs">
1.1       dsieger  10818: <div class="titlepage"><div><div><h2 class="title">
                   10819: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10820: <div class="toc">
                   10821: <p><b>Table of Contents</b></p>
                   10822: <dl>
                   10823: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10824: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10825: </dl>
                   10826: </div>
1.23      wiz      10827: <div class="sect1" title="B.1. Building figlet">
1.1       dsieger  10828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10829: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10830: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10831: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10832: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10833: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10834: =&gt; [172219 bytes]
                   10835: Connected to ftp.plig.net.
                   10836: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10837: 331 Guest login ok, send your complete e-mail address as password.
                   10838: 230-You are user #5 of 500 simultaneous users allowed.
                   10839: 230-
                   10840: 230-  ___ _             _ _
                   10841: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10842: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10843: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10844: 230-         |_|   |_|     |___|         |___|
                   10845: 230-
                   10846: 230-** Welcome to ftp.plig.org **
                   10847: 230-
                   10848: 230-Please note that all transfers from this FTP site are logged. If you
                   10849: 230-do not like this, please disconnect now.
                   10850: 230-
1.18      snj      10851: 230-This archive is available via
1.1       dsieger  10852: 230-
                   10853: 230-HTTP:  http://ftp.plig.org/
                   10854: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10855: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10856: 230-
                   10857: 230-Please email comments, bug reports and requests for packages to be
                   10858: 230-mirrored to ftp-admin@plig.org.
                   10859: 230-
                   10860: 230-
                   10861: 230 Logged in anonymously.
                   10862: Remote system type is UNIX.
                   10863: Using binary mode to transfer files.
                   10864: 200 Type okay.
                   10865: 250 "/pub" is new cwd.
                   10866: 250-"/pub/figlet" is new cwd.
                   10867: 250-
                   10868: 250-Welcome to the figlet archive at ftp.figlet.org
                   10869: 250-
                   10870: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10871: 250-
                   10872: 250-The official FIGlet web page is:
                   10873: 250-   http://www.figlet.org/
                   10874: 250-
                   10875: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10876: 250-contribute a font or something else, you can email us.
                   10877: 250
                   10878: 250 "/pub/figlet/program" is new cwd.
                   10879: 250 "/pub/figlet/program/unix" is new cwd.
                   10880: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10881: 502 Unimplemented command.
                   10882: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10883: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10884: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10885: 226 Transfer completed.
                   10886: 172219 bytes received in 00:02 (75.99 KB/s)
                   10887: 221 Goodbye.
                   10888: =&gt; Checksum OK for figlet221.tar.gz.
                   10889: ===&gt; Extracting for figlet-2.2.1nb2
                   10890: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10891: ===&gt; Patching for figlet-2.2.1nb2
                   10892: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10893: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10894: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10895: ===&gt; Configuring for figlet-2.2.1nb2
                   10896: ===&gt; Building for figlet-2.2.1nb2
                   10897: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10898: chmod a+x figlet
                   10899: gcc -O2 -o chkfont chkfont.c
                   10900: =&gt; Unwrapping files-to-be-installed.
                   10901: <code class="prompt">#</code>
                   10902: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10903: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10904: ===&gt; Installing for figlet-2.2.1nb2
                   10905: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10906: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10907: mkdir -p /usr/pkg/share/figlet
                   10908: cp figlet /usr/pkg/bin
                   10909: cp chkfont /usr/pkg/bin
                   10910: chmod 555 figlist showfigfonts
                   10911: cp figlist /usr/pkg/bin
                   10912: cp showfigfonts /usr/pkg/bin
                   10913: cp fonts/*.flf /usr/pkg/share/figlet
                   10914: cp fonts/*.flc /usr/pkg/share/figlet
                   10915: cp figlet.6 /usr/pkg/man/man6
                   10916: ===&gt; Registering installation for figlet-2.2.1nb2
                   10917: <code class="prompt">#</code></pre>
                   10918: </div>
1.23      wiz      10919: <div class="sect1" title="B.2. Packaging figlet">
1.1       dsieger  10920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10921: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10922: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10923: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10924: ===&gt; Packaging figlet-2.2.1nb2
                   10925: ===&gt; Building binary package for figlet-2.2.1nb2
                   10926: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10927: Using SrcDir value of /usr/pkg
                   10928: Registering depends:.
                   10929: <code class="prompt">#</code></pre>
                   10930: </div>
                   10931: </div>
1.23      wiz      10932: <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
1.1       dsieger  10933: <div class="titlepage"><div><div><h2 class="title">
                   10934: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10935: <div class="toc">
                   10936: <p><b>Table of Contents</b></p>
                   10937: <dl>
1.23      wiz      10938: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10939: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10940: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10941: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10942: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10943: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10944: source packages</a></span></dt>
                   10945: </dl>
                   10946: </div>
                   10947: <p>As in other big projects, the directory layout of pkgsrc
                   10948:        is quite complex for newbies. This chapter explains where you
                   10949:        find things on the FTP server. The base directory on
1.10      hubertf  10950:        <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  10951:        On other servers it may be different, but inside this directory,
                   10952:        everything should look the same, no matter on which server you
                   10953:        are. This directory contains some subdirectories, which are
                   10954:        explained below.</p>
1.23      wiz      10955: <div class="sect1" title="C.1. distfiles: The distributed source files">
1.1       dsieger  10956: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10957: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10958: <p>The directory <code class="filename">distfiles</code> contains lots
                   10959:        of archive files from all pkgsrc packages, which are mirrored
                   10960:        here. The subdirectories are called after their package names
                   10961:        and are used when the distributed files have names that don't
                   10962:        explicitly contain a version number or are otherwise too generic
                   10963:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10964: </div>
1.23      wiz      10965: <div class="sect1" title="C.2. misc: Miscellaneous things">
1.1       dsieger  10966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10967: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10968: <p>This directory contains things that individual pkgsrc
                   10969:        developers find worth publishing.</p>
                   10970: </div>
1.23      wiz      10971: <div class="sect1" title="C.3. packages: Binary packages">
1.1       dsieger  10972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10973: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10974: <p>This directory contains binary packages for the various
                   10975:        platforms that are supported by pkgsrc.
                   10976:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.23      wiz      10977: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   10978: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10979:        operating system for which the packages have been built. The
1.10      hubertf  10980:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10981:        command, so it may differ from the one you are used to
                   10982:        hear.</p></li>
1.23      wiz      10983: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10984:        architecture of the platform for which the packages have been
1.10      hubertf  10985:        built. It also includes the <code class="varname">ABI</code> (Application
                   10986:        Binary Interface) for platforms that have several of
                   10987:        them.</p></li>
1.23      wiz      10988: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10989:        the operating system. For version numbers that change often (for
                   10990:        example NetBSD-current), the often-changing part should be
                   10991:        replaced with an <code class="literal">x</code>, for example
                   10992:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10993: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10994:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10995:        for a stable branch, or <code class="literal">head</code> for packages
                   10996:        built from the HEAD branch. The latter should only be used when
                   10997:        the packages are updated on a regular basis. Otherwise the date
                   10998:        from checking out pkgsrc should be appended, for example
                   10999:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   11000: </ul></div>
                   11001: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11002:        can quickly click through the directories on the
                   11003:        server and find the best binary packages for their machines. Since they
                   11004:        usually know the operating system and the hardware architecture, OPSYS
                   11005:        and ARCH are placed first. After these choices, they can select the
                   11006:        best combination of OSVERSION and TAG together, since it is usually the
                   11007:        case that packages stay compatible between different version of the
                   11008:        operating system.</p>
                   11009: <p>In each of these directories, there is a
                   11010:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  11011:        <code class="filename">All</code> which contains all binary packages.
                   11012:        Besides that, there are various category directories that
                   11013:        contain symbolic links to the real binary packages.</p>
                   11014: </div>
1.23      wiz      11015: <div class="sect1" title="C.4. reports: Bulk build reports">
1.1       dsieger  11016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11017: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   11018: <p>Here are the reports from bulk builds, for those who want
                   11019:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      11020:        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   11021: </div>
1.23      wiz      11022: <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
1.8       rillig   11023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11024: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   11025: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11026: source packages</h2></div></div></div>
1.23      wiz      11027: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11028:        that is the files that define how to create binary packages from
                   11029:        source archives.</p>
                   11030: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11031:        snapshot of the CVS repository, which is updated regularly. The
                   11032:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11033:        directory, ready to be downloaded as a whole.</p>
                   11034: <p>In the directories for the quarterly branches, there is an
                   11035:        additional file called
1.22      jakllsch 11036:        <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  11037:        which contains the state of pkgsrc when it was branched.</p>
                   11038: </div>
                   11039: </div>
1.23      wiz      11040: <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
1.1       dsieger  11041: <div class="titlepage"><div><div><h2 class="title">
                   11042: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11043: <div class="toc">
                   11044: <p><b>Table of Contents</b></p>
                   11045: <dl>
                   11046: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   11047: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11048: </dl>
                   11049: </div>
                   11050: <p>This section contains information on editing the pkgsrc
                   11051:        guide itself.</p>
1.23      wiz      11052: <div class="sect1" title="D.1. Make targets">
1.1       dsieger  11053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11054: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11055: <p>The pkgsrc guide's source code is stored in
                   11056:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11057:        are created from it:</p>
1.23      wiz      11058: <div class="itemizedlist"><ul class="itemizedlist" type="disc">
                   11059: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11060: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   11061: <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>
                   11062: <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  11063:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      11064: <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  11065:        PostScript version of the pkgsrc guide.</p></li>
                   11066: </ul></div>
                   11067: </div>
1.23      wiz      11068: <div class="sect1" title="D.2. Procedure">
1.1       dsieger  11069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11070: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   11071: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      11072: <div class="procedure"><ol class="procedure" type="1">
                   11073: <li class="step" title="Step 1"><p>Make sure you have the packages needed to
1.1       dsieger  11074:        regenerate the pkgsrc guide (and other XML-based NetBSD
                   11075:        documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
                   11076:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
                   11077:        PostScript and PDF versions. You will need both packages
                   11078:        installed, to make sure documentation is consistent across all
                   11079:        formats.</p></li>
1.23      wiz      11080: <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  11081:        right directory. All further steps will take place
                   11082:        here.</p></li>
1.23      wiz      11083: <li class="step" title="Step 3"><p>Edit the XML file(s) in
1.1       dsieger  11084:        <code class="filename">files/</code>.</p></li>
1.23      wiz      11085: <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  11086:        guide for valid XML and to build the final output files. If you
                   11087:        get any errors at this stage, you can just edit the files, as
                   11088:        there are only symbolic links in the working directory, pointing
                   11089:        to the files in <code class="filename">files/</code>.</p></li>
1.23      wiz      11090: <li class="step" title="Step 5"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  11091:        commit)</strong></span></p></li>
1.23      wiz      11092: <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  11093:        regenerate the output files with the proper RCS
                   11094:        Ids.</p></li>
1.23      wiz      11095: <li class="step" title="Step 7">
1.10      hubertf  11096: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  11097:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11098:        <code class="filename">htdocs</code>.</p>
1.23      wiz      11099: <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  11100: <h3 class="title">Note</h3>
                   11101: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  11102:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11103:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  11104:        directory.</p>
                   11105: </div>
                   11106: </li>
                   11107: </ol></div>
                   11108: </div>
                   11109: </div>
                   11110: </div></body>
                   11111: </html>

CVSweb <webmaster@jp.NetBSD.org>